Class BaseResourceCollectionContainer
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
- All Implemented Interfaces:
Cloneable,Iterable<Resource>,ResourceCollection,AppendableResourceCollection
- Direct Known Subclasses:
Difference,Intersect,Union
public abstract class BaseResourceCollectionContainer
extends DataType
implements AppendableResourceCollection, Cloneable
Base class for ResourceCollections that nest multiple ResourceCollections.
- Since:
- Ant 1.7
-
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new BaseResourceCollectionContainer.BaseResourceCollectionContainer(Project project) Create a new BaseResourceCollectionContainer. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a ResourceCollection to the container.voidaddAll(Collection<? extends ResourceCollection> c) Add the Collection of ResourceCollections to the container.voidclear()Clear the container.clone()Implement clone.protected voiddieOnCircularReference(Stack<Object> stk, Project p) Overrides the version of DataType to recurse on all DataType child elements that may have been added.protected abstract Collection<Resource>Template method for subclasses to return a Collection object of Resources.final List<ResourceCollection>Get the nested ResourceCollections.booleanisCache()Learn whether to cache collections.booleanFulfill the ResourceCollection contract.iterator()Fulfill the ResourceCollection contract.voidsetCache(boolean b) Set whether to cache collections.intsize()Fulfill the ResourceCollection contract.toString()Format this BaseResourceCollectionContainer as a String.Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollection
isEmpty, stream
-
Constructor Details
-
BaseResourceCollectionContainer
public BaseResourceCollectionContainer()Create a new BaseResourceCollectionContainer. -
BaseResourceCollectionContainer
Create a new BaseResourceCollectionContainer.- Parameters:
project- Project- Since:
- Ant 1.8
-
-
Method Details
-
setCache
public void setCache(boolean b) Set whether to cache collections.- Parameters:
b- boolean cache flag.
-
isCache
public boolean isCache()Learn whether to cache collections. Default istrue.- Returns:
- boolean cache flag.
-
clear
Clear the container.- Throws:
BuildException- on error.
-
add
Add a ResourceCollection to the container.- Specified by:
addin interfaceAppendableResourceCollection- Parameters:
c- the ResourceCollection to add.- Throws:
BuildException- on error.
-
addAll
Add the Collection of ResourceCollections to the container.- Parameters:
c- the Collection whose elements to add.- Throws:
BuildException- on error.
-
iterator
Fulfill the ResourceCollection contract. The Iterator returned will throw ConcurrentModificationExceptions if ResourceCollections are added to this container while the Iterator is in use. -
size
public int size()Fulfill the ResourceCollection contract.- Specified by:
sizein interfaceResourceCollection- Returns:
- number of elements as int.
-
isFilesystemOnly
public boolean isFilesystemOnly()Fulfill the ResourceCollection contract.- Specified by:
isFilesystemOnlyin interfaceResourceCollection- Returns:
- whether this is a filesystem-only resource collection.
-
dieOnCircularReference
Overrides the version of DataType to recurse on all DataType child elements that may have been added.- Overrides:
dieOnCircularReferencein classDataType- Parameters:
stk- the stack of data types to use (recursively).p- the project to use to dereference the references.- Throws:
BuildException- on error.
-
getResourceCollections
Get the nested ResourceCollections.- Returns:
- List.
-
getCollection
Template method for subclasses to return a Collection object of Resources.- Returns:
- Collection.
-
clone
Implement clone. The set of nested resource collections is shallowly cloned. -
toString
Format this BaseResourceCollectionContainer as a String.
-