Class AbstractResourceCollectionWrapper
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.types.DataType
- 
- org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- java.lang.Iterable<Resource>,- ResourceCollection
 - Direct Known Subclasses:
- BaseResourceCollectionWrapper,- LazyResourceCollectionWrapper
 
 public abstract class AbstractResourceCollectionWrapper extends DataType implements ResourceCollection, java.lang.Cloneable Base class for a ResourceCollection that wraps a single nested ResourceCollection.- Since:
- Ant 1.8.2
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description AbstractResourceCollectionWrapper()
 - 
Method SummaryModifier and Type Method Description voidadd(ResourceCollection c)Add a ResourceCollection to the container.protected abstract java.util.Iterator<Resource>createIterator()Do create an iterator on the resource collection.protected voiddieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p)Overrides the version of DataType to recurse on all DataType child elements that may have been added.protected ResourceCollectiongetResourceCollection()Get the nested ResourceCollection.protected abstract intgetSize()Do compute the size of the resource collection.booleanisCache()Learn whether to cache collections.booleanisFilesystemOnly()Fulfill the ResourceCollection contract.java.util.Iterator<Resource>iterator()Fulfill the ResourceCollection contract.voidsetCache(boolean b)Set whether to cache collections.intsize()Fulfill the ResourceCollection contract.java.lang.StringtoString()Format this AbstractResourceCollectionWrapper as a String.- 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
 
- 
 
- 
- 
- 
Method Detail- 
setCachepublic void setCache(boolean b) Set whether to cache collections.- Parameters:
- b- boolean cache flag.
 
 - 
isCachepublic boolean isCache() Learn whether to cache collections. Default istrue.- Returns:
- boolean cache flag.
 
 - 
addpublic void add(ResourceCollection c) throws BuildException Add a ResourceCollection to the container.- Parameters:
- c- the ResourceCollection to add.
- Throws:
- BuildException- on error.
 
 - 
iteratorpublic final java.util.Iterator<Resource> iterator() Fulfill the ResourceCollection contract.- Specified by:
- iteratorin interface- java.lang.Iterable<Resource>
- Returns:
- an Iterator of Resources.
 
 - 
createIteratorprotected abstract java.util.Iterator<Resource> createIterator() Do create an iterator on the resource collection. The creation of the iterator is allowed to not be thread safe whereas the iterator itself should. The returned iterator will be wrapped into the FailFast one.- Returns:
- the iterator on the resource collection
 
 - 
sizepublic int size() Fulfill the ResourceCollection contract.- Specified by:
- sizein interface- ResourceCollection
- Returns:
- number of elements as int.
 
 - 
getSizeprotected abstract int getSize() Do compute the size of the resource collection. The implementation of this function is allowed to be not thread safe.- Returns:
- size of resource collection.
 
 - 
isFilesystemOnlypublic boolean isFilesystemOnly() Fulfill the ResourceCollection contract.- Specified by:
- isFilesystemOnlyin interface- ResourceCollection
- Returns:
- whether this is a filesystem-only resource collection.
 
 - 
dieOnCircularReferenceprotected void dieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p) throws BuildExceptionOverrides the version of DataType to recurse on all DataType child elements that may have been added.- Overrides:
- dieOnCircularReferencein class- DataType
- Parameters:
- stk- the stack of data types to use (recursively).
- p- the project to use to dereference the references.
- Throws:
- BuildException- on error.
 
 - 
getResourceCollectionprotected final ResourceCollection getResourceCollection() Get the nested ResourceCollection.- Returns:
- a ResourceCollection.
- Throws:
- BuildException- if no nested ResourceCollection has been provided.
 
 
- 
 
-