Class BaseExtendSelector

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

All Implemented Interfaces:

Cloneable, Parameterizable, ResourceSelector, ExtendFileSelector, FileSelector

Direct Known Subclasses:

ContainsRegexpSelector, ContainsSelector, DateSelector, DepthSelector, FilenameSelector, ModifiedSelector, SizeSelector, TypeSelector

public abstract class BaseExtendSelector
extends BaseSelector
implements ExtendFileSelector

Convenience base class for all selectors accessed through ExtendSelector. It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected.

Since:

1.5

Field Summary

Fields

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
BaseExtendSelector()

Method Summary

Modifier and Type	Method	Description
protected Parameter[]	getParameters()	Allows access to the parameters gathered and set within the <custom> tag.
abstract boolean	isSelected(File basedir, String filename, File file)	Method that each selector will implement to create their selection behaviour.
void	setParameters(Parameter... parameters)	Set all the Parameters for this custom selector, collected by the ExtendSelector class.

Methods inherited from class BaseSelector

getError, setError, setError, validate, verifySettings

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.
void	verifySettings()	Subclasses can override this method to provide checking of their state.

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, toString

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.
String	toString()	Basic DataType toString().

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

parameters

protected Parameter[] parameters

The passed in parameter array.

Constructor Details

BaseExtendSelector

public BaseExtendSelector()

Method Details

setParameters

public void setParameters(Parameter... parameters)

Set all the Parameters for this custom selector, collected by the ExtendSelector class.

Specified by:

setParameters in interface Parameterizable

Parameters:

parameters - the complete set of parameters for this selector

getParameters

protected Parameter[] getParameters()

Allows access to the parameters gathered and set within the <custom> tag.

Returns:

the set of parameters defined for this selector

isSelected

public abstract boolean isSelected(File basedir,
 String filename,
 File file)
                            throws BuildException

Method 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:

isSelected in interface FileSelector

Specified by:

isSelected in 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

Throws:

BuildException - if an error occurs