Package totalcross.util.zip
Class ZipEntry
- java.lang.Object
-
- totalcross.util.zip.ZipEntry
-
public class ZipEntry extends java.lang.ObjectThis class is used to represent a ZIP file entry.- Since:
- TotalCross 1.20
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetComment()Returns the comment string for the entry, or null if none.longgetCompressedSize()Returns the size of the compressed entry data, or -1 if not known.longgetCrc()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.intgetMethod()Returns the compression method of the entry, or -1 if not specified.java.lang.StringgetName()Returns the name of the entry.longgetSize()Returns the uncompressed size of the entry data, or -1 if not known.longgetTime()Returns the modification time of the entry, or -1 if not specified.inthashCode()Returns the hash code value for this entry.booleanisDirectory()Returns true if this is a directory entry.voidsetComment(java.lang.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.voidsetExtra(byte[] extra)Sets the optional extra field data for 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 modification time of the entry.java.lang.StringtoString()Returns a string representation of the ZIP entry.
-
-
-
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 nulljava.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:
toStringin classjava.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:
hashCodein classjava.lang.Object- Since:
- TotalCross 1.23
-
-