org.apache.tools.zip

Class ZipEntry

public class ZipEntry extends ZipEntry implements Cloneable

Extension that adds better handling of extra fields and provides access to the internal and external file attributes.

The extra data is expected to follow the recommendation of the .ZIP File Format Specification created by PKWARE Inc. :

Any extra data that cannot be parsed by the rules above will be consumed as "unparseable" extra data and treated differently by the methods of this class. Versions prior to Apache Commons Compress 1.1 would have thrown an exception if any attempt was made to read or write extra data not conforming to the recommendation.

See Also: .ZIP File Format Specification

Field Summary
static intPLATFORM_FAT
static intPLATFORM_UNIX
Constructor Summary
ZipEntry(String name)
Creates a new zip entry with the specified name.
ZipEntry(ZipEntry entry)
Creates a new zip entry with fields taken from the specified zip entry.
ZipEntry(ZipEntry entry)
Creates a new zip entry with fields taken from the specified zip entry.
protected ZipEntry()
Method Summary
voidaddAsFirstExtraField(ZipExtraField ze)
Adds an extra field - replacing an already present extra field of the same type.
voidaddExtraField(ZipExtraField ze)
Adds an extra field - replacing an already present extra field of the same type.
Objectclone()
Overwrite clone.
booleanequals(Object o)
The equality method.
byte[]getCentralDirectoryExtra()
Retrieves the extra data for the central directory.
longgetExternalAttributes()
Retrieves the external file attributes.
ZipExtraFieldgetExtraField(ZipShort type)
Looks up an extra field by its header id.
ZipExtraField[]getExtraFields()
Retrieves all extra fields that have been parsed successfully.
ZipExtraField[]getExtraFields(boolean includeUnparseable)
Retrieves extra fields.
intgetInternalAttributes()
Retrieves the internal file attributes.
byte[]getLocalFileDataExtra()
Retrieves the extra data for the local file data.
StringgetName()
Get the name of the entry.
intgetPlatform()
Platform specification to put into the "version made by" part of the central file header.
intgetUnixMode()
Unix permission.
UnparseableExtraFieldDatagetUnparseableExtraFieldData()
Looks up extra field data that couldn't be parsed correctly.
inthashCode()
Get the hashCode of the entry.
booleanisDirectory()
Is this entry a directory?
voidremoveExtraField(ZipShort type)
Remove an extra field.
voidremoveUnparseableExtraFieldData()
Removes unparseable extra field data.
voidsetCentralDirectoryExtra(byte[] b)
Sets the central directory part of extra fields.
voidsetComprSize(long size)
Make this class work in JDK 1.1 like a 1.2 class.
voidsetExternalAttributes(long value)
Sets the external file attributes.
voidsetExtra(byte[] extra)
Parses the given bytes as extra field data and consumes any unparseable data as an UnparseableExtraFieldData instance.
protected voidsetExtra()
Unfortunately java.util.zip.ZipOutputStream java.util.zip.ZipOutputStream seems to access the extra data directly, so overriding getExtra doesn't help - we need to modify super's data directly.
voidsetExtraFields(ZipExtraField[] fields)
Replaces all currently attached extra fields with the new array.
voidsetInternalAttributes(int value)
Sets the internal file attributes.
protected voidsetName(String name)
Set the name of the entry.
protected voidsetPlatform(int platform)
Set the platform (UNIX or FAT).
voidsetUnixMode(int mode)
Sets Unix permissions in a way that is understood by Info-Zip's unzip command.

Field Detail

PLATFORM_FAT

public static final int PLATFORM_FAT

PLATFORM_UNIX

public static final int PLATFORM_UNIX

Constructor Detail

ZipEntry

public ZipEntry(String name)
Creates a new zip entry with the specified name.

Parameters: name the name of the entry

Since: 1.1

ZipEntry

public ZipEntry(ZipEntry entry)
Creates a new zip entry with fields taken from the specified zip entry.

Parameters: entry the entry to get fields from

Throws: ZipException on error

Since: 1.1

ZipEntry

public ZipEntry(ZipEntry entry)
Creates a new zip entry with fields taken from the specified zip entry.

Parameters: entry the entry to get fields from

Throws: ZipException on error

Since: 1.1

ZipEntry

protected ZipEntry()

Since: 1.9

Method Detail

addAsFirstExtraField

public void addAsFirstExtraField(ZipExtraField ze)
Adds an extra field - replacing an already present extra field of the same type.

The new extra field will be the first one.

Parameters: ze an extra field

Since: 1.1

addExtraField

public void addExtraField(ZipExtraField ze)
Adds an extra field - replacing an already present extra field of the same type.

