Class ResourceSelectorContainer

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.types.DataType

org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

And, Majority, None, Or, Restrict

public class ResourceSelectorContainer
extends DataType

ResourceSelector container.

Since:

Ant 1.7

Field Summary

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
ResourceSelectorContainer()	Default constructor.
ResourceSelectorContainer(ResourceSelector... resourceSelectors)	Construct a new ResourceSelectorContainer with the specified array of selectors.

Method Summary

Modifier and Type	Method	Description
void	add(ResourceSelector s)	Add a ResourceSelector to the container.
protected void	dieOnCircularReference(Stack<Object> stk, Project p)	Overrides the version from DataType to recurse on nested ResourceSelectors.
List<ResourceSelector>	getResourceSelectors()	Get the configured ResourceSelectors as a List.
Iterator<ResourceSelector>	getSelectors()	Return an Iterator over the nested selectors.
boolean	hasSelectors()	Learn whether this ResourceSelectorContainer has selectors.
int	selectorCount()	Get the count of nested selectors.

Methods inherited from class DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, 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(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

Constructor Details

ResourceSelectorContainer

public ResourceSelectorContainer()

Default constructor.

ResourceSelectorContainer

public ResourceSelectorContainer(ResourceSelector... resourceSelectors)

Construct a new ResourceSelectorContainer with the specified array of selectors.

Parameters:

resourceSelectors - the ResourceSelector[] to add.

Method Details

add

public void add(ResourceSelector s)

Add a ResourceSelector to the container.

Parameters:

s - the ResourceSelector to add.

hasSelectors

public boolean hasSelectors()

Learn whether this ResourceSelectorContainer has selectors.

Returns:

boolean indicating whether selectors have been added to the container.

selectorCount

public int selectorCount()

Get the count of nested selectors.

Returns:

the selector count as int.

getSelectors

public Iterator<ResourceSelector> getSelectors()

Return an Iterator over the nested selectors.

Returns:

Iterator of ResourceSelectors.

getResourceSelectors

public List<ResourceSelector> getResourceSelectors()

Get the configured ResourceSelectors as a List.

Returns:

List of ResourceSelector

dieOnCircularReference

protected void dieOnCircularReference(Stack<Object> stk,
 Project p)
                               throws BuildException

Overrides the version from DataType to recurse on nested ResourceSelectors.

Overrides:

dieOnCircularReference in class DataType

Parameters:

stk - the Stack of references.

p - the Project to resolve against.

Throws:

BuildException - on error.