- All Implemented Interfaces:
- Cloneable
- Direct Known Subclasses:
- JarEntry
- Since:
- 1.1
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intCentral directory (CEN) header internal file attributes field offset.static final intCentral directory (CEN) header external file attributes field offset.static final intCentral directory (CEN) header comment length field offset.static final intCentral directory (CEN) header uncompressed file crc-32 value field offset.static final intCentral directory (CEN) header disk number start field offset.static final intCentral directory (CEN) header extra field length field offset.static final intCentral directory (CEN) header encrypt, decrypt flags field offset.static final intCentral directory (CEN) header size in bytes (including signature).static final intCentral directory (CEN) header compression method field offset.static final intCentral directory (CEN) header uncompressed size field offset.static final intCentral directory (CEN) header filename length field offset.static final intCentral directory (CEN) header LOC header offset field offset.static final longCentral directory (CEN) header signature.static final intCentral directory (CEN) header compressed size field offset.static final intCentral directory (CEN) header modification time field offset.static final intCentral directory (CEN) header version made by field offset.static final intCentral directory (CEN) header version needed to extract field offset.static final intCompression method for compressed (deflated) entries.static final intEnd of central directory (END) header zip file comment length field offset.static final intEnd of central directory (END) header size in bytes (including signature).static final intEnd of central directory (END) header offset for the first CEN header field offset.static final longEnd of central directory (END) header signature.static final intEnd of central directory (END) header central directory size in bytes field offset.static final intEnd of central directory (END) header number of entries on this disk field offset.static final intEnd of central directory (END) header total number of entries field offset.static final intExtra local (EXT) header uncompressed file crc-32 value field offset.static final intExtra local (EXT) header size in bytes (including signature).static final intExtra local (EXT) header uncompressed size field offset.static final longExtra local (EXT) header signature.static final intExtra local (EXT) header compressed size field offset.static final intLocal file (LOC) header uncompressed file crc-32 value field offset.static final intLocal file (LOC) header extra field length field offset.static final intLocal file (LOC) header general purpose bit flag field offset.static final intLocal file (LOC) header size in bytes (including signature).static final intLocal file (LOC) header compression method field offset.static final intLocal file (LOC) header uncompressed size field offset.static final intLocal file (LOC) header filename length field offset.static final longLocal file (LOC) header signature.static final intLocal file (LOC) header compressed size field offset.static final intLocal file (LOC) header modification time field offset.static final intLocal file (LOC) header version needed to extract field offset.static final intCompression method for uncompressed entries.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionclone()Returns a copy of this entry.Returns the comment string for the entry.longReturns the size of the compressed entry data.longgetCrc()Returns the CRC-32 checksum of the uncompressed entry data.Returns the creation time of the entry.byte[]getExtra()Returns the extra field data for the entry.Returns the last access time of the entry.Returns the last modification time of the entry.intReturns the compression method of the entry.getName()Returns the name of the entry.longgetSize()Returns the uncompressed size of the entry data.longgetTime()Returns the last modification time of the entry.Returns the last modification time of the entry in local date-time.inthashCode()Returns the hash code value for this entry.booleanReturns true if this is a directory entry.voidsetComment(String comment) Sets the optional comment string for the entry.voidsetCompressedSize(long csize) Sets the size of the compressed entry data.voidsetCrc(long crc) Sets the CRC-32 checksum of the uncompressed entry data.setCreationTime(FileTime time) Sets the creation time of the entry.voidsetExtra(byte[] extra) Sets the optional extra field data for the entry.setLastAccessTime(FileTime time) Sets the last access time of the entry.setLastModifiedTime(FileTime time) Sets the last modification time of the entry.voidsetMethod(int method) Sets the compression method for the entry.voidsetSize(long size) Sets the uncompressed size of the entry data.voidsetTime(long time) Sets the last modification time of the entry.voidsetTimeLocal(LocalDateTime time) Sets the last modification time of the entry in local date-time.toString()Returns a string representation of the ZIP entry.
- 
Field Details- 
STOREDpublic static final int STOREDCompression method for uncompressed entries.- See Also:
 
