Cloneable
JarEntry
public class ZipEntry extends Object implements Cloneable
Modifier and Type | Field | Description |
---|---|---|
static final int |
CENATT |
Central directory (CEN) header internal file attributes field offset. |
static final int |
CENATX |
Central directory (CEN) header external file attributes field offset. |
static final int |
CENCOM |
Central directory (CEN) header comment length field offset. |
static final int |
CENCRC |
Central directory (CEN) header uncompressed file crc-32 value field offset. |
static final int |
CENDSK |
Central directory (CEN) header disk number start field offset. |
static final int |
CENEXT |
Central directory (CEN) header extra field length field offset. |
static final int |
CENFLG |
Central directory (CEN) header encrypt, decrypt flags field offset. |
static final int |
CENHDR |
Central directory (CEN) header size in bytes (including signature). |
static final int |
CENHOW |
Central directory (CEN) header compression method field offset. |
static final int |
CENLEN |
Central directory (CEN) header uncompressed size field offset. |
static final int |
CENNAM |
Central directory (CEN) header filename length field offset. |
static final int |
CENOFF |
Central directory (CEN) header LOC header offset field offset. |
static final long |
CENSIG |
Central directory (CEN) header signature. |
static final int |
CENSIZ |
Central directory (CEN) header compressed size field offset. |
static final int |
CENTIM |
Central directory (CEN) header modification time field offset. |
static final int |
CENVEM |
Central directory (CEN) header version made by field offset. |
static final int |
CENVER |
Central directory (CEN) header version needed to extract field offset. |
static final int |
DEFLATED |
Compression method for compressed (deflated) entries. |
static final int |
ENDCOM |
End of central directory (END) header zip file comment length field offset. |
static final int |
ENDHDR |
End of central directory (END) header size in bytes (including signature). |
static final int |
ENDOFF |
End of central directory (END) header offset for the first CEN header field offset. |
static final long |
ENDSIG |
End of central directory (END) header signature. |
static final int |
ENDSIZ |
End of central directory (END) header central directory size in bytes field offset. |
static final int |
ENDSUB |
End of central directory (END) header number of entries on this disk field offset. |
static final int |
ENDTOT |
End of central directory (END) header total number of entries field offset. |
static final int |
EXTCRC |
Extra local (EXT) header uncompressed file crc-32 value field offset. |
static final int |
EXTHDR |
Extra local (EXT) header size in bytes (including signature). |
static final int |
EXTLEN |
Extra local (EXT) header uncompressed size field offset. |
static final long |
EXTSIG |
Extra local (EXT) header signature. |
static final int |
EXTSIZ |
Extra local (EXT) header compressed size field offset. |
static final int |
LOCCRC |
Local file (LOC) header uncompressed file crc-32 value field offset. |
static final int |
LOCEXT |
Local file (LOC) header extra field length field offset. |
static final int |
LOCFLG |
Local file (LOC) header general purpose bit flag field offset. |
static final int |
LOCHDR |
Local file (LOC) header size in bytes (including signature). |
static final int |
LOCHOW |
Local file (LOC) header compression method field offset. |
static final int |
LOCLEN |
Local file (LOC) header uncompressed size field offset. |
static final int |
LOCNAM |
Local file (LOC) header filename length field offset. |
static final long |
LOCSIG |
Local file (LOC) header signature. |
static final int |
LOCSIZ |
Local file (LOC) header compressed size field offset. |
static final int |
LOCTIM |
Local file (LOC) header modification time field offset. |
static final int |
LOCVER |
Local file (LOC) header version needed to extract field offset. |
static final int |
STORED |
Compression method for uncompressed entries. |
Constructor | Description |
---|---|
ZipEntry |
Creates a new zip entry with the specified name. |
ZipEntry |
Creates a new zip entry with fields taken from the specified zip entry. |
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 |
Sets the optional comment string for the entry. |
void |
setCompressedSize |
Sets the size of the compressed entry data. |
void |
setCrc |
Sets the CRC-32 checksum of the uncompressed entry data. |
ZipEntry |
setCreationTime |
Sets the creation time of the entry. |
void |
setExtra |
Sets the optional extra field data for the entry. |
ZipEntry |
setLastAccessTime |
Sets the last access time of the entry. |
ZipEntry |
setLastModifiedTime |
Sets the last modification time of the entry. |
void |
setMethod |
Sets the compression method for the entry. |
void |
setSize |
Sets the uncompressed size of the entry data. |
void |
setTime |
Sets the last modification time of the entry. |
void |
setTimeLocal |
Sets the last modification time of the entry in local date-time. |
String |
toString() |
Returns a string representation of the ZIP entry. |
public static final int STORED
public static final int DEFLATED
static final long LOCSIG
static final long EXTSIG
static final long CENSIG
static final long ENDSIG
static final int LOCHDR
static final int EXTHDR
static final int CENHDR
static final int ENDHDR
static final int LOCVER
static final int LOCFLG
static final int LOCHOW
static final int LOCTIM
static final int LOCCRC
static final int LOCSIZ
static final int LOCLEN
static final int LOCNAM
static final int LOCEXT
static final int EXTCRC
static final int EXTSIZ
static final int EXTLEN
static final int CENVEM
static final int CENVER
static final int CENFLG
static final int CENHOW
static final int CENTIM
static final int CENCRC
static final int CENSIZ
static final int CENLEN
static final int CENNAM
static final int CENEXT
static final int CENCOM
static final int CENDSK
static final int CENATT
static final int CENATX
static final int CENOFF
static final int ENDSUB
static final int ENDTOT
static final int ENDSIZ
static final int ENDOFF
static final int ENDCOM
public ZipEntry(String name)
name
- The entry nameNullPointerException
- if the entry name is nullIllegalArgumentException
- if the entry name is longer than 0xFFFF bytespublic ZipEntry(ZipEntry e)
e
- A zip Entry objectNullPointerException
- if the entry object is nullpublic String getName()
public void setTime(long 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 standard MS-DOS date and time format
. The default TimeZone
is used to convert the epoch time to the MS-DOS date and time.
time
- The last modification time of the entry in milliseconds since the epochpublic long getTime()
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.
public void setTimeLocal(LocalDateTime 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 standard MS-DOS date and time format
. If the date-time set is out of the range of the standard
MS-DOS date and time format
, the time will also be stored into zip file entry's extended timestamp fields in optional
extra data
in UTC time. The system 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.
time
- The last modification time of the entry in local date-timepublic LocalDateTime getTimeLocal()
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 formatted date and time fields
.
The system default TimeZone
is used to convert the UTC time to local date-time.
public ZipEntry setLastModifiedTime(FileTime time)
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 nullpublic FileTime getLastModifiedTime()
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.
public ZipEntry setLastAccessTime(FileTime time)
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 nullpublic FileTime getLastAccessTime()
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.
public ZipEntry setCreationTime(FileTime time)
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 nullpublic FileTime getCreationTime()
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.
public void setSize(long size)
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 supportedpublic long getSize()
public long getCompressedSize()
In the case of a stored entry, the compressed size will be the same as the uncompressed size of the entry.
public void setCompressedSize(long csize)
csize
- the compressed size to setpublic void setCrc(long crc)
crc
- the CRC-32 valueIllegalArgumentException
- if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFFpublic long getCrc()
public void setMethod(int method)
method
- the compression method, either STORED or DEFLATEDIllegalArgumentException
- if the specified compression method is invalidpublic int getMethod()
public void setExtra(byte[] extra)
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 bytespublic byte[] getExtra()
public void setComment(String comment)
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 stringpublic String getComment()
public boolean isDirectory()
public String toString()
public int hashCode()
public Object clone()
© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/zip/ZipEntry.html