Apache Ant Core 1.10.14 · org.apache.tools.ant.types.resources.ZipResource

Modifier and Type	Field and Description
private String	encoding
private ZipExtraField[]	extras
private int	method

Access	Constructor and Description
public	ZipResource() Default constructor.
public	ZipResource(File the zipfile as File. z, String the encoding used for filenames. enc, ZipEntry the ZipEntry. e) Construct a ZipResource representing the specified entry in the specified zipfile.

Method Summary

Modifier and Type	Method and Description
public void	addConfigured(ResourceCollection the archive as a single element Resource collection. a) Overrides org.apache.tools.ant.types.resources.ArchiveResource.addConfigured. Sets the archive that holds this as a single element Resource collection.
protected void	fetchEntry() Implements abstract org.apache.tools.ant.types.resources.ArchiveResource.fetchEntry. fetches information from the named entry inside the archive.
public String	Returns: String encoding. getEncoding() Get the encoding to use with the zipfile.
public ZipExtraField[]	Returns: an array of the extra fields getExtraFields() Retrieves extra fields.
public InputStream	Returns: an InputStream object. getInputStream() Overrides org.apache.tools.ant.types.Resource.getInputStream. Return an InputStream for reading the contents of this Resource.
public int	Returns: int getMethod() The compression method that has been used.
public OutputStream	Returns: an OutputStream to which content can be written. getOutputStream() Overrides org.apache.tools.ant.types.Resource.getOutputStream. Get an OutputStream for the Resource.
protected ZipResource	getRef() Overrides org.apache.tools.ant.types.resources.ArchiveResource.getRef. Perform the check for circular references and return the referenced Resource.
public static InputStream	Returns: an InputStream object getZipEntryStream(ZipFile a org.apache.tools.zip.ZipFile zipFile, String String a name of a zip entry zipEntry) Return an InputStream for reading the contents of a ZipEntry with autoclose.
public File	Returns: the zipfile as a File. getZipfile() Get the zipfile that holds this ZipResource.
public void	setEncoding(String the String encoding. enc) Set the encoding to use with the zipfile.
private void	setEntry(ZipEntry e)
public void	setRefid(Reference the Reference to set. r) Overrides org.apache.tools.ant.types.resources.ArchiveResource.setRefid. Overrides the super version.
public void	setZipfile(File the zipfile as a File. z) Set the zipfile that holds this ZipResource.

Inherited from org.apache.tools.ant.types.resources.ArchiveResource:: checkEntry compareTo dieOnCircularReference equals getArchive getLastModified getMode getSize hashCode isDirectory isExists setArchive setMode toString

encoding	back to summary
private String encoding

extras	back to summary
private ZipExtraField[] extras

method	back to summary
private int method

ZipResource	back to summary
public ZipResource() Default constructor.

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

Method Detail

addConfigured	back to summary
public void addConfigured(ResourceCollection a) Overrides org.apache.tools.ant.types.resources.ArchiveResource.addConfigured. Sets the archive that holds this as a single element Resource collection. Parameters a:ResourceCollection the archive as a single element Resource collection.

addConfigured

back to summary

public void addConfigured(ResourceCollection a)

Overrides org.apache.tools.ant.types.resources.ArchiveResource.addConfigured.

Sets the archive that holds this as a single element Resource collection.

Parameters

a:ResourceCollection: the archive as a single element Resource collection.

fetchEntry	back to summary
protected void fetchEntry() Implements abstract org.apache.tools.ant.types.resources.ArchiveResource.fetchEntry. fetches information from the named entry inside the archive.

fetchEntry

back to summary

protected void fetchEntry()

Implements abstract org.apache.tools.ant.types.resources.ArchiveResource.fetchEntry.

fetches information from the named entry inside the archive.

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

getEncoding

back to summary

public String getEncoding()

Get the encoding to use with the zipfile.

Returns:String: String encoding.

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

getExtraFields

back to summary

public ZipExtraField[] getExtraFields()

Retrieves extra fields.

Returns:ZipExtraField[]: an array of the extra fields
Since: Ant 1.8.0

getInputStream	back to summary
public InputStream getInputStream() throws IOException Overrides org.apache.tools.ant.types.Resource.getInputStream. Return an InputStream for reading the contents of this Resource. Returns:InputStream an InputStream object. Exceptions IOException: if the zip file cannot be opened, or the entry cannot be read.

getInputStream

back to summary

public InputStream getInputStream() throws IOException

Overrides org.apache.tools.ant.types.Resource.getInputStream.

Return an InputStream for reading the contents of this Resource.

Returns:InputStream

an InputStream object.

Exceptions

IOException:: if the zip file cannot be opened, or the entry cannot be read.

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

getMethod

back to summary

public int getMethod()

The compression method that has been used.

Returns:int: int
Since: Ant 1.8.0

getOutputStream	back to summary
public OutputStream getOutputStream() throws IOException Overrides org.apache.tools.ant.types.Resource.getOutputStream. Get an OutputStream for the Resource. Returns:OutputStream an OutputStream to which content can be written. Exceptions IOException: if unable to provide the content of this Resource as a stream. UnsupportedOperationException: if OutputStreams are not supported for this Resource type.

getOutputStream

back to summary

public OutputStream getOutputStream() throws IOException

Overrides org.apache.tools.ant.types.Resource.getOutputStream.

Get an OutputStream for the Resource.

Returns:OutputStream

an OutputStream to which content can be written.

Exceptions

IOException:: if unable to provide the content of this Resource as a stream.
UnsupportedOperationException:: if OutputStreams are not supported for this Resource type.

getRef back to summary

getRef	back to summary
protected ZipResource getRef() Overrides org.apache.tools.ant.types.resources.ArchiveResource.getRef. Doc from org.apache.tools.ant.types.Resource.getRef. Perform the check for circular references and return the referenced Resource. Returns:ZipResource `Resource`. Annotations @Override

protected ZipResource getRef()

Overrides org.apache.tools.ant.types.resources.ArchiveResource.getRef.

Doc from org.apache.tools.ant.types.Resource.getRef.

Perform the check for circular references and return the referenced Resource.

Returns:ZipResource

Resource.

Annotations

@Override

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

getZipEntryStream

back to summary

public static InputStream getZipEntryStream(ZipFile zipFile, String zipEntry) throws IOException

Return an InputStream for reading the contents of a ZipEntry with autoclose.

Parameters

zipFile:ZipFile: a org.apache.tools.zip.ZipFile
zipEntry:String: String a name of a zip entry

Returns:InputStream

an InputStream object

Exceptions

IOException:: if the entry cannot be read

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

getZipfile

back to summary

public File getZipfile()

Get the zipfile that holds this ZipResource.

Returns:File: the zipfile as a File.

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

setEncoding

back to summary

public void setEncoding(String enc)

Set the encoding to use with the zipfile.

Parameters

enc:String: the String encoding.

setEntry	back to summary
private void setEntry(ZipEntry e)

setRefid	back to summary
public void setRefid(Reference r) Overrides org.apache.tools.ant.types.resources.ArchiveResource.setRefid. Overrides the super version. Parameters r:Reference the Reference to set.

setRefid

back to summary

public void setRefid(Reference r)

Overrides org.apache.tools.ant.types.resources.ArchiveResource.setRefid.

Overrides the super version.

Parameters

r:Reference: the Reference to set.

setZipfile	back to summary
public void setZipfile(File z) Set the zipfile that holds this ZipResource. Parameters z:File the zipfile as a File.

setZipfile

back to summary

public void setZipfile(File z)

Set the zipfile that holds this ZipResource.

Parameters

z:File: the zipfile as a File.

public Class ZipResource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail