java.util.zip
Class ZipEntry

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

Direct Known Subclasses:

JarEntry

public class ZipEntry

extends Object

implements java.util.zip.ZipConstants, Cloneable

This class is used to represent a ZIP file entry.

Field Summary

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

Fields inherited from interface java.util.zip.ZipConstants

CENATT, CENATX, CENCOM, CENCRC, CENDSK, CENEXT, CENFLG, CENHDR, CENHOW, CENLEN, CENNAM, CENOFF, CENSIG, CENSIZ, CENTIM, CENVEM, CENVER, ENDCOM, ENDHDR, ENDOFF, ENDSIG, ENDSIZ, ENDSUB, ENDTOT, EXTCRC, EXTHDR, EXTLEN, EXTSIG, EXTSIZ, LOCCRC, LOCEXT, LOCFLG, LOCHDR, LOCHOW, LOCLEN, LOCNAM, LOCSIG, LOCSIZ, LOCTIM, LOCVER

Constructor Summary

ZipEntry(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

Object	clone() Returns a copy of this entry.
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.
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(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.
String	toString() Returns a string representation of the ZIP entry.

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STORED

public static final int STORED

Compression method for uncompressed entries.

DEFLATED

public static final int DEFLATED

Compression method for compressed (deflated) entries.

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.

Method Detail

getName

public String getName()

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

getTime

public long getTime()

Returns the modification time of the entry, or -1 if not specified.

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

getSize

public long getSize()

Returns the uncompressed size of the entry data, or -1 if not known.

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.

setCompressedSize

public void setCompressedSize(long csize)

Sets the size of the compressed entry data.

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

getCrc

public long getCrc()

Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.

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

getMethod

public int getMethod()

Returns the compression method of the entry, or -1 if not specified.

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

getExtra

public byte[] getExtra()

Returns the extra field data for the entry, or null if none.

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

getComment

public String getComment()

Returns the comment string for the entry, or null if none.

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

toString

public String toString()

Returns a string representation of the ZIP entry.

Overrides:

toString in class Object

Tags copied from class: Object

Returns:

a string representation of the object.

hashCode

public int hashCode()

Returns the hash code value for this entry.

Overrides:

hashCode in class Object

Tags copied from class: Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), Hashtable

clone

public Object clone()

Returns a copy of this entry.

Overrides:

clone in class Object

Tags copied from class: Object

Returns:

a clone of this instance.

Throws:

CloneNotSupportedException - if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

OutOfMemoryError - if there is not enough memory.

See Also:

Cloneable