Module java.base
Package java.util.zip

Class ZipEntry

  • All Implemented Interfaces:
    Cloneable
    Direct Known Subclasses:
    JarEntry
    public class ZipEntry
extends Object
implements Cloneable
    This class is used to represent a ZIP file entry.
    Since:
    1.1

    • Constructor Detail

      • ZipEntry

        public ZipEntry​(String name)
        Creates 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

      • ZipEntry

        public ZipEntry​(ZipEntry e)
        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 Detail

      • getName

        public String 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 standard MS-DOS date and time format. The default 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. The default 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

        public void setTimeLocal​(LocalDateTime time)
        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 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.

        Parameters:
        time - The last modification time of the entry in local date-time
        Since:
        9
        See Also:
        getTimeLocal()

      • getTimeLocal

        public LocalDateTime 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 formatted date 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

        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.

        Parameters:
        time - The last modification time of the entry
        Returns:
        This zip entry
        Throws:
        NullPointerException - if the time is null
        Since:
        1.8
        See Also:
        getLastModifiedTime()

      • getLastModifiedTime

        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.

        Returns:
        The last modification time of the entry, null if not specified
        Since:
        1.8
        See Also:
        setLastModifiedTime(FileTime)

      • setLastAccessTime

        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.

        Parameters:
        time - The last access time of the entry
        Returns:
        This zip entry
        Throws:
        NullPointerException - if the time is null
        Since:
        1.8
        See Also:
        getLastAccessTime()

      • getLastAccessTime

        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.

        Returns:
        The last access time of the entry, null if not specified
        Since:
        1.8
        See Also:
        setLastAccessTime(FileTime)

      • setCreationTime

        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.

        Parameters:
        time - The creation time of the entry
        Returns:
        This zip entry
        Throws:
        NullPointerException - if the time is null
        Since:
        1.8
        See Also:
        getCreationTime()

      • getCreationTime

        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.

        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 as NTFS tag 0x0001 or Info-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

        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.

        Parameters:
        comment - the comment string
        See Also:
        getComment()

      • getComment

        public String 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

        public String toString()
        Returns a string representation of the ZIP entry.
        Overrides:
        toString in class Object
        Returns:
        a string representation of the object.

      • clone

        public Object clone()
        Returns a copy of this entry.
        Overrides:
        clone in class Object
        Returns:
        a clone of this instance.
        See Also:
        Cloneable