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:
java.lang.Cloneable,java.lang.Comparable<Resource>,java.lang.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 org.apache.tools.ant.types.Resource
MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE -
Constructor Summary
Constructors Constructor Description ZipResource()Default constructor.ZipResource(java.io.File z, java.lang.String enc, ZipEntry e)Construct a ZipResource representing the specified entry in the specified zipfile. -
Method Summary
Modifier and Type Method Description voidaddConfigured(ResourceCollection a)Sets the archive that holds this as a single element Resource collection.protected voidfetchEntry()fetches information from the named entry inside the archive.java.lang.StringgetEncoding()Get the encoding to use with the zipfile.ZipExtraField[]getExtraFields()Retrieves extra fields.java.io.InputStreamgetInputStream()Return an InputStream for reading the contents of this Resource.intgetMethod()The compression method that has been used.java.io.OutputStreamgetOutputStream()Get an OutputStream for the Resource.protected ZipResourcegetRef()Perform the check for circular references and return the referenced Resource.static java.io.InputStreamgetZipEntryStream(ZipFile zipFile, java.lang.String zipEntry)Return an InputStream for reading the contents of a ZipEntry with autoclose.java.io.FilegetZipfile()Get the zipfile that holds this ZipResource.voidsetEncoding(java.lang.String enc)Set the encoding to use with the zipfile.voidsetRefid(Reference r)Overrides the super version.voidsetZipfile(java.io.File z)Set the zipfile that holds this ZipResource.Methods inherited from class org.apache.tools.ant.types.resources.ArchiveResource
checkEntry, compareTo, dieOnCircularReference, equals, getArchive, getLastModified, getMode, getSize, hashCode, isDirectory, isExists, setArchive, setMode, toStringMethods inherited from class org.apache.tools.ant.types.Resource
as, asOptional, clone, getMagicNumber, getName, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongStringMethods 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, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Constructor Details
-
ZipResource
public ZipResource()Default constructor. -
ZipResource
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(java.io.File z)Set the zipfile that holds this ZipResource.- Parameters:
z- the zipfile as a File.
-
getZipfile
public java.io.File getZipfile()Get the zipfile that holds this ZipResource.- Returns:
- the zipfile as a File.
-
addConfigured
Sets the archive that holds this as a single element Resource collection.- Overrides:
addConfiguredin classArchiveResource- Parameters:
a- the archive as a single element Resource collection.
-
setEncoding
public void setEncoding(java.lang.String enc)Set the encoding to use with the zipfile.- Parameters:
enc- the String encoding.
-
getEncoding
public java.lang.String getEncoding()Get the encoding to use with the zipfile.- Returns:
- String encoding.
-
setRefid
Overrides the super version.- Overrides:
setRefidin classArchiveResource- Parameters:
r- the Reference to set.
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOExceptionReturn an InputStream for reading the contents of this Resource.- Overrides:
getInputStreamin classResource- Returns:
- an InputStream object.
- Throws:
java.io.IOException- if the zip file cannot be opened, or the entry cannot be read.
-
getOutputStream
public java.io.OutputStream getOutputStream() throws java.io.IOExceptionGet an OutputStream for the Resource.- Overrides:
getOutputStreamin classResource- Returns:
- an OutputStream to which content can be written.
- Throws:
java.io.IOException- if unable to provide the content of this Resource as a stream.java.lang.UnsupportedOperationException- if OutputStreams are not supported for this Resource type.
-
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 java.io.InputStream getZipEntryStream(ZipFile zipFile, java.lang.String zipEntry) throws java.io.IOExceptionReturn an InputStream for reading the contents of a ZipEntry with autoclose.- Parameters:
zipFile- a org.apache.tools.zip.ZipFilezipEntry- String a name of a zip entry- Returns:
- an InputStream object
- Throws:
java.io.IOException- if the entry cannot be read
-
fetchEntry
protected void fetchEntry()fetches information from the named entry inside the archive.- Specified by:
fetchEntryin classArchiveResource
-
getRef
Description copied from class:ResourcePerform the check for circular references and return the referenced Resource.- Overrides:
getRefin classArchiveResource- Returns:
Resource.
-