ZipResource (Apache Ant API)
Description: declaration: package: org.apache.tools.ant.types.resources, class: ZipResource

# Class ZipResource

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Resource
org.apache.tools.ant.types.resources.ArchiveResource
org.apache.tools.ant.types.resources.ZipResource

All Implemented Interfaces:
  `Cloneable, Comparable<Resource>, Iterable<Resource>, ResourceCollection`

public class ZipResource extends ArchiveResource
A Resource representation of an entry in a zipfile.

Since:
  Ant 1.7

- ## Field Summary

  ### Fields inherited from class Resource

  `MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE`
  Modifier and Type
  Field
  Description
  `protected static final int`
  `MAGIC`
  Magic number
  `static final long`
  `UNKNOWN_DATETIME`
  Constant unknown datetime for getLastModified
  `static final long`
  `UNKNOWN_SIZE`
  Constant unknown size

  ### 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
  `ZipResource()`
  Default constructor.
  `ZipResource(File z, String enc, ZipEntry e)`
  Construct a ZipResource representing the specified entry in the specified zipfile.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addConfigured(ResourceCollection a)`
  Sets the archive that holds this as a single element Resource collection.
  `protected void`
  `fetchEntry()`
  fetches information from the named entry inside the archive.
  `String`
  `getEncoding()`
  Get the encoding to use with the zipfile.
  `ZipExtraField[]`
  `getExtraFields()`
  Retrieves extra fields.
  `InputStream`
  `getInputStream()`
  Return an InputStream for reading the contents of this Resource.
  `int`
  `getMethod()`
  The compression method that has been used.
  `OutputStream`
  `getOutputStream()`
  Get an OutputStream for the Resource.
  `protected ZipResource`
  `getRef()`
  Perform the check for circular references and return the referenced Resource.
  `static InputStream`
  `getZipEntryStream(ZipFile zipFile, String zipEntry)`
  Return an InputStream for reading the contents of a ZipEntry with autoclose.
  `File`
  `getZipfile()`
  Get the zipfile that holds this ZipResource.
  `void`
  `setEncoding(String enc)`
  Set the encoding to use with the zipfile.
  `void`
  `setRefid(Reference r)`
  Overrides the super version.
  `void`
  `setZipfile(File z)`
  Set the zipfile that holds this ZipResource.

  ### Methods inherited from class ArchiveResource

  `checkEntry, compareTo, dieOnCircularReference, equals, getArchive, getLastModified, getMode, getSize, hashCode, isDirectory, isExists, setArchive, setMode, toString`
  Modifier and Type
  Method
  Description
  `protected final void`
  `checkEntry()`
  Validate settings and ensure that the represented "archive entry" has been established.
  `int`
  `compareTo(Resource another)`
  Compare this ArchiveResource to another Resource.
  `protected void`
  `dieOnCircularReference(Stack<Object> stk, Project p)`
  Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).
  `boolean`
  `equals(Object another)`
  Compare another Object to this ArchiveResource for equality.
  `Resource`
  `getArchive()`
  Get the archive that holds this Resource.
  `long`
  `getLastModified()`
  Get the last modified date of this Resource.
  `int`
  `getMode()`
  Get the file or dir mode for this Resource.
  `long`
  `getSize()`
  Get the size of this Resource.
  `int`
  `hashCode()`
  Get the hash code for this Resource.
  `boolean`
  `isDirectory()`
  Learn whether this Resource represents a directory.
  `boolean`
  `isExists()`
  Find out whether this Resource represents an existing Resource.
  `void`
  `setArchive(File a)`
  Set the archive that holds this Resource.
  `void`
  `setMode(int mode)`
  Sets the file or dir mode for this resource.
  `String`
  `toString()`
  Format this Resource as a String.

  ### Methods inherited from class Resource

  `as, asOptional, clone, getMagicNumber, getName, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString`
  Modifier and Type
  Method
  Description
  `<T> T`
  `as(Class<T> clazz)`
  Returns a view of this resource that implements the interface given as the argument or null if there is no such view.
  `<T> Optional<T>`
  `asOptional(Class<T> clazz)`
  Return `Resource.as(Class)` as an `Optional`.
  `Object`
  `clone()`
  Clone this Resource.
  `protected static int`
  `getMagicNumber(byte[] seed)`
  Create a "magic number" for use in hashCode calculations.
  `String`
  `getName()`
  Name attribute will contain the path of a file relative to the root directory of its fileset or the recorded path of a zip entry.
  `boolean`
  `isFilesystemOnly()`
  Fulfill the ResourceCollection contract.
  `Iterator<Resource>`
  `iterator()`
  Fulfill the ResourceCollection contract.
  `void`
  `setDirectory(boolean directory)`
  Set the directory attribute.
  `void`
  `setExists(boolean exists)`
  Set the exists attribute.
  `void`
  `setLastModified(long lastmodified)`
  Set the last modification attribute.
  `void`
  `setName(String name)`
  Set the name of this Resource.
  `void`
  `setSize(long size)`
  Set the size of this Resource.
  `int`
  `size()`
  Fulfill the ResourceCollection contract.
  `final String`
  `toLongString()`
  Get a long String representation of this Resource.

  ### Methods inherited from class DataType

  `checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes`
  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.

  ### 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

  `finalize, getClass, 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

  - ### ZipResource

    public ZipResource()
    Default constructor.

  - ### ZipResource

    public ZipResource(File z, String enc, ZipEntry e)
    Construct a ZipResource representing the specified entry in the specified zipfile.
    Parameters:
      `z` - the zipfile as File.
      `enc` - the encoding used for filenames.
      `e` - the ZipEntry.

- ## Method Details

  - ### setZipfile

    public void setZipfile(File z)
    Set the zipfile that holds this ZipResource.
    Parameters:
      `z` - the zipfile as a File.

  - ### getZipfile

    public File getZipfile()
    Get the zipfile that holds this ZipResource.
    Returns:
      the zipfile as a File.

  - ### addConfigured

    public void addConfigured(ResourceCollection a)
    Sets the archive that holds this as a single element Resource collection.
    Overrides:
      `addConfigured` in class `ArchiveResource`
    Parameters:
      `a` - the archive as a single element Resource collection.

  - ### setEncoding

    public void setEncoding(String enc)
    Set the encoding to use with the zipfile.
    Parameters:
      `enc` - the String encoding.

  - ### getEncoding

    public String getEncoding()
    Get the encoding to use with the zipfile.
    Returns:
      String encoding.

  - ### setRefid

    public void setRefid(Reference r)
    Overrides the super version.
    Overrides:
      `setRefid` in class `ArchiveResource`
    Parameters:
      `r` - the Reference to set.

  - ### getInputStream

    public InputStream getInputStream() throws IOException
    Return an InputStream for reading the contents of this Resource.
    Overrides:
      `getInputStream` in class `Resource`
    Returns:
      an InputStream object.
    Throws:
      `IOException` - if the zip file cannot be opened, or the entry cannot be read.

  - ### getOutputStream

    public OutputStream getOutputStream() throws IOException
    Get an OutputStream for the Resource.
    Overrides:
      `getOutputStream` in class `Resource`
    Returns:
      an OutputStream to which content can be written.
    Throws:
      `IOException` - if unable to provide the content of this Resource as a stream.
      `UnsupportedOperationException` - if OutputStreams are not supported for this Resource type.

  - ### getExtraFields

    public ZipExtraField[] getExtraFields()
    Retrieves extra fields.
    Returns:
      an array of the extra fields
    Since:
      Ant 1.8.0

  - ### getMethod

    public int getMethod()
    The compression method that has been used.
    Returns:
      int
    Since:
      Ant 1.8.0

  - ### getZipEntryStream

    public static InputStream getZipEntryStream(ZipFile zipFile, String zipEntry) throws IOException
    Return an InputStream for reading the contents of a ZipEntry with autoclose.
    Parameters:
      `zipFile` - a org.apache.tools.zip.ZipFile
      `zipEntry` - String a name of a zip entry
    Returns:
      an InputStream object
    Throws:
      `IOException` - if the entry cannot be read

  - ### fetchEntry

    protected void fetchEntry()
    fetches information from the named entry inside the archive.
    Specified by:
      `fetchEntry` in class `ArchiveResource`

  - ### getRef

    protected ZipResource getRef()
    Description copied from class: `Resource`
    Perform the check for circular references and return the referenced Resource.
    Overrides:
      `getRef` in class `ArchiveResource`
    Returns:
      `Resource`.