net.sf.zipme
Class ZipEntry

java.lang.Object
  net.sf.zipme.ZipEntry

All Implemented Interfaces:

net.sf.zipme.ZipConstants

public class ZipEntry

extends java.lang.Object

implements net.sf.zipme.ZipConstants

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	CENATT
static int	CENATX
static int	CENCOM
static int	CENCRC
static int	CENDSK
static int	CENEXT
static int	CENFLG
static int	CENHDR
static int	CENHOW
static int	CENLEN
static int	CENNAM
static int	CENOFF
static long	CENSIG
static int	CENSIZ
static int	CENTIM
static int	CENVEM
static int	CENVER
static int	DEFLATED Compression method.
static int	ENDCOM
static int	ENDHDR
static int	ENDOFF
static long	ENDSIG
static int	ENDSIZ
static int	ENDSUB
static int	ENDTOT
static int	EXTCRC
static int	EXTHDR
static int	EXTLEN
static long	EXTSIG
static int	EXTSIZ
static int	LOCCRC
static int	LOCEXT
static int	LOCFLG
static int	LOCHDR
static int	LOCHOW
static int	LOCLEN
static int	LOCNAM
static long	LOCSIG
static int	LOCSIZ
static int	LOCTIM
static int	LOCVER
static int	STORED Compression method.

Constructor Summary

ZipEntry(java.lang.String name)
Creates a zip entry with the given name.

ZipEntry(ZipEntry e)
Creates a copy of the given zip entry.

Method Summary

java.lang.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.
java.lang.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(java.lang.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.
java.lang.String	toString() Gets the string representation of this ZipEntry.

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

LOCHDR

public static final int LOCHDR

See Also:

Constant Field Values

LOCSIG

public static final long LOCSIG

See Also:

Constant Field Values

LOCVER

public static final int LOCVER

See Also:

Constant Field Values

LOCFLG

public static final int LOCFLG

See Also:

Constant Field Values

LOCHOW

public static final int LOCHOW

See Also:

Constant Field Values

LOCTIM

public static final int LOCTIM

See Also:

Constant Field Values

LOCCRC

public static final int LOCCRC

See Also:

Constant Field Values

LOCSIZ

public static final int LOCSIZ

See Also:

Constant Field Values

LOCLEN

public static final int LOCLEN

See Also:

Constant Field Values

LOCNAM

public static final int LOCNAM

See Also:

Constant Field Values

LOCEXT

public static final int LOCEXT

See Also:

Constant Field Values

EXTSIG

public static final long EXTSIG

See Also:

Constant Field Values

EXTHDR

public static final int EXTHDR

See Also:

Constant Field Values

EXTCRC

public static final int EXTCRC

See Also:

Constant Field Values

EXTSIZ

public static final int EXTSIZ

See Also:

Constant Field Values

EXTLEN

public static final int EXTLEN

See Also:

Constant Field Values

CENSIG

public static final long CENSIG

See Also:

Constant Field Values

CENHDR

public static final int CENHDR

See Also:

Constant Field Values

CENVEM

public static final int CENVEM

See Also:

Constant Field Values

CENVER

public static final int CENVER

See Also:

Constant Field Values

CENFLG

public static final int CENFLG

See Also:

Constant Field Values

CENHOW

public static final int CENHOW

See Also:

Constant Field Values

CENTIM

public static final int CENTIM

See Also:

Constant Field Values

CENCRC

public static final int CENCRC

See Also:

Constant Field Values

CENSIZ

public static final int CENSIZ

See Also:

Constant Field Values

CENLEN

public static final int CENLEN

See Also:

Constant Field Values

CENNAM

public static final int CENNAM

See Also:

Constant Field Values

CENEXT

public static final int CENEXT

See Also:

Constant Field Values

CENCOM

public static final int CENCOM

See Also:

Constant Field Values

CENDSK

public static final int CENDSK

See Also:

Constant Field Values

CENATT

public static final int CENATT

See Also:

Constant Field Values

CENATX

public static final int CENATX

See Also:

Constant Field Values

CENOFF

public static final int CENOFF

See Also:

Constant Field Values

ENDSIG

public static final long ENDSIG

See Also:

Constant Field Values

ENDHDR

public static final int ENDHDR

See Also:

Constant Field Values

ENDSUB

public static final int ENDSUB

See Also:

Constant Field Values

ENDTOT

public static final int ENDTOT

See Also:

Constant Field Values

ENDSIZ

public static final int ENDSIZ

See Also:

Constant Field Values

ENDOFF

public static final int ENDOFF

See Also:

Constant Field Values

ENDCOM

public static final int ENDCOM

See Also:

Constant Field Values

Constructor Detail

ZipEntry

public ZipEntry(java.lang.String name)

Creates a zip entry with the given name.

Parameters:

name - the name. May include directory components separated by '/'.

Throws:

java.lang.NullPointerException - when name is null.

java.lang.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

getName

public java.lang.String getName()

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

setTime

public void setTime(long time)

Sets the time of last modification of the entry.

Parameters:

time - the time of last modification of the entry.

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.

setSize

public void setSize(long size)

Sets the size of the uncompressed data.

Throws:

java.lang.IllegalArgumentException - if size is not in 0..0xffffffffL

getSize

public long getSize()

Gets the size of the uncompressed data.

Returns:

the size or -1 if unknown.

setCompressedSize

public void setCompressedSize(long csize)

Sets the size of the compressed data.

getCompressedSize

public long getCompressedSize()

Gets the size of the compressed data.

Returns:

the size or -1 if unknown.

setCrc

public void setCrc(long crc)

Sets the crc of the uncompressed data.

Throws:

java.lang.IllegalArgumentException - if crc is not in 0..0xffffffffL

getCrc

public long getCrc()

Gets the crc of the uncompressed data.

Returns:

the crc or -1 if unknown.

setMethod

public void setMethod(int method)

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

Throws:

java.lang.IllegalArgumentException - if method is not supported.

See Also:

ZipOutputStream.DEFLATED, ZipOutputStream.STORED

getMethod

public int getMethod()

Gets the compression method.

Returns:

the compression method or -1 if unknown.

setExtra

public void setExtra(byte[] extra)

Sets the extra data.

Throws:

java.lang.IllegalArgumentException - if extra is longer than 0xffff bytes.

getExtra

public byte[] getExtra()

Gets the extra data.

Returns:

the extra data or null if not set.

setComment

public void setComment(java.lang.String comment)

Sets the entry comment.

Throws:

java.lang.IllegalArgumentException - if comment is longer than 0xffff.

getComment

public java.lang.String getComment()

Gets the comment.

Returns:

the comment or null if not set.

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.

toString

public java.lang.String toString()

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

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.