ZipEntry (TrueZIP Driver ZIP 7.4.1 API)

java.lang.Object
- de.schlichtherle.truezip.zip.ZipEntry

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ZipArchiveEntry
```
@NotThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public class ZipEntry
extends Object
implements Cloneable
```
Drop-in replacement for java.util.zip.ZipEntry. For every numeric property of this class, the default value is UNKNOWN in order to indicate an unknown state and it's permitted to set this value explicitly in order to reset the property.
Note that a ZipEntry object can be used with only one ZipFile or ZipOutputStream instance. Reusing the same ZipEntry object with a second object of these classes is an error and may result in unpredictable behaviour.
In general, this class is not thread-safe. However, it is safe to call only the getters of this class from multiple threads concurrently.

Author:

Christian Schlichtherle

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BZIP2` Method for BZIP2 compressed entries.
`private String`	`comment` Comment field.
`private int`	`crc`
`private static int`	`CRC`
`private long`	`csize`
`static int`	`DEFLATED` Method for Deflated compressed entries.
`private int`	`dtime`
`private static int`	`DTIME`
`private int`	`eattr`
`private static int`	`EATTR`
`private ExtraFields`	`fields` The map of Extra Fields.
`private short`	`general`
`(package private) static int`	`GPBF_DATA_DESCRIPTOR`
`(package private) static int`	`GPBF_ENCRYPTED` General Purpose Bit Flag mask for encrypted data.
`(package private) static int`	`GPBF_UTF8`
`private byte`	`init`
`static long`	`MAX_DOS_TIME` Largest supported DOS date/time value in a ZIP file, which is December 31^st, 2107 AD 23:59:58 local time.
`private short`	`method`
`private static int`	`METHOD`
`static long`	`MIN_DOS_TIME` Smallest supported DOS date/time value in a ZIP file, which is January 1^st, 1980 AD 00:00:00 local time.
`private String`	`name`
`private long`	`offset` Relative Offset Of Local File Header.
`private byte`	`platform`
`private static int`	`PLATFORM`
`static short`	`PLATFORM_FAT` Windows platform.
`static short`	`PLATFORM_UNIX` Unix platform.
`private long`	`size`
`static int`	`STORED` Method for Stored (uncompressed) entries.
`static byte`	`UNKNOWN` The unknown value for numeric properties.
`(package private) static int`	`WINZIP_AES` Pseudo compression method for WinZip AES encrypted entries.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`ZipEntry(String name)` Constructs a new ZIP entry with the given name.
`protected`	`ZipEntry(String name, ZipEntry template)` Constructs a new ZIP entry with the given name and all other properties copied from the given template.

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) ExtraField`	`addExtraField(ExtraField field)`
`void`	`clearEncryption()` Sets the encryption property to `false` and removes any other encryption artifacts, e.g. a WinZip AES extra field.
`ZipEntry`	`clone()`
`private ExtraField`	`composeZip64ExtraField()` Composes a ZIP64 Extended Information Extra Field from the properties of this entry.
`String`	`getComment()`
`long`	`getCompressedSize()` Returns the compressed size of this entry.
`long`	`getCrc()`
`protected DateTimeConverter`	`getDateTimeConverter()` Returns a `DateTimeConverter` for the conversion of Java time to DOS date/time fields and vice versa.
`long`	`getExternalAttributes()` Returns the external file attributes.
`byte[]`	`getExtra()` Returns a protective copy of the serialized Extra Fields.
`(package private) ExtraField`	`getExtraField(int headerId)`
`private byte[]`	`getExtraFields(boolean zip64)`
`(package private) boolean`	`getGeneralPurposeBitFlag(int mask)` Returns the indexed General Purpose Bit Flag.
`(package private) int`	`getGeneralPurposeBitFlags()` Returns the General Purpose Bit Flags.
`int`	`getMethod()` Returns the compression method for this entry.
`String`	`getName()` Returns the ZIP entry name.
`(package private) long`	`getOffset()`
`short`	`getPlatform()`
`(package private) String`	`getRawComment()`
`(package private) long`	`getRawCompressedSize()`
`(package private) long`	`getRawCrc()`
`(package private) long`	`getRawExternalAttributes()`
`(package private) byte[]`	`getRawExtraFields()` Returns a protective copy of the serialized Extra Fields.
`(package private) int`	`getRawMethod()`
`(package private) long`	`getRawOffset()`
`(package private) short`	`getRawPlatform()`
`(package private) long`	`getRawSize()`
`(package private) long`	`getRawTime()`
`(package private) int`	`getRawVersionNeededToExtract()`
`long`	`getSize()` Returns the uncompressed size of this entry.
`long`	`getTime()`
`(package private) boolean`	`isDataDescriptorRequired()`
`boolean`	`isDirectory()` Returns true if and only if this ZIP entry represents a directory entry (i.e. end with `'/'`).
`boolean`	`isEncrypted()` Returns `true` if and only if this ZIP entry is encrypted.
`private boolean`	`isInit(int mask)`
`(package private) boolean`	`isZip64ExtensionsRequired()`
`private void`	`parseZip64ExtraField()` Parses the properties of this entry from the ZIP64 Extended Information Extra Field, if present.
`(package private) ExtraField`	`removeExtraField(int headerId)`
`void`	`setComment(String comment)` Sets the entry comment.
`void`	`setCompressedSize(long csize)` Sets the compressed size of this entry.
`void`	`setCrc(long crc)`
`void`	`setEncrypted(boolean encrypted)` Sets the encryption flag for this ZIP entry.
`void`	`setExternalAttributes(long eattr)` Sets the external file attributes.
`void`	`setExtra(byte[] data)` Sets the serialized Extra Fields by making a protective copy.
`private void`	`setExtraFields(byte[] data, boolean zip64)`
`(package private) void`	`setGeneralPurposeBitFlag(int mask, boolean bit)` Sets the indexed General Purpose Bit Flag.
`(package private) void`	`setGeneralPurposeBitFlags(int general)` Sets the General Purpose Bit Flags.
`private void`	`setInit(int mask, boolean init)`
`void`	`setMethod(int method)` Sets the compression method for this entry.
`void`	`setPlatform(short platform)`
`(package private) void`	`setRawComment(String comment)`
`(package private) void`	`setRawCompressedSize(long csize)`
`(package private) void`	`setRawCrc(long crc)`
`(package private) void`	`setRawExternalAttributes(long eattr)`
`(package private) void`	`setRawExtraFields(byte[] data)` Sets extra fields and parses ZIP64 extra field.
`(package private) void`	`setRawMethod(int method)`
`(package private) void`	`setRawOffset(long offset)`
`(package private) void`	`setRawPlatform(int platform)`
`(package private) void`	`setRawSize(long size)`
`(package private) void`	`setRawTime(long dtime)`
`void`	`setSize(long size)` Sets the uncompressed size of this entry.
`void`	`setTime(long jtime)`
`String`	`toString()` Returns a string representation of this object for debugging and logging purposes.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BZIP2
```
public static final int BZIP2
```
    Method for BZIP2 compressed entries.
    
    Since:
    
    TrueZIP 7.3
    
    See Also:
    setMethod(int), Constant Field Values
  - comment
