org.apache.tools.ant.types.optional

Class ScriptFilter

Implemented Interfaces:
ChainableReader, Cloneable, TokenFilter.Filter

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

Field Summary

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Method Summary

void
addText(String text)
The script text.
Path
createClasspath()
Classpath to be used when searching for classes and resources.
String
filter(String token)
Called filter the token.
String
getToken()
The current token
void
setClasspath(Path classpath)
Set the classpath to be used when searching for classes and resources.
void
setClasspathRef(Reference r)
Set the classpath by reference.
void
setLanguage(String language)
Defines the language (required).
void
setManager(String manager)
Defines the manager.
void
setProject(Project project)
Set the project.
void
setSrc(File file)
Load the script from an external file ; optional.
void
setToken(String token)
The current token

Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter

chain, setByLine

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Method Details

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.
Specified by:
filter in interface TokenFilter.Filter
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.
Overrides:
setProject in interface ProjectComponent
Parameters:
project - the owner of this component.

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