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:
Cloneable
,ResourceSelector
,FileSelector
,SelectorContainer
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
appendSelector
(FileSelector selector) Add a new selector into this container.Returns the set of selectors as an array.boolean
Indicates whether there are any selectors here.boolean
isSelected
(File basedir, String filename, 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.boolean
Ensures that the selector passes the conditions placed on it withif
andunless
.int
Gives the count of the number of selectors in this containerReturns an enumerator for accessing the set of selectors.void
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.void
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.void
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.void
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.toString()
Convert the Selectors within this container to a string.void
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
-
Constructor Details
-
SelectSelector
public SelectSelector()
-
-
Method Details
-
toString
Description copied from class:BaseSelectorContainer
Convert 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:
toString
in classBaseSelectorContainer
- Returns:
- a string describing this object
-
hasSelectors
public boolean hasSelectors()Indicates whether there are any selectors here.- Specified by:
hasSelectors
in interfaceSelectorContainer
- Overrides:
hasSelectors
in 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:
selectorCount
in interfaceSelectorContainer
- Overrides:
selectorCount
in classBaseSelectorContainer
- Returns:
- the number of selectors in this container
-
getSelectors
Returns the set of selectors as an array.- Specified by:
getSelectors
in interfaceSelectorContainer
- Overrides:
getSelectors
in classBaseSelectorContainer
- Parameters:
p
- the current project- Returns:
- an array of selectors in this container
-
selectorElements
Returns an enumerator for accessing the set of selectors.- Specified by:
selectorElements
in interfaceSelectorContainer
- Overrides:
selectorElements
in classBaseSelectorContainer
- Returns:
- an enumerator that goes through each of the selectors
-
appendSelector
Add a new selector into this container.- Specified by:
appendSelector
in interfaceSelectorContainer
- Overrides:
appendSelector
in 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:
verifySettings
in classBaseSelector
-
passesConditions
public boolean passesConditions()Ensures that the selector passes the conditions placed on it withif
andunless
.- Returns:
- true if conditions are passed
-
setIf
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
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
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
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
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:
isSelected
in interfaceFileSelector
- Specified by:
isSelected
in 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
-