Class SelectSelector
- 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.selectors.BaseSelectorContainer
-
- org.apache.tools.ant.types.selectors.SelectSelector
-
- All Implemented Interfaces:
java.lang.Cloneable,ResourceSelector,FileSelector,SelectorContainer
public class SelectSelector extends BaseSelectorContainer
This selector just holds one other selector and forwards all requests to it. It exists so that there is a single selector type that can exist outside of any targets, as an element of project. It overrides all of the reference stuff so that it works as expected. Note that this is the only selector you can reference.- Since:
- 1.5
-
-
Field Summary
-
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
-
Constructor Summary
Constructors Constructor Description SelectSelector()
-
Method Summary
Modifier and Type Method Description voidappendSelector(FileSelector selector)Add a new selector into this container.FileSelector[]getSelectors(Project p)Returns the set of selectors as an array.booleanhasSelectors()Indicates whether there are any selectors here.booleanisSelected(java.io.File basedir, java.lang.String filename, java.io.File file)Returns true (the file is selected) only if the if property (if any) exists, the unless property (if any) doesn't exist, and the contained selector (if any) selects the file.booleanpassesConditions()Ensures that the selector passes the conditions placed on it withifandunless.intselectorCount()Gives the count of the number of selectors in this containerjava.util.Enumeration<FileSelector>selectorElements()Returns an enumerator for accessing the set of selectors.voidsetIf(java.lang.Object ifProperty)Sets the if attribute to an expression which must evaluate to true or the name of an existing property for the selector to select any files.voidsetIf(java.lang.String ifProperty)Sets the if attribute to an expression which must evaluate to true or the name of an existing property for the selector to select any files.voidsetUnless(java.lang.Object unlessProperty)Sets the unless attribute to an expression which must evaluate to false or the name of a property which cannot exist for the selector to select any files.voidsetUnless(java.lang.String unlessProperty)Sets the unless attribute to an expression which must evaluate to false or the name of a property which cannot exist for the selector to select any files.java.lang.StringtoString()Convert the Selectors within this container to a string.voidverifySettings()Makes sure that there is only one entry, sets an error message if not.-
Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorContainer
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addExecutable, addFilename, addMajority, addModified, addNone, addNot, addOr, addOwnedBy, addPosixGroup, addPosixPermissions, addPresent, addReadable, addSelector, addSize, addSymlink, addType, addWritable, dieOnCircularReference, validate
-
Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
getError, setError, setError
-
Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
-
Methods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.tools.ant.types.selectors.FileSelector
isSelected
-
-
-
-
Method Detail
-
toString
public java.lang.String toString()
Description copied from class:BaseSelectorContainerConvert the Selectors within this container to a string. This will just be a helper class for the subclasses that put their own name around the contents listed here.- Overrides:
toStringin classBaseSelectorContainer- Returns:
- a string describing this object
-
hasSelectors
public boolean hasSelectors()
Indicates whether there are any selectors here.- Specified by:
hasSelectorsin interfaceSelectorContainer- Overrides:
hasSelectorsin classBaseSelectorContainer- Returns:
- whether any selectors are in this container
-
selectorCount
public int selectorCount()
Gives the count of the number of selectors in this container- Specified by:
selectorCountin interfaceSelectorContainer- Overrides:
selectorCountin classBaseSelectorContainer- Returns:
- the number of selectors in this container
-
getSelectors
public FileSelector[] getSelectors(Project p)
Returns the set of selectors as an array.- Specified by:
getSelectorsin interfaceSelectorContainer- Overrides:
getSelectorsin classBaseSelectorContainer- Parameters:
p- the current project- Returns:
- an array of selectors in this container
-
selectorElements
public java.util.Enumeration<FileSelector> selectorElements()
Returns an enumerator for accessing the set of selectors.- Specified by:
selectorElementsin interfaceSelectorContainer- Overrides:
selectorElementsin classBaseSelectorContainer- Returns:
- an enumerator that goes through each of the selectors
-
appendSelector
public void appendSelector(FileSelector selector)
Add a new selector into this container.- Specified by:
appendSelectorin interfaceSelectorContainer- Overrides:
appendSelectorin classBaseSelectorContainer- Parameters:
selector- the new selector to add
-
verifySettings
public void verifySettings()
Makes sure that there is only one entry, sets an error message if not.- Overrides:
verifySettingsin classBaseSelector
-
passesConditions
public boolean passesConditions()
Ensures that the selector passes the conditions placed on it withifandunless.- Returns:
- true if conditions are passed
-
setIf
public void setIf(java.lang.Object ifProperty)
Sets the if attribute to an expression which must evaluate to true or the name of an existing property for the selector to select any files.- Parameters:
ifProperty- the expression to check- Since:
- Ant 1.8.0
-
setIf
public void setIf(java.lang.String ifProperty)
Sets the if attribute to an expression which must evaluate to true or the name of an existing property for the selector to select any files.- Parameters:
ifProperty- the expression to check
-
setUnless
public void setUnless(java.lang.Object unlessProperty)
Sets the unless attribute to an expression which must evaluate to false or the name of a property which cannot exist for the selector to select any files.- Parameters:
unlessProperty- the expression to check- Since:
- Ant 1.8.0
-
setUnless
public void setUnless(java.lang.String unlessProperty)
Sets the unless attribute to an expression which must evaluate to false or the name of a property which cannot exist for the selector to select any files.- Parameters:
unlessProperty- the expression to check
-
isSelected
public boolean isSelected(java.io.File basedir, java.lang.String filename, java.io.File file)Returns true (the file is selected) only if the if property (if any) exists, the unless property (if any) doesn't exist, and the contained selector (if any) selects the file. If there is no contained selector, return true (because we assume that the point was to test the if and unless conditions).- Specified by:
isSelectedin interfaceFileSelector- Specified by:
isSelectedin classBaseSelectorContainer- Parameters:
basedir- the base directory the scan is being done fromfilename- the name of the file to checkfile- a java.io.File object for the filename that the selector can use- Returns:
- whether the file should be selected or not
-
-