```
@CheckForNull
private String comment
```
    Comment field.
  - crc
```
private int crc
```
  - CRC
```
private static final int CRC
```
    See Also:
    Constant Field Values
  - csize
```
private long csize
```
  - DEFLATED
```
public static final int DEFLATED
```
    Method for Deflated compressed entries.
    
    See Also:
    setMethod(int), Constant Field Values
  - dtime
```
private int dtime
```
  - DTIME
```
private static final int DTIME
```
    See Also:
    Constant Field Values
  - eattr
```
private int eattr
```
  - EATTR
```
private static final int EATTR
```
    See Also:
    Constant Field Values
  - fields
```
@CheckForNull
private ExtraFields fields
```
    The map of Extra Fields. Maps from Header ID [Integer] to Extra Field [ExtraField]. Should be null or may be empty if no Extra Fields are used.
  - general
```
private short general
```
  - GPBF_DATA_DESCRIPTOR
```
static int GPBF_DATA_DESCRIPTOR
```
  - GPBF_ENCRYPTED
```
static int GPBF_ENCRYPTED
```
    General Purpose Bit Flag mask for encrypted data.
  - GPBF_UTF8
```
static int GPBF_UTF8
```
  - init
```
private byte init
```
  - MAX_DOS_TIME
```
public static final long MAX_DOS_TIME
```
    Largest supported DOS date/time value in a ZIP file, which is December 31^st, 2107 AD 23:59:58 local time.
    
    See Also:
    Constant Field Values
  - method
