Class java.util.zip.ZipEntry
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.util.zip.ZipEntry

Object
   |
   +----java.util.zip.ZipEntry

public class ZipEntry
extends Object
implements ZipConstants
This class is used to represent a ZIP file entry.

Version:
1.18, 01/24/97
Author:
David Connelly

Variable Index

 o DEFLATED
Compression method for compressed (deflated) entries.
 o STORED
Compression method for uncompressed entries.

Constructor Index

 o java.util.zip.ZipEntry(String)
Creates a new ZIP file entry with the specified name.

Method Index

 o getComment()
Returns the comment string for the entry, or null if none.
 o getCompressedSize()
Returns the compressed size of the entry data, or -1 if not known.
 o getCrc()
Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.
 o getExtra()
Returns the extra field data for the entry, or null if none.
 o getMethod()
Returns the compression method of the entry, or -1 if not specified.
 o getName()
Returns the name of the entry.
 o getSize()
Returns the uncompressed size of the entry data, or -1 if not known.
 o getTime()
Returns the modification time of the entry, or -1 if not specified.
 o isDirectory()
Returns true if this is a directory entry.
 o setComment(String)
Sets the optional comment string for the entry.
 o setCrc(long)
Sets the CRC-32 checksum of the uncompressed entry data.
 o setExtra(byte[])
Sets the optional extra field data for the entry.
 o setMethod(int)
Sets the compression method for the entry.
 o setSize(long)
Sets the uncompressed size of the entry data.
 o setTime(long)
Sets the modification time of the entry.
 o toString()
Returns a string representation of the ZIP entry.

Variables

 o DEFLATED
public static final int DEFLATED
Compression method for compressed (deflated) entries.

 o STORED
public static final int STORED
Compression method for uncompressed entries.

Constructors

 o ZipEntry
public ZipEntry(String name)
Creates a new ZIP file entry with the specified name.

Parameters:
name - the entry name
Throws: NullPointerException
if the entry name is null
Throws: IllegalArgumentException
if the entry name is longer than 0xFFFF bytes

Methods

 o getComment
public java.lang.String getComment()
Returns the comment string for the entry, or null if none.

 o getCompressedSize
public long getCompressedSize()
Returns the compressed size of the 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.

 o getCrc
public long getCrc()
Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.

 o getExtra
public byte[] getExtra()
Returns the extra field data for the entry, or null if none.

 o getMethod
public int getMethod()
Returns the compression method of the entry, or -1 if not specified.

 o getName
public java.lang.String getName()
Returns the name of the entry.

 o getSize
public long getSize()
Returns the uncompressed size of the entry data, or -1 if not known.

 o getTime
public long getTime()
Returns the modification time of the entry, or -1 if not specified.

 o 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 '/'.

 o setComment
public void setComment(String comment)
Sets the optional comment string for the entry.

Parameters:
comment - the comment string
Throws: IllegalArgumentException
if the length of the specified comment string is greater than 0xFFFF bytes
 o 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
 o 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 0xFFFFF bytes
 o 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
 o 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 or greater than 0xFFFFFFFF bytes
 o 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
 o toString
public java.lang.String toString()
Returns a string representation of the ZIP entry.

Overrides:
toString in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index