public class ZipArchiveEntry extends java.util.zip.ZipEntry implements ArchiveEntry, java.lang.Cloneable
The extra data is expected to follow the recommendation of APPNOTE.txt:
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. Versions prior to Apache Commons Compress 1.1 would have thrown an exception if any attempt was made to read or write extra data not conforming to the recommendation.
Modifier and Type | Field and Description |
---|---|
static int |
CENATT |
static int |
CENATX |
static int |
CENCOM |
static int |
CENCRC |
static int |
CENDSK |
static int |
CENEXT |
static int |
CENFLG |
static int |
CENHDR |
static int |
CENHOW |
static int |
CENLEN |
static int |
CENNAM |
static int |
CENOFF |
static long |
CENSIG |
static int |
CENSIZ |
static int |
CENTIM |
static int |
CENVEM |
static int |
CENVER |
static int |
ENDCOM |
static int |
ENDHDR |
static int |
ENDOFF |
static long |
ENDSIG |
static int |
ENDSIZ |
static int |
ENDSUB |
static int |
ENDTOT |
static int |
EXTCRC |
private long |
externalAttributes |
static int |
EXTHDR |
static int |
EXTLEN |
private java.util.LinkedHashMap |
extraFields |
static long |
EXTSIG |
static int |
EXTSIZ |
private GeneralPurposeBit |
gpb |
private int |
internalAttributes |
static int |
LOCCRC |
static int |
LOCEXT |
static int |
LOCFLG |
static int |
LOCHDR |
static int |
LOCHOW |
static int |
LOCLEN |
static int |
LOCNAM |
static long |
LOCSIG |
static int |
LOCSIZ |
static int |
LOCTIM |
static int |
LOCVER |
private int |
method
The
ZipEntry base class only supports
the compression methods STORED and DEFLATED. |
private java.lang.String |
name |
private int |
platform |
static int |
PLATFORM_FAT |
static int |
PLATFORM_UNIX |
private static int |
SHORT_MASK |
private static int |
SHORT_SHIFT |
private UnparseableExtraFieldData |
unparseableExtra |
SIZE_UNKNOWN
Modifier | Constructor and Description |
---|---|
protected |
ZipArchiveEntry() |
|
ZipArchiveEntry(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.
|
|
ZipArchiveEntry(java.lang.String name)
Creates a new zip entry with the specified name.
|
|
ZipArchiveEntry(ZipArchiveEntry entry)
Creates a new zip entry with fields taken from the specified zip entry.
|
|
ZipArchiveEntry(java.util.zip.ZipEntry entry)
Creates a new zip entry with fields taken from the specified zip entry.
|
Modifier and Type | Method and Description |
---|---|
void |
addAsFirstExtraField(ZipExtraField ze)
Adds an extra field - replacing an already present extra field
of the same type.
|
void |
addExtraField(ZipExtraField ze)
Adds an extra field - replacing an already present extra field
of the same type.
|
java.lang.Object |
clone()
Overwrite clone.
|
boolean |
equals(java.lang.Object obj) |
byte[] |
getCentralDirectoryExtra()
Retrieves the extra data for the central directory.
|
long |
getExternalAttributes()
Retrieves the external file attributes.
|
ZipExtraField |
getExtraField(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.
|
GeneralPurposeBit |
getGeneralPurposeBit()
The "general purpose bit" field.
|
int |
getInternalAttributes()
Retrieves the internal file attributes.
|
java.util.Date |
getLastModifiedDate()
The last modified date of the entry.
|
byte[] |
getLocalFileDataExtra()
Retrieves the extra data for the local file data.
|
int |
getMethod()
Returns the compression method of this entry, or -1 if the
compression method has not been specified.
|
java.lang.String |
getName()
Get the name of the entry.
|
int |
getPlatform()
Platform specification to put into the "version made
by" part of the central file header.
|
int |
getUnixMode()
Unix permission.
|
UnparseableExtraFieldData |
getUnparseableExtraFieldData()
Looks up extra field data that couldn't be parsed correctly.
|
int |
hashCode()
Get the hashCode of the entry.
|
boolean |
isDirectory()
Is this entry a directory?
|
private void |
mergeExtraFields(ZipExtraField[] f,
boolean local)
If there are no extra fields, use the given fields as new extra
data - otherwise merge the fields assuming the existing fields
and the new fields stem from different locations inside the
archive.
|
void |
removeExtraField(ZipShort type)
Remove an extra field.
|
void |
removeUnparseableExtraFieldData()
Removes unparseable extra field data.
|
void |
setCentralDirectoryExtra(byte[] b)
Sets the central directory part of extra fields.
|
void |
setExternalAttributes(long value)
Sets the external file attributes.
|
protected void |
setExtra()
Unfortunately
java.util.zip.ZipOutputStream seems to access the extra data
directly, so overriding getExtra doesn't help - we need to
modify super's data directly. |
void |
setExtra(byte[] extra)
Parses the given bytes as extra field data and consumes any
unparseable data as an
UnparseableExtraFieldData
instance. |
void |
setExtraFields(ZipExtraField[] fields)
Replaces all currently attached extra fields with the new array.
|
void |
setGeneralPurposeBit(GeneralPurposeBit b)
The "general purpose bit" field.
|
void |
setInternalAttributes(int value)
Sets the internal file attributes.
|
void |
setMethod(int method)
Sets the compression method of this entry.
|
protected void |
setName(java.lang.String name)
Set the name of the entry.
|
protected void |
setPlatform(int platform)
Set the platform (UNIX or FAT).
|
void |
setUnixMode(int mode)
Sets Unix permissions in a way that is understood by Info-Zip's
unzip command.
|
getComment, getCompressedSize, getCrc, getExtra, getSize, getTime, setComment, setCompressedSize, setCrc, setSize, setTime, toString
finalize, getClass, notify, notifyAll, wait, wait, wait
getSize
public static final int PLATFORM_UNIX
public static final int PLATFORM_FAT
private static final int SHORT_MASK
private static final int SHORT_SHIFT
private int method
ZipEntry
base class only supports
the compression methods STORED and DEFLATED. We override the
field so that any compression methods can be used.
The default value -1 means that the method has not been specified.
private int internalAttributes
private int platform
private long externalAttributes
private java.util.LinkedHashMap extraFields
private UnparseableExtraFieldData unparseableExtra
private java.lang.String name
private GeneralPurposeBit gpb
public static final long LOCSIG
public static final long EXTSIG
public static final long CENSIG
public static final long ENDSIG
public static final int LOCHDR
public static final int EXTHDR
public static final int CENHDR
public static final int ENDHDR
public static final int LOCVER
public static final int LOCFLG
public static final int LOCHOW
public static final int LOCTIM
public static final int LOCCRC
public static final int LOCSIZ
public static final int LOCLEN
public static final int LOCNAM
public static final int LOCEXT
public static final int EXTCRC
public static final int EXTSIZ
public static final int EXTLEN
public static final int CENVEM
public static final int CENVER
public static final int CENFLG
public static final int CENHOW
public static final int CENTIM
public static final int CENCRC
public static final int CENSIZ
public static final int CENLEN
public static final int CENNAM
public static final int CENEXT
public static final int CENCOM
public static final int CENDSK
public static final int CENATT
public static final int CENATX
public static final int CENOFF
public static final int ENDSUB
public static final int ENDTOT
public static final int ENDSIZ
public static final int ENDOFF
public static final int ENDCOM
public ZipArchiveEntry(java.lang.String name)
Assumes the entry represents a directory if and only if the name ends with a forward slash "/".
name
- the name of the entrypublic ZipArchiveEntry(java.util.zip.ZipEntry entry) throws java.util.zip.ZipException
Assumes the entry represents a directory if and only if the name ends with a forward slash "/".
entry
- the entry to get fields fromjava.util.zip.ZipException
- on errorpublic ZipArchiveEntry(ZipArchiveEntry entry) throws java.util.zip.ZipException
Assumes the entry represents a directory if and only if the name ends with a forward slash "/".
entry
- the entry to get fields fromjava.util.zip.ZipException
- on errorprotected ZipArchiveEntry()
public ZipArchiveEntry(java.io.File inputFile, java.lang.String entryName)
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.
public java.lang.Object clone()
clone
in class java.util.zip.ZipEntry
public int getMethod()
getMethod
in class java.util.zip.ZipEntry
public void setMethod(int method)
setMethod
in class java.util.zip.ZipEntry
method
- compression methodpublic int getInternalAttributes()
public void setInternalAttributes(int value)
value
- an int
valuepublic long getExternalAttributes()
public void setExternalAttributes(long value)
value
- an long
valuepublic void setUnixMode(int mode)
mode
- an int
valuepublic int getUnixMode()
public int getPlatform()
setUnixMode
has been called, in which case PLATORM_UNIX will be returned.protected void setPlatform(int platform)
platform
- an int
value - 0 is FAT, 3 is UNIXpublic void setExtraFields(ZipExtraField[] fields)
fields
- an array of extra fieldspublic ZipExtraField[] getExtraFields()
public ZipExtraField[] getExtraFields(boolean includeUnparseable)
includeUnparseable
- whether to also return unparseable
extra fields as UnparseableExtraFieldData
if such data
exists.public void addExtraField(ZipExtraField ze)
If no extra field of the same type exists, the field will be added as last field.
ze
- an extra fieldpublic void addAsFirstExtraField(ZipExtraField ze)
The new extra field will be the first one.
ze
- an extra fieldpublic void removeExtraField(ZipShort type)
type
- the type of extra field to removepublic void removeUnparseableExtraFieldData()
public ZipExtraField getExtraField(ZipShort type)
public UnparseableExtraFieldData getUnparseableExtraFieldData()
public void setExtra(byte[] extra) throws java.lang.RuntimeException
UnparseableExtraFieldData
instance.setExtra
in class java.util.zip.ZipEntry
extra
- an array of bytes to be parsed into extra fieldsjava.lang.RuntimeException
- if the bytes cannot be parsedjava.lang.RuntimeException
- on errorprotected void setExtra()
java.util.zip.ZipOutputStream
seems to access the extra data
directly, so overriding getExtra doesn't help - we need to
modify super's data directly.public void setCentralDirectoryExtra(byte[] b)
public byte[] getLocalFileDataExtra()
public byte[] getCentralDirectoryExtra()
public java.lang.String getName()
getName
in interface ArchiveEntry
getName
in class java.util.zip.ZipEntry
public boolean isDirectory()
isDirectory
in interface ArchiveEntry
isDirectory
in class java.util.zip.ZipEntry
protected void setName(java.lang.String name)
name
- the name to usepublic int hashCode()
hashCode
in class java.util.zip.ZipEntry
public GeneralPurposeBit getGeneralPurposeBit()
public void setGeneralPurposeBit(GeneralPurposeBit b)
private void mergeExtraFields(ZipExtraField[] f, boolean local) throws java.util.zip.ZipException
f
- the extra fields to mergelocal
- whether the new fields originate from local datajava.util.zip.ZipException
public java.util.Date getLastModifiedDate()
getLastModifiedDate
in interface ArchiveEntry
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object