Class ZipEntry


  • public class ZipEntry
    extends java.lang.Object
    This class is used to represent a ZIP file entry.
    Since:
    TotalCross 1.20
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFLATED
      Compression method.
      static int STORED
      Compression method.
    • Constructor Summary

      Constructors 
      Constructor Description
      ZipEntry​(java.lang.String name)
      Creates a new zip entry with the specified name.
      ZipEntry​(ZipEntry e)
      Creates a new zip entry with fields taken from the specified zip entry.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getComment()
      Returns the comment string for the entry, or null if none.
      long getCompressedSize()
      Returns the size of the compressed entry data, or -1 if not known.
      long getCrc()
      Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.
      byte[] getExtra()
      Returns the extra field data for the entry, or null if none.
      int getMethod()
      Returns the compression method of the entry, or -1 if not specified.
      java.lang.String getName()
      Returns the name of the entry.
      long getSize()
      Returns the uncompressed size of the entry data, or -1 if not known.
      long getTime()
      Returns the modification time of the entry, or -1 if not specified.
      int hashCode()
      Returns the hash code value for this entry.
      boolean isDirectory()
      Returns true if this is a directory entry.
      void setComment​(java.lang.String comment)
      Sets the optional comment string for the entry.
      void setCompressedSize​(long csize)
      Sets the size of the compressed entry data.
      void setCrc​(long crc)
      Sets the CRC-32 checksum of the uncompressed entry data.
      void setExtra​(byte[] extra)
      Sets the optional extra field data for the entry.
      void setMethod​(int method)
      Sets the compression method for the entry.
      void setSize​(long size)
      Sets the uncompressed size of the entry data.
      void setTime​(long time)
      Sets the modification time of the entry.
      java.lang.String toString()
      Returns a string representation of the ZIP entry.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • STORED

        public static final int STORED
        Compression method. This method doesn't compress at all.
        See Also:
        Constant Field Values
      • DEFLATED

        public static final int DEFLATED
        Compression method. This method uses the Deflater.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ZipEntry

        public ZipEntry​(java.lang.String name)
        Creates a new zip entry with the specified name.
        Parameters:
        name - the entry name
        Throws:
        java.lang.NullPointerException - if the entry name is null
        java.lang.IllegalArgumentException - if the entry name is longer than 0xFFFF bytes
        Since:
        TotalCross 1.20
      • ZipEntry

        public ZipEntry​(ZipEntry e)
        Creates a new zip entry with fields taken from the specified zip entry.
        Parameters:
        e - a zip Entry object
        Since:
        TotalCross 1.23
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the name of the entry.
        Returns:
        the name of the entry
        Since:
        TotalCross 1.20
      • 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
        Since:
        TotalCross 1.23
      • 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
        Since:
        TotalCross 1.23
      • setSize

        public void setSize​(long size)
        Sets the uncompressed size of the entry data.
        Parameters:
        size - the uncompressed size in bytes
        Throws:
        java.lang.IllegalArgumentException - if the specified size is less than 0 or greater than 0xFFFFFFFF bytes
        Since:
        TotalCross 1.23
      • 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
        Since:
        TotalCross 1.23
      • setCompressedSize

        public void setCompressedSize​(long csize)
        Sets the size of the compressed entry data.
        Parameters:
        csize - the compressed size to set to
        Since:
        TotalCross 1.23
      • 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
        Since:
        TotalCross 1.23
      • setCrc

        public void setCrc​(long crc)
        Sets the CRC-32 checksum of the uncompressed entry data.
        Parameters:
        crc - the CRC-32 value
        Throws:
        java.lang.IllegalArgumentException - if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFF
        Since:
        TotalCross 1.23
      • 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
        Since:
        TotalCross 1.23
      • setMethod

        public void setMethod​(int method)
        Sets the compression method for the entry.
        Parameters:
        method - the compression method, either STORED or DEFLATED
        Throws:
        java.lang.IllegalArgumentException - if the specified compression method is invalid
        Since:
        TotalCross 1.23
      • 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
        Since:
        TotalCross 1.23
      • setExtra

        public void setExtra​(byte[] extra)
        Sets the optional extra field data for the entry.
        Parameters:
        extra - the extra field data bytes
        Throws:
        java.lang.IllegalArgumentException - if the length of the specified extra field data is greater than 0xFFFF bytes
        Since:
        TotalCross 1.23
      • 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
        Since:
        TotalCross 1.23
      • setComment

        public void setComment​(java.lang.String comment)
        Sets the optional comment string for the entry.
        Parameters:
        comment - the comment string
        Throws:
        java.lang.IllegalArgumentException - if the length of the specified comment string is greater than 0xFFFF bytes
        Since:
        TotalCross 1.23
      • getComment

        public java.lang.String getComment()
        Returns the comment string for the entry, or null if none.
        Returns:
        the comment string for the entry, or null if none
        Since:
        TotalCross 1.23
      • 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
        Since:
        TotalCross 1.23
      • toString

        public java.lang.String toString()
        Returns a string representation of the ZIP entry. This is just the name as returned by getName().
        Overrides:
        toString in class java.lang.Object
        Since:
        TotalCross 1.23
      • hashCode

        public int hashCode()
        Returns the hash code value for this entry. This is just the hashCode of the name returned by getName().
        Note that the equals method isn't changed, though.
        Overrides:
        hashCode in class java.lang.Object
        Since:
        TotalCross 1.23