Class ScriptFilter
- java.lang.Object
-
- org.apache.tools.ant.ProjectComponent
-
- org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
-
- org.apache.tools.ant.types.optional.ScriptFilter
-
- All Implemented Interfaces:
java.lang.Cloneable,ChainableReader,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
-
-
Constructor Summary
Constructors Constructor Description ScriptFilter()
-
Method Summary
Modifier and Type Method Description voidaddText(java.lang.String text)The script text.PathcreateClasspath()Classpath to be used when searching for classes and resources.java.lang.Stringfilter(java.lang.String token)Called filter the token.java.lang.StringgetToken()The current tokenvoidsetClasspath(Path classpath)Set the classpath to be used when searching for classes and resources.voidsetClasspathRef(Reference r)Set the classpath by reference.voidsetEncoding(java.lang.String encoding)Set the encoding of the script from an external file; optional.voidsetLanguage(java.lang.String language)Defines the language (required).voidsetManager(java.lang.String manager)Defines the manager.voidsetProject(Project project)Set the project.voidsetSetBeans(boolean setBeans)Set the setbeans attribute.voidsetSrc(java.io.File file)Load the script from an external file; optional.voidsetToken(java.lang.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
-
-
-
-
Method Detail
-
setProject
public void setProject(Project project)
Set the project.- Overrides:
setProjectin classProjectComponent- Parameters:
project- the owner of this component.
-
setLanguage
public void setLanguage(java.lang.String language)
Defines the language (required).- Parameters:
language- the scripting language name for the script.
-
setToken
public void setToken(java.lang.String token)
The current token- Parameters:
token- the string filtered by the script
-
getToken
public java.lang.String getToken()
The current token- Returns:
- the string filtered by the script
-
filter
public java.lang.String filter(java.lang.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
-
setSrc
public void setSrc(java.io.File file)
Load the script from an external file; optional.- Parameters:
file- the file containing the script source.
-
addText
public void addText(java.lang.String text)
The script text.- Parameters:
text- a component of the script text to be added.
-
setManager
public void setManager(java.lang.String manager)
Defines the manager.- Parameters:
manager- the scripting manager.
-
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.
-
createClasspath
public Path createClasspath()
Classpath to be used when searching for classes and resources.- Returns:
- an empty Path instance to be configured by Ant.
-
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.
-
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
-
setEncoding
public void setEncoding(java.lang.String encoding)
Set the encoding of the script from an external file; optional.- Parameters:
encoding- the encoding of the file containing the script source.- Since:
- Ant 1.10.2
-
-