java.util.zip

Class ZipEntry

Contents
  • 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.

    • 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

    • 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 modification time of the entry.
        Parameters:
        time - the entry modification time in number of milliseconds since the epoch
        See Also:
        getTime()

      • getTime

        public long getTime()
        Returns the modification time of the entry, or -1 if not specified.
        Returns:
        the modification time of the entry, or -1 if not specified
        See Also:
        setTime(long)

      • 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, or -1 if not known.
        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, or -1 if not known. 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 to
        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, or -1 if not known.
        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, or -1 if not specified.
        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.
        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, or null if none.
        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, or null if none.
        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

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/zip/ZipEntry.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut