com.partnersoft.scripting

Class StringTemplateScript

java.lang.Object

com.partnersoft.scripting.AbstractScript

com.partnersoft.scripting.StringTemplateScript

All Implemented Interfaces:

Script, java.lang.Runnable

public class StringTemplateScript
extends AbstractScript

A script that uses the Terence Parr's StringTemplate library from http://www.stringtemplate.org/.

These are not general purpose scripts, but instead return Strings generated by applying the variables to the template.

Copyright 2007 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
StringTemplateScript(VfsFile file) Creates a new StringTemplate script from the given file.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	reloadImp() Subclasses should implement this method to do any maintenance associated with changes in the source file.
protected java.lang.Object	runScriptImp(Naming<java.lang.Object> variables) Subclasses should implement this method with their actual script-running implementation.

Methods inherited from class com.partnersoft.scripting.AbstractScript

getFile, getName, getScriptLog, getThrown, getVariable, getVariables, isModified, parse, run, runScript, runThreaded, setThrown, setVariable, setVariables, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StringTemplateScript

public StringTemplateScript(VfsFile file)

Creates a new StringTemplate script from the given file.

Method Detail

reloadImp

protected void reloadImp()
                  throws java.lang.Exception

Description copied from class: AbstractScript

Subclasses should implement this method to do any maintenance associated with changes in the source file. This method is called whenever the source file's modification timestamp changes. Use it to load, parse, compile, or whatever you do with the scripting language in question to get it ready to execute. Feel free to throw exceptions; these will be caught and handled appropriately (logging the error, providing the Throwable in getThrown(), etc.).

Specified by:

reloadImp in class AbstractScript

Throws:

java.lang.Exception

runScriptImp

protected java.lang.Object runScriptImp(Naming<java.lang.Object> variables)
                                 throws java.lang.Exception

Description copied from class: AbstractScript

Subclasses should implement this method with their actual script-running implementation. They should feel free to throw exceptions; these will be caught and handled appropriately (logging the error, providing the Throwable in getThrown(), etc.).

Specified by:

runScriptImp in class AbstractScript

Throws:

java.lang.Exception