- 
DEFLATEDpublic static final int DEFLATEDCompression method for compressed (deflated) entries.- See Also:
 
- 
LOCSIGstatic final long LOCSIGLocal file (LOC) header signature.- See Also:
 
- 
EXTSIGstatic final long EXTSIGExtra local (EXT) header signature.- See Also:
 
- 
CENSIGstatic final long CENSIGCentral directory (CEN) header signature.- See Also:
 
- 
ENDSIGstatic final long ENDSIGEnd of central directory (END) header signature.- See Also:
 
- 
LOCHDRstatic final int LOCHDRLocal file (LOC) header size in bytes (including signature).- See Also:
 
- 
EXTHDRstatic final int EXTHDRExtra local (EXT) header size in bytes (including signature).- See Also:
 
- 
CENHDRstatic final int CENHDRCentral directory (CEN) header size in bytes (including signature).- See Also:
 
- 
ENDHDRstatic final int ENDHDREnd of central directory (END) header size in bytes (including signature).- See Also:
 
- 
LOCVERstatic final int LOCVERLocal file (LOC) header version needed to extract field offset.- See Also:
 
- 
LOCFLGstatic final int LOCFLGLocal file (LOC) header general purpose bit flag field offset.- See Also:
 
- 
LOCHOWstatic final int LOCHOWLocal file (LOC) header compression method field offset.- See Also:
 
- 
LOCTIMstatic final int LOCTIMLocal file (LOC) header modification time field offset.- See Also:
 
- 
LOCCRCstatic final int LOCCRCLocal file (LOC) header uncompressed file crc-32 value field offset.- See Also:
 
- 
LOCSIZstatic final int LOCSIZLocal file (LOC) header compressed size field offset.- See Also:
 
- 
LOCLENstatic final int LOCLENLocal file (LOC) header uncompressed size field offset.- See Also:
 
- 
LOCNAMstatic final int LOCNAMLocal file (LOC) header filename length field offset.- See Also:
 
- 
LOCEXTstatic final int LOCEXTLocal file (LOC) header extra field length field offset.- See Also:
 
- 
EXTCRCstatic final int EXTCRCExtra local (EXT) header uncompressed file crc-32 value field offset.- See Also:
 
- 
EXTSIZstatic final int EXTSIZExtra local (EXT) header compressed size field offset.- See Also:
 
- 
EXTLENstatic final int EXTLENExtra local (EXT) header uncompressed size field offset.- See Also:
 
- 
CENVEMstatic final int CENVEMCentral directory (CEN) header version made by field offset.- See Also:
 
- 
CENVERstatic final int CENVERCentral directory (CEN) header version needed to extract field offset.- See Also:
 
- 
CENFLGstatic final int CENFLGCentral directory (CEN) header encrypt, decrypt flags field offset.- See Also:
 
- 
CENHOWstatic final int CENHOWCentral directory (CEN) header compression method field offset.- See Also:
 
- 
CENTIMstatic final int CENTIMCentral directory (CEN) header modification time field offset.- See Also:
 
- 
CENCRCstatic final int CENCRCCentral directory (CEN) header uncompressed file crc-32 value field offset.- See Also:
 
- 
CENSIZstatic final int CENSIZCentral directory (CEN) header compressed size field offset.- See Also:
 
- 
CENLENstatic final int CENLENCentral directory (CEN) header uncompressed size field offset.- See Also:
 
- 
CENNAMstatic final int CENNAMCentral directory (CEN) header filename length field offset.- See Also:
 
- 
CENEXTstatic final int CENEXTCentral directory (CEN) header extra field length field offset.- See Also:
 
- 
CENCOMstatic final int CENCOMCentral directory (CEN) header comment length field offset.- See Also:
 
- 
CENDSKstatic final int CENDSKCentral directory (CEN) header disk number start field offset.- See Also:
 
- 
CENATTstatic final int CENATTCentral directory (CEN) header internal file attributes field offset.- See Also:
 
- 
CENATXstatic final int CENATXCentral directory (CEN) header external file attributes field offset.- See Also:
 
