public class MappedResourceCollection extends DataType implements ResourceCollection, java.lang.Cloneable
description, location, project
Constructor and Description |
---|
MappedResourceCollection() |
Modifier and Type | Method and Description |
---|---|
void |
add(FileNameMapper fileNameMapper)
Add a nested filenamemapper.
|
void |
add(ResourceCollection c)
Adds the required nested ResourceCollection.
|
java.lang.Object |
clone()
Implement clone.
|
Mapper |
createMapper()
Define the mapper to map source to destination files.
|
protected void |
dieOnCircularReference(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.
|
boolean |
isFilesystemOnly()
Indicate whether this ResourceCollection is composed entirely of
Resources accessible via local filesystem conventions.
|
java.util.Iterator<Resource> |
iterator()
Gets the contents of this collection.
|
void |
setCache(boolean cache)
Set whether to cache collections.
|
void |
setEnableMultipleMappings(boolean enableMultipleMappings)
Set method of handling mappers that return multiple
mappings for a given source path.
|
void |
setRefid(Reference r)
Overrides the base version.
|
int |
size()
Learn the number of contained Resources.
|
java.lang.String |
toString()
Format this resource collection as a String.
|
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
public void add(ResourceCollection c) throws BuildException
c
- the ResourceCollection to add.BuildException
- on error.public Mapper createMapper() throws BuildException
BuildException
- if more than one mapper is defined.public void add(FileNameMapper fileNameMapper)
fileNameMapper
- the mapper to add.public void setEnableMultipleMappings(boolean enableMultipleMappings)
enableMultipleMappings
- If true the type will
use all the mappings for a given source path, if
false, only the first mapped name is
processed.
By default, this setting is false to provide backward
compatibility with earlier releases.public void setCache(boolean cache)
public boolean isFilesystemOnly()
FileProvider
when asked via Resource.as(java.lang.Class<T>)
.isFilesystemOnly
in interface ResourceCollection
public int size()
size
in interface ResourceCollection
public java.util.Iterator<Resource> iterator()
iterator
in interface java.lang.Iterable<Resource>
iterator
in interface ResourceCollection
public void setRefid(Reference r)
public java.lang.Object clone()
protected void dieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p) throws BuildException
dieOnCircularReference
in class DataType
stk
- the stack of data types to use (recursively).p
- the project to use to dereference the references.BuildException
- on error.