Class ResourceList

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.types.DataType

org.apache.tools.ant.types.resources.ResourceList

All Implemented Interfaces:

Cloneable, Iterable<Resource>, ResourceCollection

public class ResourceList
extends DataType
implements ResourceCollection

Reads a resource as text document and creates a resource for each line.

Since:

Ant 1.8.0

Field Summary

Fields inherited from class DataType

checked, ref

Modifier and Type	Field	Description
protected boolean	checked	Deprecated. since 1.7.
protected Reference	ref	Deprecated. since 1.7.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
ResourceList()

Method Summary

Modifier and Type	Method	Description
void	add(ResourceCollection rc)	Adds a source.
final void	addFilterChain(FilterChain filter)	Adds a FilterChain.
protected void	dieOnCircularReference(Stack<Object> 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.
final Iterator<Resource>	iterator()	Fulfill the ResourceCollection contract.
final void	setBasedir(File baseDir)	Basedir to use for file resources read from nested resources - this allows the resources contained inside this collection to be considered relative to a certain base directory.
final void	setEncoding(String encoding)	Encoding to use for input, defaults to the platform's default encoding.
final void	setPreserveDuplicates(boolean preserveDuplicates)	Makes this resourcelist return all resources as many times as they are specified.
void	setRefid(Reference r)	Makes this instance in effect a reference to another ResourceList instance.
int	size()	Fulfill the ResourceCollection contract.

Methods inherited from class DataType

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

Modifier and Type	Method	Description
protected void	checkAttributesAllowed()	check that it is ok to set attributes, i.e that no reference is defined
protected void	checkChildrenAllowed()	check that it is ok to add children, i.e that no reference is defined
protected BuildException	circularReference()	Creates an exception that indicates the user has generated a loop of data types referencing each other.
Object	clone()
protected void	dieOnCircularReference()	Convenience method.
protected void	dieOnCircularReference(Project p)	Convenience method.
protected <T> T	getCheckedRef()	Deprecated. use getCheckedRef(Class)
protected <T> T	getCheckedRef(Class<T> requiredClass)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName, Project project)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Project p)	Deprecated. use getCheckedRef(Class)
protected String	getDataTypeName()	Gets as descriptive as possible a name used for this datatype instance.
Reference	getRefid()	get the reference set on this object
static void	invokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected boolean	isChecked()	The flag that is used to indicate that circular references have been checked.
boolean	isReference()	Has the refid attribute of this element been set?
protected BuildException	noChildrenAllowed()	Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
static void	pushAndInvokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected void	setChecked(boolean checked)	Set the flag that is used to indicate that circular references have been checked.
protected BuildException	tooManyAttributes()	Creates an exception that indicates that refid has to be the only attribute if it is set.
String	toString()	Basic DataType toString().

Methods inherited from class ProjectComponent

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

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface ResourceCollection

isEmpty, stream

Modifier and Type	Method	Description
default boolean	isEmpty()	Learn whether this ResourceCollection is empty.
default Stream<? extends Resource>	stream()	Return a Stream over this ResourceCollection.

Constructor Details

ResourceList

public ResourceList()

Method Details

add

public void add(ResourceCollection rc)

Adds a source.

Parameters:

rc - ResourceCollection

addFilterChain

public final void addFilterChain(FilterChain filter)

Adds a FilterChain.

Parameters:

filter - FilterChain

setEncoding

public final void setEncoding(String encoding)

Encoding to use for input, defaults to the platform's default encoding.

For a list of possible values see https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html.

Parameters:

encoding - String

setBasedir

public final void setBasedir(File baseDir)

Basedir to use for file resources read from nested resources - this allows the resources contained inside this collection to be considered relative to a certain base directory.

Parameters:

baseDir - the basedir

Since:

Ant 1.10.4

setPreserveDuplicates

public final void setPreserveDuplicates(boolean preserveDuplicates)

Makes this resourcelist return all resources as many times as they are specified. Otherwise resourcelist will only return each resource, in the order they first appear.

Parameters:

preserveDuplicates - boolean

Since:

Ant 1.10.10

setRefid

public void setRefid(Reference r)
              throws BuildException

Makes this instance in effect a reference to another ResourceList instance.

Overrides:

setRefid in class DataType

Parameters:

r - Reference

Throws:

BuildException

iterator

public final Iterator<Resource> iterator()

Fulfill the ResourceCollection contract. The Iterator returned will throw ConcurrentModificationExceptions if ResourceCollections are added to this container while the Iterator is in use.

Specified by:

iterator in interface Iterable<Resource>

Returns:

a "fail-fast" Iterator.

size

public int size()

Fulfill the ResourceCollection contract.

Specified by:

size in interface ResourceCollection

Returns:

number of elements as int.

isFilesystemOnly

public boolean isFilesystemOnly()

Fulfill the ResourceCollection contract.

Specified by:

isFilesystemOnly in interface ResourceCollection

Returns:

whether this is a filesystem-only resource collection.

dieOnCircularReference

protected void dieOnCircularReference(Stack<Object> 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 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.