If no extra field of the same type exists, the field will be added as last field.

Parameters: ze an extra field

Since: 1.1

clone

public Object clone()
Overwrite clone.

Returns: a cloned copy of this ZipEntry

Since: 1.1

equals

public boolean equals(Object o)
The equality method. In this case, the implementation returns 'this == o' which is basically the equals method of the Object class.

Parameters: o the object to compare to

Returns: true if this object is the same as o

Since: Ant 1.7

getCentralDirectoryExtra

public byte[] getCentralDirectoryExtra()
Retrieves the extra data for the central directory.

Returns: the central directory extra data

Since: 1.1

getExternalAttributes

public long getExternalAttributes()
Retrieves the external file attributes.

Returns: the external file attributes

Since: 1.1

getExtraField

public ZipExtraField getExtraField(ZipShort type)
Looks up an extra field by its header id.

Returns: null if no such field exists.

getExtraFields

public ZipExtraField[] getExtraFields()
Retrieves all extra fields that have been parsed successfully.

Returns: an array of the extra fields

getExtraFields

public ZipExtraField[] getExtraFields(boolean includeUnparseable)
Retrieves extra fields.

Parameters: includeUnparseable whether to also return unparseable extra fields as UnparseableExtraFieldData if such data exists.

Returns: an array of the extra fields

Since: 1.1

getInternalAttributes

public int getInternalAttributes()
Retrieves the internal file attributes.

Returns: the internal file attributes

Since: 1.1

getLocalFileDataExtra

public byte[] getLocalFileDataExtra()
Retrieves the extra data for the local file data.

Returns: the extra data for local file

Since: 1.1

getName

public String getName()
Get the name of the entry.

Returns: the entry name

Since: 1.9

getPlatform

public int getPlatform()
Platform specification to put into the "version made by" part of the central file header.

Returns: PLATFORM_FAT unless setUnixMode has been called, in which case PLATORM_UNIX will be returned.

Since: Ant 1.5.2

getUnixMode

public int getUnixMode()
Unix permission.

Returns: the unix permissions

Since: Ant 1.6

getUnparseableExtraFieldData

public UnparseableExtraFieldData getUnparseableExtraFieldData()
Looks up extra field data that couldn't be parsed correctly.

Returns: null if no such field exists.

hashCode

public int hashCode()
Get the hashCode of the entry. This uses the name as the hashcode.

Returns: a hashcode.

Since: Ant 1.7

isDirectory

public boolean isDirectory()
Is this entry a directory?

Returns: true if the entry is a directory

Since: 1.10

removeExtraField

public void removeExtraField(ZipShort type)
Remove an extra field.

Parameters: type the type of extra field to remove

Since: 1.1

removeUnparseableExtraFieldData

public void removeUnparseableExtraFieldData()
Removes unparseable extra field data.

setCentralDirectoryExtra

public void setCentralDirectoryExtra(byte[] b)
Sets the central directory part of extra fields.

setComprSize

public void setComprSize(long size)

Deprecated: since 1.7. Use setCompressedSize directly.

Make this class work in JDK 1.1 like a 1.2 class.

This either stores the size for later usage or invokes setCompressedSize via reflection.

Parameters: size the size to use

Since: 1.2

setExternalAttributes

public void setExternalAttributes(long value)
Sets the external file attributes.

Parameters: value an long value

Since: 1.1

setExtra

public void setExtra(byte[] extra)
Parses the given bytes as extra field data and consumes any unparseable data as an UnparseableExtraFieldData instance.

Parameters: extra an array of bytes to be parsed into extra fields

Throws: RuntimeException if the bytes cannot be parsed RuntimeException on error

Since: 1.1

setExtra

protected void setExtra()
Unfortunately java.util.zip.ZipOutputStream java.util.zip.ZipOutputStream seems to access the extra data directly, so overriding getExtra doesn't help - we need to modify super's data directly.

Since: 1.1

setExtraFields

public void setExtraFields(ZipExtraField[] fields)
Replaces all currently attached extra fields with the new array.

Parameters: fields an array of extra fields

Since: 1.1

setInternalAttributes

public void setInternalAttributes(int value)
Sets the internal file attributes.

Parameters: value an int value

Since: 1.1

setName

protected void setName(String name)
Set the name of the entry.

Parameters: name the name to use

setPlatform

protected void setPlatform(int platform)
Set the platform (UNIX or FAT).

Parameters: platform an int value - 0 is FAT, 3 is UNIX

Since: 1.9

setUnixMode

public void setUnixMode(int mode)
Sets Unix permissions in a way that is understood by Info-Zip's unzip command.

Parameters: mode an int value

Since: Ant 1.5.2