java.util.zip

Class ZipEntry

public class ZipEntry extends Object implements ZipConstants, Cloneable

This class represents a member of a zip archive. ZipFile and ZipInputStream will give you instances of this class as information about the members in an archive. On the other hand ZipOutputStream needs an instance of this class to create a new member.

Field Summary
static int	DEFLATED Compression method.
static int	STORED Compression method.

Constructor Summary
	ZipEntry(String name) Creates a zip entry with the given name.
	ZipEntry(ZipEntry e) Creates a copy of the given zip entry.

Method Summary
Object	clone() Clones the entry.
String	getComment() Gets the comment.
long	getCompressedSize() Gets the size of the compressed data.
long	getCrc() Gets the crc of the uncompressed data.
byte[]	getExtra() Gets the extra data.
int	getMethod() Gets the compression method.
String	getName() Returns the entry name.
long	getSize() Gets the size of the uncompressed data.
long	getTime() Gets the time of last modification of the entry.
int	hashCode() Gets the hashCode of this ZipEntry.
boolean	isDirectory() Gets true, if the entry is a directory.
void	setComment(String comment) Sets the entry comment.
void	setCompressedSize(long csize) Sets the size of the compressed data.
void	setCrc(long crc) Sets the crc of the uncompressed data.
void	setExtra(byte[] extra) Sets the extra data.
void	setMethod(int method) Sets the compression method.
void	setSize(long size) Sets the size of the uncompressed data.
void	setTime(long time) Sets the time of last modification of the entry.
String	toString() Gets the string representation of this ZipEntry.

Field Detail

DEFLATED

public static final int DEFLATED

Compression method. This method uses the Deflater.

STORED

public static final int STORED

Compression method. This method doesn't compress at all.

Constructor Detail

ZipEntry

public ZipEntry(String name)

Creates a zip entry with the given name.

Parameters: name the name. May include directory components separated by '/'.

Throws: NullPointerException when name is null. IllegalArgumentException when name is bigger then 65535 chars.

ZipEntry

public ZipEntry(ZipEntry e)

Creates a copy of the given zip entry.

Parameters: e the entry to copy.

Method Detail

clone

public Object clone()

Clones the entry.

getComment

public String getComment()

Gets the comment.

Returns: the comment or null if not set.

getCompressedSize

public long getCompressedSize()

Gets the size of the compressed data.

Returns: the size or -1 if unknown.

getCrc

public long getCrc()

Gets the crc of the uncompressed data.

Returns: the crc or -1 if unknown.

getExtra

public byte[] getExtra()

Gets the extra data.

Returns: the extra data or null if not set.

getMethod

public int getMethod()

Gets the compression method.

Returns: the compression method or -1 if unknown.

getName

public String getName()

Returns the entry name. The path components in the entry are always separated by slashes ('/').

getSize

public long getSize()

Gets the size of the uncompressed data.

Returns: the size or -1 if unknown.

getTime

public long getTime()

Gets the time of last modification of the entry.

Returns: the time of last modification of the entry, or -1 if unknown.

hashCode

public int hashCode()

Gets the hashCode of this ZipEntry. This is just the hashCode of the name. Note that the equals method isn't changed, though.

isDirectory

public boolean isDirectory()

Gets true, if the entry is a directory. This is solely determined by the name, a trailing slash '/' marks a directory.

setComment

public void setComment(String comment)

Sets the entry comment.

Throws: IllegalArgumentException if comment is longer than 0xffff.

setCompressedSize

public void setCompressedSize(long csize)

Sets the size of the compressed data.

setCrc

public void setCrc(long crc)

Sets the crc of the uncompressed data.

Throws: IllegalArgumentException if crc is not in 0..0xffffffffL

setExtra

public void setExtra(byte[] extra)

Sets the extra data.

Throws: IllegalArgumentException if extra is longer than 0xffff bytes.

setMethod

public void setMethod(int method)

Sets the compression method. Only DEFLATED and STORED are supported.

Throws: IllegalArgumentException if method is not supported.

setSize

public void setSize(long size)

Sets the size of the uncompressed data.

Throws: IllegalArgumentException if size is not in 0..0xffffffffL

setTime

public void setTime(long time)

Sets the time of last modification of the entry.

UNKNOWN: the time of last modification of the entry.

toString

public String toString()

Gets the string representation of this ZipEntry. This is just the name as returned by getName().