Class Tokens

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.types.DataType

org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper

org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper

org.apache.tools.ant.types.resources.Tokens

All Implemented Interfaces:

Cloneable, Iterable<Resource>, ResourceCollection

public class Tokens
extends BaseResourceCollectionWrapper

ResourceCollection consisting of StringResources gathered from tokenizing another ResourceCollection with a Tokenizer implementation.

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

Method Summary

Modifier and Type	Method	Description
void	add(Tokenizer tokenizer)	Add the nested Tokenizer to this Tokens ResourceCollection.
protected void	dieOnCircularReference(Stack<Object> stk, Project p)	Overrides the BaseResourceCollectionContainer version to check the nested Tokenizer.
protected Collection<Resource>	getCollection()	Sort the contained elements.
void	setEncoding(String encoding)	Set the encoding used to create the tokens.

Methods inherited from class BaseResourceCollectionWrapper

createIterator, getSize

Modifier and Type	Method	Description
protected Iterator<Resource>	createIterator()	Do create an iterator on the resource collection.
protected int	getSize()	Do compute the size of the resource collection.

Methods inherited from class AbstractResourceCollectionWrapper

add, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, size, toString

Modifier and Type	Method	Description
void	add(ResourceCollection c)	Add a ResourceCollection to the container.
protected final ResourceCollection	getResourceCollection()	Get the nested ResourceCollection.
boolean	isCache()	Learn whether to cache collections.
boolean	isFilesystemOnly()	Fulfill the ResourceCollection contract.
final Iterator<Resource>	iterator()	Fulfill the ResourceCollection contract.
void	setCache(boolean b)	Set whether to cache collections.
int	size()	Fulfill the ResourceCollection contract.
String	toString()	Format this AbstractResourceCollectionWrapper as a String.

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

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.

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 Iterable

forEach, spliterator

Methods inherited from interface ResourceCollection

isEmpty, stream

Modifier and Type	Method	Description
default boolean	isEmpty()	Learn whether this ResourceCollection is empty.
default Stream<? extends Resource>	stream()	Return a Stream over this ResourceCollection.

Constructor Details

Tokens

public Tokens()

Method Details

getCollection

protected Collection<Resource> getCollection()

Sort the contained elements.

Specified by:

getCollection in class BaseResourceCollectionWrapper

Returns:

a Collection of Resources.

setEncoding

public void setEncoding(String encoding)

Set the encoding used to create the tokens.

Parameters:

encoding - the encoding to use.

add

public void add(Tokenizer tokenizer)

Add the nested Tokenizer to this Tokens ResourceCollection. A LineTokenizer will be used by default.

Parameters:

tokenizer - the tokenizer to add.

dieOnCircularReference

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

Overrides the BaseResourceCollectionContainer version to check the nested Tokenizer.

Overrides:

dieOnCircularReference in class AbstractResourceCollectionWrapper

Parameters:

stk - the stack of data types to use (recursively).

p - the project to use to dereference the references.

Throws:

BuildException - on error.