Class ScriptSelector
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.selectors.BaseSelector
org.apache.tools.ant.types.optional.ScriptSelector
- All Implemented Interfaces:
- Cloneable,- ResourceSelector,- FileSelector
Selector that lets you run a script with selection logic inline
- Since:
- Ant1.7
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidThe script text.Classpath to be used when searching for classes and resources.get the base directorygetFile()get the file that is currently to be testedget the filename of the filebooleanget state of selected flagbooleanisSelected(File basedir, String filename, File file) Method that each selector will implement to create their selection behaviour.voidsetClasspath(Path classpath) Set the classpath to be used when searching for classes and resources.voidSet the classpath by reference.voidsetEncoding(String encoding) Set the encoding of the script from an external file; optional.voidsetLanguage(String language) Defines the language (required).voidsetManager(String manager) Deprecated.voidsetManager(ScriptManager manager) Set the script manager.voidsetProject(Project project) Set the project.voidsetSelected(boolean selected) set the selected state Intended for script use, not as an Ant attributevoidsetSetBeans(boolean setBeans) Set the setbeans attribute.voidLoad the script from an external file; optional.Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorgetError, setError, setError, validate, verifySettingsMethods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toStringMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocationMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.tools.ant.types.selectors.FileSelectorisSelected
- 
Constructor Details- 
ScriptSelectorpublic ScriptSelector()
 
- 
- 
Method Details- 
setProjectSet the project.- Overrides:
- setProjectin class- ProjectComponent
- Parameters:
- project- the owner of this component.
 
- 
setManagerDeprecated.Defines the manager.- Parameters:
- manager- the scripting manager.
 
- 
setManager
- 
setLanguageDefines the language (required).- Parameters:
- language- the scripting language name for the script.
 
- 
setSrcLoad the script from an external file; optional.- Parameters:
- file- the file containing the script source.
 
- 
addTextThe script text.- Parameters:
- text- a component of the script text to be added.
 
- 
setClasspathSet the classpath to be used when searching for classes and resources.- Parameters:
- classpath- an Ant Path object containing the search path.
 
- 
createClasspathClasspath to be used when searching for classes and resources.- Returns:
- an empty Path instance to be configured by Ant.
 
- 
setClasspathRefSet the classpath by reference.- Parameters:
- r- a Reference to a Path instance to be used as the classpath value.
 
- 
setSetBeanspublic 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.
 
- 
isSelectedMethod 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.- Specified by:
- isSelectedin interface- FileSelector
- Specified by:
- isSelectedin class- BaseSelector
- 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
 
- 
getBasedir
- 
getFilenameget the filename of the file- Returns:
- the filename of the file that is currently been tested
 
- 
getFileget the file that is currently to be tested- Returns:
- the file that is currently been tested
 
- 
isSelectedpublic boolean isSelected()get state of selected flag- Returns:
- the selected flag
 
- 
setSelectedpublic void setSelected(boolean selected) set the selected state Intended for script use, not as an Ant attribute- Parameters:
- selected- the selected state
 
- 
setEncodingSet 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
 
 
-