- 
CENOFFstatic final int CENOFFCentral directory (CEN) header LOC header offset field offset.- See Also:
 
- 
ENDSUBstatic final int ENDSUBEnd of central directory (END) header number of entries on this disk field offset.- See Also:
 
- 
ENDTOTstatic final int ENDTOTEnd of central directory (END) header total number of entries field offset.- See Also:
 
- 
ENDSIZstatic final int ENDSIZEnd of central directory (END) header central directory size in bytes field offset.- See Also:
 
- 
ENDOFFstatic final int ENDOFFEnd of central directory (END) header offset for the first CEN header field offset.- See Also:
 
- 
ENDCOMstatic final int ENDCOMEnd of central directory (END) header zip file comment length field offset.- See Also:
 
 
- 
- 
Constructor Details- 
ZipEntryCreates a new zip entry with the specified name.- Parameters:
- name- The entry name
- Throws:
- NullPointerException- if the entry name is null
- IllegalArgumentException- if the entry name is longer than 0xFFFF bytes
 
- 
ZipEntryCreates 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- 
getNameReturns the name of the entry.- Returns:
- the name of the entry
 
- 
setTimepublic 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 fieldsof the zip file entry and encoded in standardMS-DOS date and time format. Thedefault TimeZoneis used to convert the epoch time to the MS-DOS date and time.- Parameters:
- time- The last modification time of the entry in milliseconds since the epoch
- See Also:
 
- 
getTimepublic 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 fieldsof the zip file entry. Thedefault TimeZoneis 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:
 
- 
setTimeLocalSets 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 fieldsof 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 datain UTC time. Thesystem default TimeZoneis used to convert the local date-time to UTC time.LocalDateTimeuses 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:
 
- 
getTimeLocalReturns 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 dataif 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 TimeZoneis 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:
 
- 
setLastModifiedTimeSets 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 fieldsinstandard MS-DOS date and time format), and the extended timestamp fields inoptional extra datain UTC time.- Parameters:
- time- The last modification time of the entry
- Returns:
- This zip entry
- Throws:
- NullPointerException- if the- timeis null
- Since:
- 1.8
- See Also:
 
- 
getLastModifiedTimeReturns 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 dataif the extended timestamp fields are present. Otherwise the last modification time is read from the entry'sdate and time fields, thedefault TimeZoneis 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:
 
- 
setLastAccessTimeSets 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 the- timeis null
- Since:
- 1.8
- See Also:
 
- 
getLastAccessTimeReturns the last access time of the entry.The last access time is from the extended timestamp fields of entry's optional extra datawhen 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:
 
- 
setCreationTimeSets 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 the- timeis null
- Since:
- 1.8
- See Also:
 
- 
getCreationTimeReturns the creation time of the entry.The creation time is from the extended timestamp fields of entry's optional extra datawhen 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:
 
- 
setSizepublic 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:
 
- 
getSizepublic 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:
 
- 
getCompressedSizepublic 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:
 
- 
setCompressedSizepublic void setCompressedSize(long csize) Sets the size of the compressed entry data.- Parameters:
- csize- the compressed size to set
- See Also:
 
- 
setCrcpublic 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:
 
- 
getCrcpublic 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:
 
- 
setMethodpublic 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:
 
- 
getMethodpublic int getMethod()Returns the compression method of the entry.- Returns:
- the compression method of the entry, or -1 if not specified
- See Also:
 
- 
setExtrapublic 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 extrafield data includes the extensible timestamp fields, such asNTFS tag 0x0001orInfo-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:
 
- 
getExtrapublic byte[] getExtra()Returns the extra field data for the entry.- Returns:
- the extra field data for the entry, or null if none
- See Also:
 
- 
setCommentSets 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:
 
- 
getCommentReturns the comment string for the entry.- Returns:
- the comment string for the entry, or null if none
- See Also:
 
- 
isDirectorypublic 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
 
- 
toStringReturns a string representation of the ZIP entry.
- 
hashCodepublic int hashCode()Returns the hash code value for this entry.
- 
cloneReturns a copy of this entry.
 
-