Class Archives

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.types.DataType

org.apache.tools.ant.types.resources.Archives

All Implemented Interfaces:

Cloneable, Iterable<Resource>, ResourceCollection

public class Archives
extends DataType
implements ResourceCollection, Cloneable

A resource collection that treats all nested resources as archives and returns the contents of the archives as its content.

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
Archives()

Method Summary

Modifier and Type	Method	Description
Object	clone()	Implement clone.
protected ArchiveFileSet	configureArchive(ArchiveFileSet afs, Resource src)	Configures the archivefileset based on this type's settings, set the source.
Union	createTars()	Wrapper to identify nested resource collections as ZIP archives.
Union	createZips()	Wrapper to identify nested resource collections as ZIP archives.
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.
protected Iterator<ArchiveFileSet>	grabArchives()	Turns all nested resources into corresponding ArchiveFileSets and returns an iterator over the collected archives.
boolean	isFilesystemOnly()	Indicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions.
Iterator<Resource>	iterator()	Merges the nested collections.
void	setRefid(Reference r)	Overrides the base version.
int	size()	Sums the sizes of nested archives.

Methods inherited from class DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, 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.
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

Archives

public Archives()

Method Details

createZips

public Union createZips()

Wrapper to identify nested resource collections as ZIP archives.

Returns:

Union

createTars

public Union createTars()

Wrapper to identify nested resource collections as ZIP archives.

Returns:

Union

size

public int size()

Sums the sizes of nested archives.

Specified by:

size in interface ResourceCollection

Returns:

int

iterator

public Iterator<Resource> iterator()

Merges the nested collections.

Specified by:

iterator in interface Iterable<Resource>

Returns:

Iterator<Resource>

isFilesystemOnly

public boolean isFilesystemOnly()

Description copied from interface: ResourceCollection

Indicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions. If true, all resources returned from this collection should respond with a FileProvider when asked via Resource.as(Class).

Specified by:

isFilesystemOnly in interface ResourceCollection

Returns:

false

setRefid

public void setRefid(Reference r)

Overrides the base version.

Overrides:

setRefid in class DataType

Parameters:

r - the Reference to set.

clone

public Object clone()

Implement clone. The nested resource collections are cloned as well.

Overrides:

clone in class DataType

Returns:

a cloned instance.

grabArchives

protected Iterator<ArchiveFileSet> grabArchives()

Turns all nested resources into corresponding ArchiveFileSets and returns an iterator over the collected archives.

Returns:

Iterator<ArchiveFileSet>

configureArchive

protected ArchiveFileSet configureArchive(ArchiveFileSet afs,
 Resource src)

Configures the archivefileset based on this type's settings, set the source.

Parameters:

afs - ArchiveFileSet

src - Resource

Returns:

ArchiveFileSet

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.