ZipEntry (TrueVFS 0.12.0 API)

java.lang.Object
- net.java.truevfs.comp.zip.ZipEntry

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AbstractZipDriverEntry
```
@NotThreadSafe
public class ZipEntry
extends Object
implements Cloneable
```
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.
`static int`	`DEFLATED` Method for Deflated compressed entries.
`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.
`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.
`static short`	`PLATFORM_FAT` Windows platform.
`static short`	`PLATFORM_UNIX` Unix platform.
`static int`	`STORED` Method for Stored (uncompressed) entries.
`static byte`	`UNKNOWN` The unknown value for numeric properties.

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearEncryption()` Sets the encryption property to `false` and removes any other encryption artifacts, e.g.
`ZipEntry`	`clone()`
`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.
`int`	`getMethod()` Returns the compression method for this entry.
`String`	`getName()` Returns the ZIP entry name.
`int`	`getPlatform()`
`long`	`getSize()` Returns the uncompressed size of this entry.
`long`	`getTime()`
`boolean`	`isDirectory()` Returns true if and only if this ZIP entry represents a directory entry (i.e.
`boolean`	`isEncrypted()` Returns `true` if and only if this ZIP entry is encrypted.
`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[] buf)` Sets the serialized extra fields by making a protective copy.
`void`	`setMethod(int method)` Sets the compression method for this entry.
`void`	`setPlatform(int platform)`
`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.
    
    See Also:
    
    setMethod(int), Constant Field Values
  - DEFLATED
```
public static final int DEFLATED
```
    Method for Deflated compressed entries.
    
    See Also:
    
    setMethod(int), Constant Field Values
  - 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
  - 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
  - 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
  - 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
- 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
  - clearEncryption
```
public final void clearEncryption()
```
    Sets the encryption property to false and removes any other encryption artifacts, e.g. a WinZip AES extra field.
    
    See Also:
    
    #TRUEZIP-176
  - clone
```
public ZipEntry clone()
```
    Overrides:
    
    clone in class Object
  - 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 for the conversion of Java time to DOS date/time fields and vice versa.
  - getExternalAttributes
```
public final long getExternalAttributes()
```
    Returns the external file attributes.
    
    Returns:
    
    The external file attributes.
  - 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.
  - getMethod
```
public final int getMethod()
```
    Returns the compression method for this entry.
    
    See Also:
    
    setMethod(int), AbstractZipOutputStream.getMethod()
  - getName
```
public final String getName()
```
    Returns the ZIP entry name.
  - getPlatform
```
public final int getPlatform()
```
  - getSize
```
public final long getSize()
```
    Returns the uncompressed size of this entry.
    
    See Also:
    
    setCompressedSize(long)
  - getTime
```
public final long getTime()
```
  - 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.
  - 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.
  - setExternalAttributes
```
public final void setExternalAttributes(long eattr)
```
    Sets the external file attributes.
    
    Parameters:
    
    eattr - the external file attributes.
  - setExtra
```
public final void setExtra(@CheckForNull
                           byte[] buf)
                    throws IllegalArgumentException
```
    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:
    
    buf - The byte array holding the serialized extra fields.
    
    Throws:
    
    IllegalArgumentException - if the serialized extra fields exceed 64 KB or do not conform to the ZIP File Format Specification.
  - 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(), AbstractZipOutputStream.setMethod(int)
  - setPlatform
```
public final void setPlatform(int platform)
```
  - 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

DEFLATED

MAX_DOS_TIME

MIN_DOS_TIME

PLATFORM_FAT

PLATFORM_UNIX

STORED

UNKNOWN

Constructor Detail

ZipEntry

ZipEntry

Method Detail

clearEncryption

clone

getComment

getCompressedSize

getCrc

getDateTimeConverter

getExternalAttributes

getExtra

getMethod

getName

getPlatform

getSize

getTime

isDirectory

isEncrypted

setComment

setCompressedSize

setCrc

setEncrypted

setExternalAttributes

setExtra

setMethod

setPlatform

setSize

setTime

toString