org.apache.tools.ant.types.resources

Class BaseResourceCollectionWrapper

public abstract class BaseResourceCollectionWrapper extends DataType implements ResourceCollection, Cloneable

Base class for a ResourceCollection that wraps a single nested ResourceCollection.

Since: Ant 1.7

Method Summary
void	add(ResourceCollection c) Add a ResourceCollection to the container.
protected void	dieOnCircularReference(Stack stk, Project p) Overrides the version of DataType to recurse on all DataType child elements that may have been added.
protected abstract Collection	getCollection() Template method for subclasses to return a Collection of Resources.
protected ResourceCollection	getResourceCollection() Get the nested ResourceCollection.
boolean	isCache() Learn whether to cache collections.
boolean	isFilesystemOnly() Fulfill the ResourceCollection contract.
Iterator	iterator() Fulfill the ResourceCollection contract.
void	setCache(boolean b) Set whether to cache collections.
int	size() Fulfill the ResourceCollection contract.
String	toString() Format this BaseResourceCollectionWrapper as a String.

Method Detail

add

public void add(ResourceCollection c)

Add a ResourceCollection to the container.

Parameters: c the ResourceCollection to add.

Throws: BuildException on error.

dieOnCircularReference

protected void dieOnCircularReference(Stack stk, Project p)

Overrides the version of DataType to recurse on all DataType child elements that may have been added.

Parameters: stk the stack of data types to use (recursively). p the project to use to dereference the references.

Throws: BuildException on error.

getCollection

protected abstract Collection getCollection()

Template method for subclasses to return a Collection of Resources.

Returns: Collection.

getResourceCollection

protected final ResourceCollection getResourceCollection()

Get the nested ResourceCollection.

Returns: a ResourceCollection.

Throws: BuildException if no nested ResourceCollection has been provided.

isCache

public boolean isCache()

Learn whether to cache collections. Default is true.

Returns: boolean cache flag.

isFilesystemOnly

public boolean isFilesystemOnly()

Fulfill the ResourceCollection contract.

Returns: whether this is a filesystem-only resource collection.

iterator

public final Iterator iterator()

Fulfill the ResourceCollection contract.

Returns: an Iterator of Resources.

setCache

public void setCache(boolean b)

Set whether to cache collections.

Parameters: b boolean cache flag.

size

public int size()

Fulfill the ResourceCollection contract.

Returns: number of elements as int.

toString

public String toString()

Format this BaseResourceCollectionWrapper as a String.

Returns: a descriptive String.