Apache Ant 1.10.14 · org.apache.tools.ant.types.optional.ScriptSelector

Modifier and Type	Field and Description
private File	basedir fields updated for every selection
private File	file
private String	filename
private ScriptRunnerHelper	helper script runner helper
private ScriptRunnerBase	runner script runner
private boolean	selected selected flag

Access	Constructor and Description
public	ScriptSelector()

Method Summary

Modifier and Type	Method and Description
public void	addText(String a component of the script text to be added. text) The script text.
public Path	Returns: an empty Path instance to be configured by Ant. createClasspath() Classpath to be used when searching for classes and resources.
public File	Returns: the base directory getBasedir() get the base directory
public File	Returns: the file that is currently been tested getFile() get the file that is currently to be tested
public String	Returns: the filename of the file that is currently been tested getFilename() get the filename of the file
private void	init() Initialize on demand.
public boolean	Returns: whether the file should be selected or not isSelected(File A java.io.File object for the base directory basedir, String The name of the file to check filename, File A File object for this filename file) Implements abstract org.apache.tools.ant.types.selectors.BaseSelector.isSelected. Implements org.apache.tools.ant.types.selectors.FileSelector.isSelected. Method that each selector will implement to create their selection behaviour.
public boolean	Returns: the selected flag isSelected() get state of selected flag
public void	setClasspath(Path an Ant Path object containing the search path. classpath) Set the classpath to be used when searching for classes and resources.
public void	setClasspathRef(Reference a Reference to a Path instance to be used as the classpath value. r) Set the classpath by reference.
public void	setEncoding(String the encoding of the file containing the script source. encoding) Set the encoding of the script from an external file; optional.
public void	setLanguage(String the scripting language name for the script. language) Defines the language (required).
public void	setManager(String the scripting manager. manager) Deprecated Defines the manager.
public void	setManager(ScriptManager manager) Set the script manager.
public void	setProject(Project the owner of this component. project) Overrides org.apache.tools.ant.ProjectComponent.setProject. Set the project.
public void	setSelected(boolean the selected state selected) set the selected state Intended for script use, not as an Ant attribute
public void	setSetBeans(boolean the value to set. setBeans) Set the setbeans attribute.
public void	setSrc(File the file containing the script source. file) Load the script from an external file; optional.

Inherited from org.apache.tools.ant.types.selectors.BaseSelector:: getError setError setError validate verifySettings

basedir	back to summary
private File basedir fields updated for every selection

file	back to summary
private File file

filename	back to summary
private String filename

helper	back to summary
private ScriptRunnerHelper helper script runner helper

runner	back to summary
private ScriptRunnerBase runner script runner

selected	back to summary
private boolean selected selected flag

ScriptSelector	back to summary
public ScriptSelector()

Method Detail

addText	back to summary
public void addText(String text) The script text. Parameters text:String a component of the script text to be added.

addText

back to summary

public void addText(String text)

The script text.

Parameters

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

createClasspath	back to summary
public Path createClasspath() Classpath to be used when searching for classes and resources. Returns:Path an empty Path instance to be configured by Ant.

createClasspath

back to summary

public Path createClasspath()

Classpath to be used when searching for classes and resources.

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

getBasedir	back to summary
public File getBasedir() get the base directory Returns:File the base directory

getBasedir

back to summary

public File getBasedir()

get the base directory

Returns:File: the base directory

getFile	back to summary
public File getFile() get the file that is currently to be tested Returns:File the file that is currently been tested

getFile

back to summary

public File getFile()

get the file that is currently to be tested

Returns:File: the file that is currently been tested

getFilename	back to summary
public String getFilename() get the filename of the file Returns:String the filename of the file that is currently been tested

getFilename

back to summary

public String getFilename()

get the filename of the file

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

init	back to summary
private void init() throws BuildException Initialize on demand. Exceptions BuildException: if something goes wrong

init

back to summary

private void init() throws BuildException

Initialize on demand.

Exceptions

BuildException:: if something goes wrong

isSelected	back to summary
public boolean isSelected(File basedir, String filename, File file) Implements abstract org.apache.tools.ant.types.selectors.BaseSelector.isSelected. Implements org.apache.tools.ant.types.selectors.FileSelector.isSelected. 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:File A java.io.File object for the base directory filename:String The name of the file to check file:File A File object for this filename Returns:boolean whether the file should be selected or not Annotations @Override

isSelected

back to summary

public boolean isSelected(File basedir, String filename, File file)

Implements abstract org.apache.tools.ant.types.selectors.BaseSelector.isSelected.

Implements org.apache.tools.ant.types.selectors.FileSelector.isSelected.

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:File: A java.io.File object for the base directory
filename:String: The name of the file to check
file:File: A File object for this filename

Returns:boolean

whether the file should be selected or not

Annotations

@Override

isSelected	back to summary
public boolean isSelected() get state of selected flag Returns:boolean the selected flag

isSelected

back to summary

public boolean isSelected()

get state of selected flag

Returns:boolean: the selected flag

setClasspath	back to summary
public void setClasspath(Path classpath) Set the classpath to be used when searching for classes and resources. Parameters classpath:Path an Ant Path object containing the search path.

setClasspath

back to summary

public void setClasspath(Path classpath)

Set the classpath to be used when searching for classes and resources.

Parameters

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

setClasspathRef	back to summary
public void setClasspathRef(Reference r) Set the classpath by reference. Parameters r:Reference a Reference to a Path instance to be used as the classpath value.

setClasspathRef

back to summary

public void setClasspathRef(Reference r)

Set the classpath by reference.

Parameters

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

setEncoding	back to summary
public void setEncoding(String encoding) Set the encoding of the script from an external file; optional. Parameters encoding:String the encoding of the file containing the script source. Since Ant 1.10.2

setEncoding

back to summary

public void setEncoding(String encoding)

Set the encoding of the script from an external file; optional.

Parameters

encoding:String: the encoding of the file containing the script source.

Since

Ant 1.10.2

setLanguage	back to summary
public void setLanguage(String language) Defines the language (required). Parameters language:String the scripting language name for the script.

setLanguage

back to summary

public void setLanguage(String language)

Defines the language (required).

Parameters

language:String: the scripting language name for the script.

setManager	back to summary
public void setManager(String manager) Deprecated Defines the manager. Parameters manager:String the scripting manager. Annotations @Deprecated

setManager

back to summary

public void setManager(String manager)

Deprecated

Defines the manager.

Parameters

manager:String: the scripting manager.

Annotations

@Deprecated

setManager	back to summary
public void setManager(ScriptManager manager) Set the script manager.

setProject	back to summary
public void setProject(Project project) Overrides org.apache.tools.ant.ProjectComponent.setProject. Set the project. Parameters project:Project the owner of this component. Annotations @Override

setProject

back to summary

public void setProject(Project project)

Overrides org.apache.tools.ant.ProjectComponent.setProject.

Set the project.

Parameters

project:Project: the owner of this component.

Annotations

@Override

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

setSelected

back to summary

public void setSelected(boolean selected)

set the selected state Intended for script use, not as an Ant attribute

Parameters

selected:boolean: the selected state

setSetBeans	back to summary
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:boolean the value to set.

setSetBeans

back to summary

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:boolean: the value to set.

setSrc	back to summary
public void setSrc(File file) Load the script from an external file; optional. Parameters file:File the file containing the script source.

setSrc

back to summary

public void setSrc(File file)

Load the script from an external file; optional.

Parameters

file:File: the file containing the script source.

public Class ScriptSelector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail