org.apache.tools.ant.types.resources

Class Resources

Implemented Interfaces:
Cloneable, ResourceCollection

public class Resources
extends DataType
implements ResourceCollection

Generic ResourceCollection: Either stores nested ResourceCollections, making no attempt to remove duplicates, or references another ResourceCollection.
Since:
Ant 1.7

Field Summary

static Iterator
EMPTY_ITERATOR
static empty Iterator
static ResourceCollection
NONE
static empty ResourceCollection

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Method Summary

void
add(ResourceCollection c)
Add a ResourceCollection.
protected void
dieOnCircularReference(Stack stk, Project p)
Overrides the version of DataType to recurse on all DataType child elements that may have been added.
boolean
isFilesystemOnly()
Fulfill the ResourceCollection contract.
Iterator
iterator()
Fulfill the ResourceCollection contract.
int
size()
Fulfill the ResourceCollection contract.
String
toString()
Format this BaseResourceCollectionContainer as a String.

Methods inherited from class org.apache.tools.ant.types.DataType

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

Methods inherited from class org.apache.tools.ant.ProjectComponent

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

Field Details

EMPTY_ITERATOR

public static final Iterator EMPTY_ITERATOR
static empty Iterator

NONE

public static final ResourceCollection NONE
static empty ResourceCollection

Method Details

add

public void add(ResourceCollection c)
Add a ResourceCollection.
Parameters:
c - the ResourceCollection to add.

dieOnCircularReference

protected void dieOnCircularReference(Stack stk,
                                      Project p)
            throws BuildException
Overrides the version of DataType to recurse on all DataType child elements that may have been added.
Overrides:
dieOnCircularReference in interface DataType
Parameters:
stk - the stack of data types to use (recursively).
p - the project to use to dereference the references.
Throws:
BuildException - on error.

isFilesystemOnly

public boolean isFilesystemOnly()
Fulfill the ResourceCollection contract.
Specified by:
isFilesystemOnly in interface ResourceCollection
Returns:
true if all Resources represent files.

iterator

public Iterator iterator()
Fulfill the ResourceCollection contract.
Specified by:
iterator in interface ResourceCollection
Returns:
an Iterator of Resources.

size

public int size()
Fulfill the ResourceCollection contract.
Specified by:
size in interface ResourceCollection
Returns:
number of elements as int.

toString

public String toString()
Format this BaseResourceCollectionContainer as a String.
Overrides:
toString in interface DataType
Returns:
a descriptive String.