public class ZipEntry extends Object implements Cloneable
This class is used to represent a ZIP file entry.
public static final int STORED
Compression method for uncompressed entries.
public static final int DEFLATED
Compression method for compressed (deflated) entries.
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 ZipEntry(String name)
Creates a new zip entry with the specified name.
name
- The entry nameNullPointerException
- if the entry name is nullIllegalArgumentException
- if the entry name is longer than 0xFFFF bytespublic ZipEntry(ZipEntry e)
Creates a new zip entry with fields taken from the specified zip entry.
e
- A zip Entry objectNullPointerException
- if the entry object is nullpublic String getName()
Returns the name of the entry.
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 standard MS-DOS date and time format
. The default TimeZone
is used to convert the epoch time to the MS-DOS data and time.
time
- The last modification time of the entry in milliseconds since the epochgetTime()
, getLastModifiedTime()
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. The default TimeZone
is used to convert the standard MS-DOS formatted date and time to the epoch time.
setTime(long)
, setLastModifiedTime(FileTime)
public ZipEntry setLastModifiedTime(FileTime time)
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
in standard
MS-DOS date and time format
), and the extended timestamp fields in optional extra data
in UTC time.
time
- The last modification time of the entryNullPointerException
- if the time
is nullgetLastModifiedTime()
public FileTime 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's date and time fields
, the default TimeZone
is used to convert the standard MS-DOS formatted date and time to the epoch time.
setLastModifiedTime(FileTime)
public ZipEntry setLastAccessTime(FileTime time)
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.
time
- The last access time of the entryNullPointerException
- if the time
is nullgetLastAccessTime()
public FileTime 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.
setLastAccessTime(FileTime)
public ZipEntry setCreationTime(FileTime time)
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.
time
- The creation time of the entryNullPointerException
- if the time
is nullgetCreationTime()
public FileTime 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.
setCreationTime(FileTime)
public void setSize(long size)
Sets the uncompressed size of the entry data.
size
- the uncompressed size in bytesIllegalArgumentException
- 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 supportedgetSize()
public long getSize()
Returns the uncompressed size of the entry data.
setSize(long)
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.
setCompressedSize(long)
public void setCompressedSize(long csize)
Sets the size of the compressed entry data.
csize
- the compressed size to set togetCompressedSize()
public void setCrc(long crc)
Sets the CRC-32 checksum of the uncompressed entry data.
crc
- the CRC-32 valueIllegalArgumentException
- if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFFgetCrc()
public long getCrc()
Returns the CRC-32 checksum of the uncompressed entry data.
setCrc(long)
public void setMethod(int method)
Sets the compression method for the entry.
method
- the compression method, either STORED or DEFLATEDIllegalArgumentException
- if the specified compression method is invalidgetMethod()
public int getMethod()
Returns the compression method of the entry.
setMethod(int)
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 as NTFS tag
0x0001
or Info-ZIP Extended Timestamp
, as specified in Info-ZIP Application Note 970311.
extra
- The extra field data bytesIllegalArgumentException
- if the length of the specified extra field data is greater than 0xFFFF bytesgetExtra()
public byte[] getExtra()
Returns the extra field data for the entry.
setExtra(byte[])
public void setComment(String comment)
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.
comment
- the comment stringgetComment()
public String getComment()
Returns the comment string for the entry.
setComment(String)
public boolean isDirectory()
Returns true if this is a directory entry. A directory entry is defined to be one whose name ends with a '/'.
public String toString()
Returns a string representation of the ZIP entry.
public int hashCode()
Returns the hash code value for this entry.
hashCode
in class Object
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
public Object clone()
Returns a copy of this entry.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.