org.apache.tools.ant.types.optional

Class ScriptSelector

public class ScriptSelector extends BaseSelector

Selector that lets you run a script with selection logic inline

Since: Ant1.7

Method Summary
voidaddText(String text)
The script text.
PathcreateClasspath()
Classpath to be used when searching for classes and resources.
FilegetBasedir()
get the base directory
FilegetFile()
get the file that is currently to be tested
StringgetFilename()
get the filename of the file
booleanisSelected(File basedir, String filename, File file)
Method that each selector will implement to create their selection behaviour.
booleanisSelected()
get state of selected flag
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.
voidsetSelected(boolean selected)
set the selected state Intended for script use, not as an Ant attribute
voidsetSetBeans(boolean setBeans)
Set the setbeans attribute.
voidsetSrc(File file)
Load the script from an external file ; optional.

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.

getBasedir

public File getBasedir()
get the base directory

Returns: the base directory

getFile

public File getFile()
get the file that is currently to be tested

Returns: the file that is currently been tested

getFilename

public String getFilename()
get the filename of the file

Returns: the filename of the file that is currently been tested

isSelected

public boolean isSelected(File basedir, String filename, File file)
Method that each selector will implement to create their selection behaviour. If there is a problem with the setup of a selector, it can throw a BuildException to indicate the problem.

Parameters: basedir A java.io.File object for the base directory filename The name of the file to check file A File object for this filename

Returns: whether the file should be selected or not

isSelected

public boolean isSelected()
get state of selected flag

Returns: the selected flag

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.

setSelected

public void setSelected(boolean selected)
set the selected state Intended for script use, not as an Ant attribute

Parameters: selected the selected state

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.

setSrc

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

Parameters: file the file containing the script source.