Class ZipEntry
- All Implemented Interfaces:
java.lang.Cloneable
public class ZipEntry
extends java.util.zip.ZipEntry
implements java.lang.Cloneable
The extra data is expected to follow the recommendation of APPNOTE.txt:
- the extra byte array consists of a sequence of extra fields
- each extra fields starts by a two byte header id followed by a two byte sequence holding the length of the remainder of data.
Any extra data that cannot be parsed by the rules above will be consumed as "unparseable" extra data and treated differently by the methods of this class. Older versions would have thrown an exception if any attempt was made to read or write extra data not conforming to the recommendation.
-
Field Summary
Fields Modifier and Type Field Description static intCENATTstatic intCENATXstatic intCENCOMstatic intCENCRCstatic intCENDSKstatic intCENEXTstatic intCENFLGstatic intCENHDRstatic intCENHOWstatic intCENLENstatic intCENNAMstatic intCENOFFstatic longCENSIGstatic intCENSIZstatic intCENTIMstatic intCENVEMstatic intCENVERstatic intCRC_UNKNOWNstatic intENDCOMstatic intENDHDRstatic intENDOFFstatic longENDSIGstatic intENDSIZstatic intENDSUBstatic intENDTOTstatic intEXTCRCstatic intEXTHDRstatic intEXTLENstatic longEXTSIGstatic intEXTSIZstatic intLOCCRCstatic intLOCEXTstatic intLOCFLGstatic intLOCHDRstatic intLOCHOWstatic intLOCLENstatic intLOCNAMstatic longLOCSIGstatic intLOCSIZstatic intLOCTIMstatic intLOCVERstatic intPLATFORM_FATstatic intPLATFORM_UNIX -
Constructor Summary
Constructors Modifier Constructor Description protectedZipEntry()ZipEntry(java.io.File inputFile, java.lang.String entryName)Creates a new zip entry taking some information from the given file and using the provided name.ZipEntry(java.lang.String name)Creates a new zip entry with the specified name.ZipEntry(java.util.zip.ZipEntry entry)Creates a new zip entry with fields taken from the specified zip entry.ZipEntry(ZipEntry entry)Creates a new zip entry with fields taken from the specified zip entry. -
Method Summary
Modifier and Type Method Description voidaddAsFirstExtraField(ZipExtraField ze)Adds an extra field - replacing an already present extra field of the same type.voidaddExtraField(ZipExtraField ze)Adds an extra field - replacing an already present extra field of the same type.java.lang.Objectclone()Overwrite clone.booleanequals(java.lang.Object obj)byte[]getCentralDirectoryExtra()Retrieves the extra data for the central directory.longgetExternalAttributes()Retrieves the external file attributes.ZipExtraFieldgetExtraField(ZipShort type)Looks up an extra field by its header id.ZipExtraField[]getExtraFields()Retrieves all extra fields that have been parsed successfully.ZipExtraField[]getExtraFields(boolean includeUnparseable)Retrieves extra fields.GeneralPurposeBitgetGeneralPurposeBit()The "general purpose bit" field.intgetInternalAttributes()Retrieves the internal file attributes.java.util.DategetLastModifiedDate()byte[]getLocalFileDataExtra()Retrieves the extra data for the local file data.intgetMethod()Returns the compression method of this entry, or -1 if the compression method has not been specified.java.lang.StringgetName()Get the name of the entry.intgetPlatform()Platform specification to put into the "version made by" part of the central file header.byte[]getRawName()Returns the raw bytes that made up the name before it has been converted using the configured or guessed encoding.longgetSize()Gets the uncompressed size of the entry data.intgetUnixMode()Unix permission.UnparseableExtraFieldDatagetUnparseableExtraFieldData()Looks up extra field data that couldn't be parsed correctly.inthashCode()Get the hashCode of the entry.booleanisDirectory()Is this entry a directory?voidremoveExtraField(ZipShort type)Remove an extra field.voidremoveUnparseableExtraFieldData()Removes unparseable extra field data.voidsetCentralDirectoryExtra(byte[] b)Sets the central directory part of extra fields.voidsetComprSize(long size)Deprecated.since 1.7.voidsetExternalAttributes(long value)Sets the external file attributes.protected voidsetExtra()Unfortunatelyjava.util.zip.ZipOutputStreamseems to access the extra data directly, so overriding getExtra doesn't help - we need to modify super's data directly.voidsetExtra(byte[] extra)Parses the given bytes as extra field data and consumes any unparseable data as anUnparseableExtraFieldDatainstance.voidsetExtraFields(ZipExtraField[] fields)Replaces all currently attached extra fields with the new array.voidsetGeneralPurposeBit(GeneralPurposeBit b)The "general purpose bit" field.voidsetInternalAttributes(int value)Sets the internal file attributes.voidsetMethod(int method)Sets the compression method of this entry.protected voidsetName(java.lang.String name)Set the name of the entry.protected voidsetName(java.lang.String name, byte[] rawName)Sets the name using the raw bytes and the string created from it by guessing or using the configured encoding.protected voidsetPlatform(int platform)Set the platform (UNIX or FAT).voidsetSize(long size)Sets the uncompressed size of the entry data.voidsetUnixMode(int mode)Sets Unix permissions in a way that is understood by Info-Zip's unzip command.Methods inherited from class java.util.zip.ZipEntry
getComment, getCompressedSize, getCrc, getCreationTime, getExtra, getLastAccessTime, getLastModifiedTime, getTime, getTimeLocal, setComment, setCompressedSize, setCrc, setCreationTime, setLastAccessTime, setLastModifiedTime, setTime, setTimeLocal, toString
-
Field Details
-
PLATFORM_UNIX
public static final int PLATFORM_UNIX- See Also:
- Constant Field Values
-
PLATFORM_FAT
public static final int PLATFORM_FAT- See Also:
- Constant Field Values
-
CRC_UNKNOWN
public static final int CRC_UNKNOWN- See Also:
- Constant Field Values
-
LOCSIG
public static final long LOCSIG- See Also:
- Constant Field Values
-
EXTSIG
public static final long EXTSIG- See Also:
- Constant Field Values
-
CENSIG
public static final long CENSIG- See Also:
- Constant Field Values
-
ENDSIG
public static final long ENDSIG- See Also:
- Constant Field Values
-
LOCHDR
public static final int LOCHDR- See Also:
- Constant Field Values
-
EXTHDR
public static final int EXTHDR- See Also:
- Constant Field Values
-
CENHDR
public static final int CENHDR- See Also:
- Constant Field Values
-
ENDHDR
public static final int ENDHDR- See Also:
- Constant Field Values
-
LOCVER
public static final int LOCVER- See Also:
- Constant Field Values
-
LOCFLG
public static final int LOCFLG- See Also:
- Constant Field Values
-
LOCHOW
public static final int LOCHOW- See Also:
- Constant Field Values
-
LOCTIM
public static final int LOCTIM- See Also:
- Constant Field Values
-
LOCCRC
public static final int LOCCRC- See Also:
- Constant Field Values
-
LOCSIZ
public static final int LOCSIZ- See Also:
- Constant Field Values
-
LOCLEN
public static final int LOCLEN- See Also:
- Constant Field Values
-
LOCNAM
public static final int LOCNAM- See Also:
- Constant Field Values
-
LOCEXT
public static final int LOCEXT- See Also:
- Constant Field Values
-
EXTCRC
public static final int EXTCRC- See Also:
- Constant Field Values
-
EXTSIZ
public static final int EXTSIZ- See Also:
- Constant Field Values
-
EXTLEN
public static final int EXTLEN- See Also:
- Constant Field Values
-
CENVEM
public static final int CENVEM- See Also:
- Constant Field Values
-
CENVER
public static final int CENVER- See Also:
- Constant Field Values
-
CENFLG
public static final int CENFLG- See Also:
- Constant Field Values
-
CENHOW
public static final int CENHOW- See Also:
- Constant Field Values
-
CENTIM
public static final int CENTIM- See Also:
- Constant Field Values
-
CENCRC
public static final int CENCRC- See Also:
- Constant Field Values
-
CENSIZ
public static final int CENSIZ- See Also:
- Constant Field Values
-
CENLEN
public static final int CENLEN- See Also:
- Constant Field Values
-
CENNAM
public static final int CENNAM- See Also:
- Constant Field Values
-
CENEXT
public static final int CENEXT- See Also:
- Constant Field Values
-
CENCOM
public static final int CENCOM- See Also:
- Constant Field Values
-
CENDSK
public static final int CENDSK- See Also:
- Constant Field Values
-
CENATT
public static final int CENATT- See Also:
- Constant Field Values
-
CENATX
public static final int CENATX- See Also:
- Constant Field Values
-
CENOFF
public static final int CENOFF- See Also:
- Constant Field Values
-
ENDSUB
public static final int ENDSUB- See Also:
- Constant Field Values
-
ENDTOT
public static final int ENDTOT- See Also:
- Constant Field Values
-
ENDSIZ
public static final int ENDSIZ- See Also:
- Constant Field Values
-
ENDOFF
public static final int ENDOFF- See Also:
- Constant Field Values
-
ENDCOM
public static final int ENDCOM- See Also:
- Constant Field Values
-
-
Constructor Details
-
ZipEntry
public ZipEntry(java.lang.String name)Creates a new zip entry with the specified name.Assumes the entry represents a directory if and only if the name ends with a forward slash "/".
- Parameters:
name- the name of the entry- Since:
- 1.1
-
ZipEntry
public ZipEntry(java.util.zip.ZipEntry entry) throws java.util.zip.ZipExceptionCreates a new zip entry with fields taken from the specified zip entry.Assumes the entry represents a directory if and only if the name ends with a forward slash "/".
- Parameters:
entry- the entry to get fields from- Throws:
java.util.zip.ZipException- on error- Since:
- 1.1
-
ZipEntry
Creates a new zip entry with fields taken from the specified zip entry.Assumes the entry represents a directory if and only if the name ends with a forward slash "/".
- Parameters:
entry- the entry to get fields from- Throws:
java.util.zip.ZipException- on error- Since:
- 1.1
-
ZipEntry
protected ZipEntry()- Since:
- 1.9
-
ZipEntry
public ZipEntry(java.io.File inputFile, java.lang.String entryName)Creates a new zip entry taking some information from the given file and using the provided name.The name will be adjusted to end with a forward slash "/" if the file is a directory. If the file is not a directory a potential trailing forward slash will be stripped from the entry name.
- Parameters:
inputFile- FileentryName- String
-
-
Method Details
-
clone
public java.lang.Object clone()Overwrite clone.- Overrides:
clonein classjava.util.zip.ZipEntry- Returns:
- a cloned copy of this ZipEntry
- Since:
- 1.1
-
getMethod
public int getMethod()Returns the compression method of this entry, or -1 if the compression method has not been specified.- Overrides:
getMethodin classjava.util.zip.ZipEntry- Returns:
- compression method
-
setMethod
public void setMethod(int method)Sets the compression method of this entry.- Overrides:
setMethodin classjava.util.zip.ZipEntry- Parameters:
method- compression method
-
getInternalAttributes
public int getInternalAttributes()Retrieves the internal file attributes.- Returns:
- the internal file attributes
- Since:
- 1.1
-
setInternalAttributes
public void setInternalAttributes(int value)Sets the internal file attributes.- Parameters:
value- anintvalue- Since:
- 1.1
-
getExternalAttributes
public long getExternalAttributes()Retrieves the external file attributes.- Returns:
- the external file attributes
- Since:
- 1.1
-
setExternalAttributes
public void setExternalAttributes(long value)Sets the external file attributes.- Parameters:
value- anlongvalue- Since:
- 1.1
-
setUnixMode
public void setUnixMode(int mode)Sets Unix permissions in a way that is understood by Info-Zip's unzip command.- Parameters:
mode- anintvalue- Since:
- Ant 1.5.2
-
getUnixMode
public int getUnixMode()Unix permission.- Returns:
- the unix permissions
- Since:
- Ant 1.6
-
getPlatform
public int getPlatform()Platform specification to put into the "version made by" part of the central file header.- Returns:
- PLATFORM_FAT unless
setUnixModehas been called, in which case PLATFORM_UNIX will be returned. - Since:
- Ant 1.5.2
-
setPlatform
protected void setPlatform(int platform)Set the platform (UNIX or FAT).- Parameters:
platform- anintvalue - 0 is FAT, 3 is UNIX- Since:
- 1.9
-
setExtraFields
Replaces all currently attached extra fields with the new array.- Parameters:
fields- an array of extra fields- Since:
- 1.1
-
getExtraFields
Retrieves all extra fields that have been parsed successfully.- Returns:
- an array of the extra fields
-
getExtraFields
Retrieves extra fields.- Parameters:
includeUnparseable- whether to also return unparseable extra fields asUnparseableExtraFieldDataif such data exists.- Returns:
- an array of the extra fields
- Since:
- 1.1
-
addExtraField
Adds an extra field - replacing an already present extra field of the same type.If no extra field of the same type exists, the field will be added as last field.
- Parameters:
ze- an extra field- Since:
- 1.1
-
addAsFirstExtraField
Adds an extra field - replacing an already present extra field of the same type.The new extra field will be the first one.
- Parameters:
ze- an extra field- Since:
- 1.1
-
removeExtraField
Remove an extra field.- Parameters:
type- the type of extra field to remove- Since:
- 1.1
-
removeUnparseableExtraFieldData
public void removeUnparseableExtraFieldData()Removes unparseable extra field data. -
getExtraField
Looks up an extra field by its header id.- Parameters:
type- ZipShort- Returns:
- null if no such field exists.
-
getUnparseableExtraFieldData
Looks up extra field data that couldn't be parsed correctly.- Returns:
- null if no such field exists.
-
setExtra
public void setExtra(byte[] extra) throws java.lang.RuntimeExceptionParses the given bytes as extra field data and consumes any unparseable data as anUnparseableExtraFieldDatainstance.- Overrides:
setExtrain classjava.util.zip.ZipEntry- Parameters:
extra- an array of bytes to be parsed into extra fields- Throws:
java.lang.RuntimeException- if the bytes cannot be parsedjava.lang.RuntimeException- on error- Since:
- 1.1
-
setExtra
protected void setExtra()Unfortunatelyjava.util.zip.ZipOutputStreamseems to access the extra data directly, so overriding getExtra doesn't help - we need to modify super's data directly.- Since:
- 1.1
-
setCentralDirectoryExtra
public void setCentralDirectoryExtra(byte[] b)Sets the central directory part of extra fields.- Parameters:
b- boolean
-
getLocalFileDataExtra
public byte[] getLocalFileDataExtra()Retrieves the extra data for the local file data.- Returns:
- the extra data for local file
- Since:
- 1.1
-
getCentralDirectoryExtra
public byte[] getCentralDirectoryExtra()Retrieves the extra data for the central directory.- Returns:
- the central directory extra data
- Since:
- 1.1
-
setComprSize
@Deprecated public void setComprSize(long size)Deprecated.since 1.7. Use setCompressedSize directly.Make this class work in JDK 1.1 like a 1.2 class.This either stores the size for later usage or invokes setCompressedSize via reflection.
- Parameters:
size- the size to use- Since:
- 1.2
-
getName
public java.lang.String getName()Get the name of the entry.- Overrides:
getNamein classjava.util.zip.ZipEntry- Returns:
- the entry name
- Since:
- 1.9
-
isDirectory
public boolean isDirectory()Is this entry a directory?- Overrides:
isDirectoryin classjava.util.zip.ZipEntry- Returns:
- true if the entry is a directory
- Since:
- 1.10
-
setName
protected void setName(java.lang.String name)Set the name of the entry.- Parameters:
name- the name to use
-
getSize
public long getSize()Gets the uncompressed size of the entry data.- Overrides:
getSizein classjava.util.zip.ZipEntry- Returns:
- the entry size
-
setSize
public void setSize(long size)Sets the uncompressed size of the entry data.- Overrides:
setSizein classjava.util.zip.ZipEntry- Parameters:
size- the uncompressed size in bytes- Throws:
java.lang.IllegalArgumentException- if the specified size is less than 0
-
setName
protected void setName(java.lang.String name, byte[] rawName)Sets the name using the raw bytes and the string created from it by guessing or using the configured encoding.- Parameters:
name- the name to use created from the raw bytes using the guessed or configured encodingrawName- the bytes originally read as name from the archive
-
getRawName
public byte[] getRawName()Returns the raw bytes that made up the name before it has been converted using the configured or guessed encoding.This method will return null if this instance has not been read from an archive.
- Returns:
- byte[]
-
hashCode
public int hashCode()Get the hashCode of the entry. This uses the name as the hashcode.- Overrides:
hashCodein classjava.util.zip.ZipEntry- Returns:
- a hashcode.
- Since:
- Ant 1.7
-
getGeneralPurposeBit
The "general purpose bit" field.- Returns:
- GeneralPurposeBit
-
setGeneralPurposeBit
The "general purpose bit" field.- Parameters:
b- GeneralPurposeBit
-
getLastModifiedDate
public java.util.Date getLastModifiedDate() -
equals
public boolean equals(java.lang.Object obj)- Overrides:
equalsin classjava.lang.Object
-