- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
JarEntry
public class ZipEntry extends Object implements Cloneable
- Since:
- 1.1
-
Field Summary
Fields Modifier and Type Field 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
DEFLATED
Compression method for compressed (deflated) entries.static int
ENDCOM
static int
ENDHDR
static int
ENDOFF
static long
ENDSIG
static int
ENDSIZ
static int
ENDSUB
static int
ENDTOT
static int
EXTCRC
static int
EXTHDR
static int
EXTLEN
static long
EXTSIG
static int
EXTSIZ
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
static int
STORED
Compression method for uncompressed entries. -
Constructor Summary
-
Method Summary
Modifier and Type Method Description Object
clone()
Returns a copy of this entry.String
getComment()
Returns the comment string for the entry.long
getCompressedSize()
Returns the size of the compressed entry data.long
getCrc()
Returns the CRC-32 checksum of the uncompressed entry data.FileTime
getCreationTime()
Returns the creation time of the entry.byte[]
getExtra()
Returns the extra field data for the entry.FileTime
getLastAccessTime()
Returns the last access time of the entry.FileTime
getLastModifiedTime()
Returns the last modification time of the entry.int
getMethod()
Returns the compression method of the entry.String
getName()
Returns the name of the entry.long
getSize()
Returns the uncompressed size of the entry data.long
getTime()
Returns the last modification time of the entry.LocalDateTime
getTimeLocal()
Returns the last modification time of the entry in local date-time.int
hashCode()
Returns the hash code value for this entry.boolean
isDirectory()
Returns true if this is a directory entry.void
setComment(String comment)
Sets the optional comment string for the entry.void
setCompressedSize(long csize)
Sets the size of the compressed entry data.void
setCrc(long crc)
Sets the CRC-32 checksum of the uncompressed entry data.ZipEntry
setCreationTime(FileTime time)
Sets the creation time of the entry.void
setExtra(byte[] extra)
Sets the optional extra field data for the entry.ZipEntry
setLastAccessTime(FileTime time)
Sets the last access time of the entry.ZipEntry
setLastModifiedTime(FileTime time)
Sets the last modification time of the entry.void
setMethod(int method)
Sets the compression method for the entry.void
setSize(long size)
Sets the uncompressed size of the entry data.void
setTime(long time)
Sets the last modification time of the entry.void
setTimeLocal(LocalDateTime time)
Sets the last modification time of the entry in local date-time.String
toString()
Returns a string representation of the ZIP entry.
-
Field Details
-
STORED
public static final int STOREDCompression method for uncompressed entries.- See Also:
- Constant Field Values
-
DEFLATED
public static final int DEFLATEDCompression method for compressed (deflated) entries.- See Also:
- Constant Field Values
-
LOCSIG
static final long LOCSIG- See Also:
- Constant Field Values
-
EXTSIG
static final long EXTSIG- See Also:
- Constant Field Values
-
CENSIG
static final long CENSIG- See Also:
- Constant Field Values
-
ENDSIG
static final long ENDSIG- See Also:
- Constant Field Values
-
LOCHDR
static final int LOCHDR- See Also:
- Constant Field Values
-
EXTHDR
static final int EXTHDR- See Also:
- Constant Field Values
-
CENHDR
static final int CENHDR- See Also:
- Constant Field Values
-
ENDHDR
static final int ENDHDR- See Also:
- Constant Field Values
-
LOCVER
static final int LOCVER- See Also:
- Constant Field Values
-
LOCFLG
static final int LOCFLG- See Also:
- Constant Field Values
-
LOCHOW
static final int LOCHOW- See Also:
- Constant Field Values
-
LOCTIM
static final int LOCTIM- See Also:
- Constant Field Values
-
LOCCRC
static final int LOCCRC- See Also:
- Constant Field Values
-
LOCSIZ
static final int LOCSIZ- See Also:
- Constant Field Values
-
LOCLEN
static final int LOCLEN- See Also:
- Constant Field Values
-
LOCNAM
static final int LOCNAM- See Also:
- Constant Field Values
-
LOCEXT
static final int LOCEXT- See Also:
- Constant Field Values
-
EXTCRC
static final int EXTCRC- See Also:
- Constant Field Values
-
EXTSIZ
static final int EXTSIZ- See Also:
- Constant Field Values
-
EXTLEN
static final int EXTLEN- See Also:
- Constant Field Values
-
CENVEM
static final int CENVEM- See Also:
- Constant Field Values
-
CENVER
static final int CENVER- See Also:
- Constant Field Values
-
CENFLG
static final int CENFLG- See Also:
- Constant Field Values
-
CENHOW
static final int CENHOW- See Also:
- Constant Field Values
-
CENTIM
static final int CENTIM- See Also:
- Constant Field Values
-
CENCRC
static final int CENCRC- See Also:
- Constant Field Values
-
CENSIZ
static final int CENSIZ- See Also:
- Constant Field Values
-
CENLEN
static final int CENLEN- See Also:
- Constant Field Values
-
CENNAM
static final int CENNAM- See Also:
- Constant Field Values
-
CENEXT
static final int CENEXT- See Also:
- Constant Field Values
-
CENCOM
static final int CENCOM- See Also:
- Constant Field Values
-
CENDSK
static final int CENDSK- See Also:
- Constant Field Values
-
CENATT
static final int CENATT- See Also:
- Constant Field Values
-
CENATX
static final int CENATX- See Also:
- Constant Field Values
-
CENOFF
static final int CENOFF- See Also:
- Constant Field Values
-
ENDSUB
static final int ENDSUB- See Also:
- Constant Field Values
-
ENDTOT
static final int ENDTOT- See Also:
- Constant Field Values
-
ENDSIZ
static final int ENDSIZ- See Also:
- Constant Field Values
-
ENDOFF
static final int ENDOFF- See Also:
- Constant Field Values
-
ENDCOM
static final int ENDCOM- See Also:
- Constant Field Values
-
-
Constructor Details
-
ZipEntry
Creates a new zip entry with the specified name.- Parameters:
name
- The entry name- Throws:
NullPointerException
- if the entry name is nullIllegalArgumentException
- if the entry name is longer than 0xFFFF bytes
-
ZipEntry
Creates a new zip entry with fields taken from the specified zip entry.- Parameters:
e
- A zip Entry object- Throws:
NullPointerException
- if the entry object is null
-
-
Method Details
-
getName
Returns the name of the entry.- Returns:
- the name of the entry
-
setTime
public void setTime(long time)Sets the last modification time of the entry.If the entry is output to a ZIP file or ZIP file formatted output stream the last modification time set by this method will be stored into the
date and time fields
of the zip file entry and encoded in standardMS-DOS date and time format
. Thedefault TimeZone
is used to convert the epoch time to the MS-DOS data and time.- Parameters:
time
- The last modification time of the entry in milliseconds since the epoch- See Also:
getTime()
,getLastModifiedTime()
-
getTime
public long getTime()Returns the last modification time of the entry.If the entry is read from a ZIP file or ZIP file formatted input stream, this is the last modification time from the
date and time fields
of the zip file entry. Thedefault TimeZone
is used to convert the standard MS-DOS formatted date and time to the epoch time.- Returns:
- The last modification time of the entry in milliseconds since the epoch, or -1 if not specified
- See Also:
setTime(long)
,setLastModifiedTime(FileTime)
-
setTimeLocal
Sets the last modification time of the entry in local date-time.If the entry is output to a ZIP file or ZIP file formatted output stream the last modification time set by this method will be stored into the
date and time fields
of the zip file entry and encoded in standardMS-DOS date and time format
. If the date-time set is out of the range of the standardMS-DOS date and time format
, the time will also be stored into zip file entry's extended timestamp fields inoptional extra data
in UTC time. Thesystem default TimeZone
is used to convert the local date-time to UTC time.LocalDateTime
uses a precision of nanoseconds, whereas this class uses a precision of milliseconds. The conversion will truncate any excess precision information as though the amount in nanoseconds was subject to integer division by one million.- Parameters:
time
- The last modification time of the entry in local date-time- Since:
- 9
- See Also:
getTimeLocal()
-
getTimeLocal
Returns the last modification time of the entry in local date-time.If the entry is read from a ZIP file or ZIP file formatted input stream, this is the last modification time from the zip file entry's
optional extra data
if the extended timestamp fields are present. Otherwise, the last modification time is read from entry's standard MS-DOS formatteddate and time fields
.The
system default TimeZone
is used to convert the UTC time to local date-time.- Returns:
- The last modification time of the entry in local date-time
- Since:
- 9
- See Also:
setTimeLocal(LocalDateTime)
-
setLastModifiedTime
Sets the last modification time of the entry.When output to a ZIP file or ZIP file formatted output stream the last modification time set by this method will be stored into zip file entry's
date and time fields
instandard MS-DOS date and time format
), and the extended timestamp fields inoptional extra data
in UTC time.- Parameters:
time
- The last modification time of the entry- Returns:
- This zip entry
- Throws:
NullPointerException
- if thetime
is null- Since:
- 1.8
- See Also:
getLastModifiedTime()
-
getLastModifiedTime
Returns the last modification time of the entry.If the entry is read from a ZIP file or ZIP file formatted input stream, this is the last modification time from the zip file entry's
optional extra data
if the extended timestamp fields are present. Otherwise the last modification time is read from the entry'sdate and time fields
, thedefault TimeZone
is used to convert the standard MS-DOS formatted date and time to the epoch time.- Returns:
- The last modification time of the entry, null if not specified
- Since:
- 1.8
- See Also:
setLastModifiedTime(FileTime)
-
setLastAccessTime
Sets the last access time of the entry.If set, the last access time will be stored into the extended timestamp fields of entry's
optional extra data
, when output to a ZIP file or ZIP file formatted stream.- Parameters:
time
- The last access time of the entry- Returns:
- This zip entry
- Throws:
NullPointerException
- if thetime
is null- Since:
- 1.8
- See Also:
getLastAccessTime()
-
getLastAccessTime
Returns the last access time of the entry.The last access time is from the extended timestamp fields of entry's
optional extra data
when read from a ZIP file or ZIP file formatted stream.- Returns:
- The last access time of the entry, null if not specified
- Since:
- 1.8
- See Also:
setLastAccessTime(FileTime)
-
setCreationTime
Sets the creation time of the entry.If set, the creation time will be stored into the extended timestamp fields of entry's
optional extra data
, when output to a ZIP file or ZIP file formatted stream.- Parameters:
time
- The creation time of the entry- Returns:
- This zip entry
- Throws:
NullPointerException
- if thetime
is null- Since:
- 1.8
- See Also:
getCreationTime()
-
getCreationTime
Returns the creation time of the entry.The creation time is from the extended timestamp fields of entry's
optional extra data
when read from a ZIP file or ZIP file formatted stream.- Returns:
- the creation time of the entry, null if not specified
- Since:
- 1.8
- See Also:
setCreationTime(FileTime)
-
setSize
public void setSize(long size)Sets the uncompressed size of the entry data.- Parameters:
size
- the uncompressed size in bytes- Throws:
IllegalArgumentException
- if the specified size is less than 0, is greater than 0xFFFFFFFF when ZIP64 format is not supported, or is less than 0 when ZIP64 is supported- See Also:
getSize()
-
getSize
public long getSize()Returns the uncompressed size of the entry data.- Returns:
- the uncompressed size of the entry data, or -1 if not known
- See Also:
setSize(long)
-
getCompressedSize
public long getCompressedSize()Returns the size of the compressed entry data.In the case of a stored entry, the compressed size will be the same as the uncompressed size of the entry.
- Returns:
- the size of the compressed entry data, or -1 if not known
- See Also:
setCompressedSize(long)
-
setCompressedSize
public void setCompressedSize(long csize)Sets the size of the compressed entry data.- Parameters:
csize
- the compressed size to set- See Also:
getCompressedSize()
-
setCrc
public void setCrc(long crc)Sets the CRC-32 checksum of the uncompressed entry data.- Parameters:
crc
- the CRC-32 value- Throws:
IllegalArgumentException
- if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFF- See Also:
getCrc()
-
getCrc
public long getCrc()Returns the CRC-32 checksum of the uncompressed entry data.- Returns:
- the CRC-32 checksum of the uncompressed entry data, or -1 if not known
- See Also:
setCrc(long)
-
setMethod
public void setMethod(int method)Sets the compression method for the entry.- Parameters:
method
- the compression method, either STORED or DEFLATED- Throws:
IllegalArgumentException
- if the specified compression method is invalid- See Also:
getMethod()
-
getMethod
public int getMethod()Returns the compression method of the entry.- Returns:
- the compression method of the entry, or -1 if not specified
- See Also:
setMethod(int)
-
setExtra
public void setExtra(byte[] extra)Sets the optional extra field data for the entry.Invoking this method may change this entry's last modification time, last access time and creation time, if the
extra
field data includes the extensible timestamp fields, such asNTFS tag 0x0001
orInfo-ZIP Extended Timestamp
, as specified in Info-ZIP Application Note 970311.- Parameters:
extra
- The extra field data bytes- Throws:
IllegalArgumentException
- if the length of the specified extra field data is greater than 0xFFFF bytes- See Also:
getExtra()
-
getExtra
public byte[] getExtra()Returns the extra field data for the entry.- Returns:
- the extra field data for the entry, or null if none
- See Also:
setExtra(byte[])
-
setComment
Sets the optional comment string for the entry.ZIP entry comments have maximum length of 0xffff. If the length of the specified comment string is greater than 0xFFFF bytes after encoding, only the first 0xFFFF bytes are output to the ZIP file entry.
- Parameters:
comment
- the comment string- See Also:
getComment()
-
getComment
Returns the comment string for the entry.- Returns:
- the comment string for the entry, or null if none
- See Also:
setComment(String)
-
isDirectory
public boolean isDirectory()Returns true if this is a directory entry. A directory entry is defined to be one whose name ends with a '/'.- Returns:
- true if this is a directory entry
-
toString
Returns a string representation of the ZIP entry. -
hashCode
public int hashCode()Returns the hash code value for this entry.- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
clone
Returns a copy of this entry.
-