```
private short method
```
  - METHOD
```
private static final int METHOD
```
    See Also:
    Constant Field Values
  - MIN_DOS_TIME
```
public static final long MIN_DOS_TIME
```
    Smallest supported DOS date/time value in a ZIP file, which is January 1^st, 1980 AD 00:00:00 local time.
    
    See Also:
    Constant Field Values
  - name
```
private String name
```
  - offset
```
private long offset
```
    Relative Offset Of Local File Header.
  - platform
```
private byte platform
```
  - PLATFORM
```
private static final int PLATFORM
```
    See Also:
    Constant Field Values
  - PLATFORM_FAT
```
public static final short PLATFORM_FAT
```
    Windows platform.
    
    See Also:
    Constant Field Values
  - PLATFORM_UNIX
```
public static final short PLATFORM_UNIX
```
    Unix platform.
    
    See Also:
    Constant Field Values
  - size
```
private long size
```
  - STORED
```
public static final int STORED
```
    Method for Stored (uncompressed) entries.
    
    See Also:
    setMethod(int), Constant Field Values
  - UNKNOWN
```
public static final byte UNKNOWN
```
    The unknown value for numeric properties.
    
    See Also:
    Constant Field Values
  - WINZIP_AES
```
static final int WINZIP_AES
```
    Pseudo compression method for WinZip AES encrypted entries.
    
    Since:
    
    TrueZIP 7.3
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ZipEntry
```
public ZipEntry(String name)
```
    Constructs a new ZIP entry with the given name.
  - ZipEntry
```
protected ZipEntry(String name,
        ZipEntry template)
```
    Constructs a new ZIP entry with the given name and all other properties copied from the given template.
- Method Detail
  - addExtraField
```
@Nullable
final ExtraField addExtraField(ExtraField field)
```
  - clearEncryption
```
public final void clearEncryption()
```
    Sets the encryption property to false and removes any other encryption artifacts, e.g. a WinZip AES extra field.
    
    Since:
    
    TrueZIP 7.4
    
    See Also:
    #TRUEZIP-176
  - clone
```
public ZipEntry clone()
```
    Overrides:
    
    clone in class Object
  - composeZip64ExtraField
```
@CheckForNull
private ExtraField composeZip64ExtraField()
```
    Composes a ZIP64 Extended Information Extra Field from the properties of this entry. If no ZIP64 Extended Information Extra Field is required it is removed from the collection of Extra Fields.
  - getComment
```
@CheckForNull
public final String getComment()
```
  - getCompressedSize
```
public final long getCompressedSize()
```
    Returns the compressed size of this entry.
    
    See Also:
    setCompressedSize(long)
  - getCrc
```
public final long getCrc()
```
  - getDateTimeConverter
```
protected DateTimeConverter getDateTimeConverter()
```
    Returns a DateTimeConverter for the conversion of Java time to DOS date/time fields and vice versa.
    The implementation in the class ZipEntry returns DateTimeConverter.JAR.
    
    Returns:
    A DateTimeConverter - never null.
    See Also:
    DateTimeConverter
  - getExternalAttributes
```
public final long getExternalAttributes()
```
    Returns the external file attributes.
    
    Returns:
    The external file attributes.
    Since:
    
    TrueZIP 7.3
  - getExtra
```
public final byte[] getExtra()
```
    Returns a protective copy of the serialized Extra Fields. Note that unlike its template ZipEntry.getExtra(), this method never returns null.
    
    Returns:
    A new byte array holding the serialized Extra Fields. null is never returned.
  - getExtraField
```
@Nullable
final ExtraField getExtraField(int headerId)
```
  - getExtraFields
