Class FilenameSelector

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.BaseExtendSelector

org.apache.tools.ant.types.selectors.FilenameSelector

All Implemented Interfaces:

Cloneable, Parameterizable, ResourceSelector, ExtendFileSelector, FileSelector

public class FilenameSelector
extends BaseExtendSelector

Selector that filters files based on the filename.

Since:

1.5

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CASE_KEY	Used for parameterized custom selector
static final String	NAME_KEY	Used for parameterized custom selector
static final String	NEGATE_KEY	Used for parameterized custom selector
static final String	REGEX_KEY	Used for parameterized custom selector

Fields inherited from class BaseExtendSelector

parameters

Modifier and Type	Field	Description
protected Parameter[]	parameters	The passed in parameter array.

Fields inherited from class DataType

checked, ref

Modifier and Type	Field	Description
protected boolean	checked	Deprecated. since 1.7.
protected Reference	ref	Deprecated. since 1.7.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
FilenameSelector()

Method Summary

Modifier and Type	Method	Description
boolean	isSelected(File basedir, String filename, File file)	The heart of the matter.
void	setCasesensitive(boolean casesensitive)	Whether to ignore case when checking filenames.
void	setName(String pattern)	The name of the file, or the pattern for the name, that should be used for selection.
void	setNegate(boolean negated)	You can optionally reverse the selection of this selector, thereby emulating an <exclude> tag, by setting the attribute negate to true.
void	setParameters(Parameter... parameters)	When using this as a custom selector, this method will be called.
void	setRegex(String pattern)	The regular expression the file name will be matched against.
String	toString()	Basic DataType toString().
void	verifySettings()	Checks to make sure all settings are kosher.

Methods inherited from class BaseExtendSelector

getParameters

Modifier and Type	Method	Description
protected Parameter[]	getParameters()	Allows access to the parameters gathered and set within the <custom> tag.

Methods inherited from class BaseSelector

getError, setError, setError, validate

Modifier and Type	Method	Description
String	getError()	Returns any error messages that have been set.
void	setError(String msg)	Allows all selectors to indicate a setup error.
void	setError(String msg, Throwable cause)	Allows all selectors to indicate a setup error.
void	validate()	Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.

Methods inherited from class DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes

Modifier and Type	Method	Description
protected void	checkAttributesAllowed()	check that it is ok to set attributes, i.e that no reference is defined
protected void	checkChildrenAllowed()	check that it is ok to add children, i.e that no reference is defined
protected BuildException	circularReference()	Creates an exception that indicates the user has generated a loop of data types referencing each other.
Object	clone()
protected void	dieOnCircularReference()	Convenience method.
protected void	dieOnCircularReference(Stack<Object> stack, Project project)	Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).
protected void	dieOnCircularReference(Project p)	Convenience method.
protected <T> T	getCheckedRef()	Deprecated. use getCheckedRef(Class)
protected <T> T	getCheckedRef(Class<T> requiredClass)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName, Project project)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Project p)	Deprecated. use getCheckedRef(Class)
protected String	getDataTypeName()	Gets as descriptive as possible a name used for this datatype instance.
Reference	getRefid()	get the reference set on this object
static void	invokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected boolean	isChecked()	The flag that is used to indicate that circular references have been checked.
boolean	isReference()	Has the refid attribute of this element been set?
protected BuildException	noChildrenAllowed()	Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
static void	pushAndInvokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected void	setChecked(boolean checked)	Set the flag that is used to indicate that circular references have been checked.
void	setRefid(Reference ref)	Set the value of the refid attribute.
protected BuildException	tooManyAttributes()	Creates an exception that indicates that refid has to be the only attribute if it is set.

Methods inherited from class ProjectComponent

getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface FileSelector

isSelected

Modifier and Type	Method	Description
default boolean	isSelected(Resource r)	Implement a basic Resource selection that delegates to this FileSelector.

Field Details

NAME_KEY

public static final String NAME_KEY

Used for parameterized custom selector

See Also:

• Constant Field Values

CASE_KEY

public static final String CASE_KEY

Used for parameterized custom selector

See Also:

• Constant Field Values

NEGATE_KEY

public static final String NEGATE_KEY

Used for parameterized custom selector

See Also:

• Constant Field Values

REGEX_KEY

public static final String REGEX_KEY

Used for parameterized custom selector

See Also:

• Constant Field Values

Constructor Details

FilenameSelector

public FilenameSelector()

Method Details

toString

public String toString()

Description copied from class: DataType

Basic DataType toString().

Overrides:

toString in class DataType

Returns:

a string describing this object

setName

public void setName(String pattern)

The name of the file, or the pattern for the name, that should be used for selection.

Parameters:

pattern - the file pattern that any filename must match against in order to be selected.

setRegex

public void setRegex(String pattern)

The regular expression the file name will be matched against.

Parameters:

pattern - the regular expression that any filename must match against in order to be selected.

setCasesensitive

public void setCasesensitive(boolean casesensitive)

Whether to ignore case when checking filenames.

Parameters:

casesensitive - whether to pay attention to case sensitivity

setNegate

public void setNegate(boolean negated)

You can optionally reverse the selection of this selector, thereby emulating an <exclude> tag, by setting the attribute negate to true. This is identical to surrounding the selector with <not></not>.

Parameters:

negated - whether to negate this selection

setParameters

public void setParameters(Parameter... parameters)

When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class BaseExtendSelector

Parameters:

parameters - the complete set of parameters for this selector

verifySettings

public void verifySettings()

Checks to make sure all settings are kosher. In this case, it means that the name attribute has been set.

Overrides:

verifySettings in class BaseSelector

isSelected

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

The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset. Most of the work for this selector is offloaded into SelectorUtils, a static class that provides the same services for both FilenameSelector and DirectoryScanner.

Specified by:

isSelected in interface FileSelector

Specified by:

isSelected in class BaseExtendSelector

Parameters:

basedir - the base directory the scan is being done from

filename - is the name of the file to check

file - is a java.io.File object the selector can use

Returns:

whether the file should be selected or not