org.apache.tools.ant.types.selectors

Class SelectSelector

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

Constructor Summary
SelectSelector()
Default constructor.
Method Summary
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(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.
booleanpassesConditions()
Ensures that the selector passes the conditions placed on it with if and unless.
intselectorCount()
Gives the count of the number of selectors in this container
EnumerationselectorElements()
Returns an enumerator for accessing the set of selectors.
voidsetIf(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(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(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(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.
StringtoString()
voidverifySettings()
Makes sure that there is only one entry, sets an error message if not.

Constructor Detail

SelectSelector

public SelectSelector()
Default constructor.

Method Detail

appendSelector

public void appendSelector(FileSelector selector)
Add a new selector into this container.

Parameters: selector the new selector to add

getSelectors

public FileSelector[] getSelectors(Project p)
Returns the set of selectors as an array.

Parameters: p the current project

Returns: an array of selectors in this container

hasSelectors

public boolean hasSelectors()
Indicates whether there are any selectors here.

Returns: whether any selectors are in this container

isSelected

public 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. If there is no contained selector, return true (because we assume that the point was to test the if and unless conditions).

Parameters: basedir the base directory the scan is being done from filename the name of the file to check file a java.io.File object for the filename that the selector can use

Returns: whether the file should be selected or not

passesConditions

public boolean passesConditions()
Ensures that the selector passes the conditions placed on it with if and unless.

Returns: true if conditions are passed

selectorCount

public int selectorCount()
Gives the count of the number of selectors in this container

Returns: the number of selectors in this container

selectorElements

public Enumeration selectorElements()
Returns an enumerator for accessing the set of selectors.

Returns: an enumerator that goes through each of the selectors

setIf

public void setIf(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(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(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(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

toString

public String toString()

Returns: a string describing this object

verifySettings

public void verifySettings()
Makes sure that there is only one entry, sets an error message if not.