```
private byte[] getExtraFields(boolean zip64)
```
  - getGeneralPurposeBitFlag
```
final boolean getGeneralPurposeBitFlag(int mask)
```
    Returns the indexed General Purpose Bit Flag.
  - getGeneralPurposeBitFlags
```
final int getGeneralPurposeBitFlags()
```
    Returns the General Purpose Bit Flags.
  - getMethod
```
public final int getMethod()
```
    Returns the compression method for this entry.
    
    See Also:
    setMethod(int), ZipOutputStream.getMethod()
  - getName
```
public final String getName()
```
    Returns the ZIP entry name.
  - getOffset
```
final long getOffset()
```
  - getPlatform
```
public final short getPlatform()
```
  - getRawComment
```
final String getRawComment()
```
  - getRawCompressedSize
```
final long getRawCompressedSize()
```
  - getRawCrc
```
final long getRawCrc()
```
  - getRawExternalAttributes
```
final long getRawExternalAttributes()
```
  - getRawExtraFields
```
final byte[] getRawExtraFields()
```
    Returns a protective copy of the serialized Extra Fields.
    
    Returns:
    A new byte array holding the serialized Extra Fields. null is never returned.
    See Also:
    getRawExtraFields()
  - getRawMethod
```
final int getRawMethod()
```
  - getRawOffset
```
final long getRawOffset()
```
  - getRawPlatform
```
final short getRawPlatform()
```
  - getRawSize
```
final long getRawSize()
```
  - getRawTime
```
final long getRawTime()
```
  - getRawVersionNeededToExtract
```
final int getRawVersionNeededToExtract()
```
  - getSize
```
public final long getSize()
```
    Returns the uncompressed size of this entry.
    
    See Also:
    setCompressedSize(long)
  - getTime
```
public final long getTime()
```
  - isDataDescriptorRequired
```
final boolean isDataDescriptorRequired()
```
  - isDirectory
```
public final boolean isDirectory()
```
    Returns true if and only if this ZIP entry represents a directory entry (i.e. end with '/').
  - isEncrypted
```
public final boolean isEncrypted()
```
    Returns true if and only if this ZIP entry is encrypted. Note that only WinZip AES encryption is currently supported.
    
    Returns:
    true if and only if this ZIP entry is encrypted.
    Since:
    
    TrueZIP 7.3
  - isInit
```
private boolean isInit(int mask)
```
  - isZip64ExtensionsRequired
```
final boolean isZip64ExtensionsRequired()
```
  - parseZip64ExtraField
```
private void parseZip64ExtraField()
```
    Parses the properties of this entry from the ZIP64 Extended Information Extra Field, if present. The ZIP64 Extended Information Extra Field is not removed.
  - removeExtraField
```
@Nullable
final ExtraField removeExtraField(int headerId)
```
  - setComment
```
public final void setComment(@CheckForNull
              String comment)
```
    Sets the entry comment. Note that this method limits the comment size to 64 KB. Therefore, this property should not be used to hold arbitrary (application) data. Consider storing such data in a separate entry instead.
    
    Parameters:
    comment - The entry comment.
    
    Throws:
    
    RuntimeException - if the entry comment exceeds 64 KB.
  - setCompressedSize
```
public final void setCompressedSize(long csize)
```
    Sets the compressed size of this entry.
    
    Parameters:
    csize - The Compressed Size.
    
    Throws:
    
    IllegalArgumentException - If csize is not in the range from 0 to ULong.MAX_VALUE (9223372036854775807L).
    See Also:
    getCompressedSize()
  - setCrc
```
public final void setCrc(long crc)
```
  - setEncrypted
```
public final void setEncrypted(boolean encrypted)
```
    Sets the encryption flag for this ZIP entry. If you set this to true, you will also need to provide crypto parameters.
    Note that only WinZip AES encryption is currently supported.
    
    Parameters:
    encrypted - whether or not this ZIP entry should get encrypted.
    Since:
    
    TrueZIP 7.3
  - setExternalAttributes
```
public final void setExternalAttributes(long eattr)
```
    Sets the external file attributes.
    
    Parameters:
    eattr - the external file attributes.
    Since:
    
    TrueZIP 7.3
  - setExtra
