Class 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
  • 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(java.lang.Class<T>).
      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.