org.apache.tools.ant.types.optional

Class ScriptFilter

public class ScriptFilter extends TokenFilter.ChainableReaderFilter

Most of this is CAP (Cut And Paste) from the Script task ScriptFilter class, implements TokenFilter.Filter for scripts to use. This provides the same beans as the Script Task to a script. The script is meant to use get self.token and set self.token in the reply.

Since: Ant 1.6

Method Summary
voidaddText(String text)
The script text.
PathcreateClasspath()
Classpath to be used when searching for classes and resources.
Stringfilter(String token)
Called filter the token.
StringgetToken()
The current token
voidsetClasspath(Path classpath)
Set the classpath to be used when searching for classes and resources.
voidsetClasspathRef(Reference r)
Set the classpath by reference.
voidsetLanguage(String language)
Defines the language (required).
voidsetManager(String manager)
Defines the manager.
voidsetProject(Project project)
Set the project.
voidsetSetBeans(boolean setBeans)
Set the setbeans attribute.
voidsetSrc(File file)
Load the script from an external file ; optional.
voidsetToken(String token)
The current token

Method Detail

addText

public void addText(String text)
The script text.

Parameters: text a component of the script text to be added.

createClasspath

public Path createClasspath()
Classpath to be used when searching for classes and resources.

Returns: an empty Path instance to be configured by Ant.

filter

public String filter(String token)
Called filter the token. This sets the token in this object, calls the script and returns the token.

Parameters: token the token to be filtered

Returns: the filtered token

getToken

public String getToken()
The current token

Returns: the string filtered by the script

setClasspath

public void setClasspath(Path classpath)
Set the classpath to be used when searching for classes and resources.

Parameters: classpath an Ant Path object containing the search path.

setClasspathRef

public void setClasspathRef(Reference r)
Set the classpath by reference.

Parameters: r a Reference to a Path instance to be used as the classpath value.

setLanguage

public void setLanguage(String language)
Defines the language (required).

Parameters: language the scripting language name for the script.

setManager

public void setManager(String manager)
Defines the manager.

Parameters: manager the scripting manager.

setProject

public void setProject(Project project)
Set the project.

Parameters: project the owner of this component.

setSetBeans

public void setSetBeans(boolean setBeans)
Set the setbeans attribute. If this is true, <script> will create variables in the script instance for all properties, targets and references of the current project. It this is false, only the project and self variables will be set. The default is true.

Parameters: setBeans the value to set.

Since: Ant 1.8.0

setSrc

public void setSrc(File file)
Load the script from an external file ; optional.

Parameters: file the file containing the script source.

setToken

public void setToken(String token)
The current token

Parameters: token the string filtered by the script