```
public final void setExtra(@CheckForNull
            byte[] data)
```
    Sets the serialized Extra Fields by making a protective copy. Note that this method parses the serialized Extra Fields according to the ZIP File Format Specification and limits its size to 64 KB. Therefore, this property cannot not be used to hold arbitrary (application) data. Consider storing such data in a separate entry instead.
    
    Parameters:
    data - The byte array holding the serialized Extra Fields.
    
    Throws:
    
    RuntimeException - if the serialized Extra Fields exceed 64 KB or do not conform to the ZIP File Format Specification
  - setExtraFields
```
private void setExtraFields(byte[] data,
                  boolean zip64)
```
  - setGeneralPurposeBitFlag
```
final void setGeneralPurposeBitFlag(int mask,
                            boolean bit)
```
    Sets the indexed General Purpose Bit Flag.
  - setGeneralPurposeBitFlags
```
final void setGeneralPurposeBitFlags(int general)
```
    Sets the General Purpose Bit Flags.
  - setInit
```
private void setInit(int mask,
           boolean init)
```
  - setMethod
```
public final void setMethod(int method)
```
    Sets the compression method for this entry.
    
    Throws:
    
    IllegalArgumentException - If method is not STORED, DEFLATED, BZIP2 or UNKNOWN.
    See Also:
    getMethod(), ZipOutputStream.setMethod(int)
  - setPlatform
```
public final void setPlatform(short platform)
```
  - setRawComment
```
final void setRawComment(String comment)
```
  - setRawCompressedSize
```
final void setRawCompressedSize(long csize)
```
  - setRawCrc
```
final void setRawCrc(long crc)
```
  - setRawExternalAttributes
```
final void setRawExternalAttributes(long eattr)
```
  - setRawExtraFields
```
final void setRawExtraFields(byte[] data)
```
    Sets extra fields and parses ZIP64 extra field. This method must not get called before the uncompressed size, compressed size and offset have been initialized!
  - setRawMethod
```
final void setRawMethod(int method)
```
  - setRawOffset
```
final void setRawOffset(long offset)
```
  - setRawPlatform
```
final void setRawPlatform(int platform)
```
  - setRawSize
```
final void setRawSize(long size)
```
  - setRawTime
```
final void setRawTime(long dtime)
```
  - setSize
```
public final void setSize(long size)
```
    Sets the uncompressed size of this entry.
    
    Parameters:
    size - The (Uncompressed) Size.
    
    Throws:
    
    IllegalArgumentException - If size is not in the range from 0 to ULong.MAX_VALUE (9223372036854775807L).
    See Also:
    getCompressedSize()
  - setTime
```
public final void setTime(long jtime)
```
  - toString
```
public String toString()
```
    Returns a string representation of this object for debugging and logging purposes.
    
    Overrides:
    
    toString in class Object

Class ZipEntry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BZIP2

comment

crc

CRC

csize

DEFLATED

dtime

DTIME

eattr

EATTR

fields

general

GPBF_DATA_DESCRIPTOR

GPBF_ENCRYPTED

GPBF_UTF8

init

MAX_DOS_TIME

method

METHOD

MIN_DOS_TIME

name

offset

platform

PLATFORM

PLATFORM_FAT

PLATFORM_UNIX

size

STORED

UNKNOWN

WINZIP_AES

Constructor Detail

ZipEntry

ZipEntry

Method Detail

addExtraField

clearEncryption

clone

composeZip64ExtraField

getComment

getCompressedSize

getCrc

getDateTimeConverter

getExternalAttributes

getExtra

getExtraField

getExtraFields

getGeneralPurposeBitFlag

getGeneralPurposeBitFlags

getMethod

getName

getOffset

getPlatform

getRawComment

getRawCompressedSize

getRawCrc

getRawExternalAttributes

getRawExtraFields

getRawMethod

getRawOffset

getRawPlatform

getRawSize

getRawTime

getRawVersionNeededToExtract

getSize

getTime

isDataDescriptorRequired

isDirectory

isEncrypted

isInit

isZip64ExtensionsRequired

parseZip64ExtraField

removeExtraField

setComment

setCompressedSize