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
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 org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Implement clone.protected ArchiveFileSetconfigureArchive(ArchiveFileSet afs, Resource src) Configures the archivefileset based on this type's settings, set the source.Wrapper to identify nested resource collections as ZIP archives.Wrapper to identify nested resource collections as ZIP archives.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 Iterator<ArchiveFileSet>Turns all nested resources into corresponding ArchiveFileSets and returns an iterator over the collected archives.booleanIndicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions.iterator()Merges the nested collections.voidOverrides the base version.intsize()Sums the sizes of nested archives.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, tooManyAttributes, toStringMethods 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
-
Archives
public Archives()
-
-
Method Details
-
createZips
Wrapper to identify nested resource collections as ZIP archives.- Returns:
- 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:
sizein interfaceResourceCollection- Returns:
- int
-
iterator
Merges the nested collections. -
isFilesystemOnly
public boolean isFilesystemOnly()Description copied from interface:ResourceCollectionIndicate whether this ResourceCollection is composed entirely of Resources accessible via local filesystem conventions. If true, all resources returned from this collection should respond with aFileProviderwhen asked viaResource.as(java.lang.Class<T>).- Specified by:
isFilesystemOnlyin interfaceResourceCollection- Returns:
- false
-
setRefid
Overrides the base version. -
clone
Implement clone. The nested resource collections are cloned as well. -
grabArchives
Turns all nested resources into corresponding ArchiveFileSets and returns an iterator over the collected archives.- Returns:
- Iterator<ArchiveFileSet>
-
configureArchive
Configures the archivefileset based on this type's settings, set the source.- Parameters:
afs- ArchiveFileSetsrc- Resource- Returns:
- ArchiveFileSet
-
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.
-