org.apache.tools.zip

Class ZipEntry

Implemented Interfaces:
Cloneable

public class ZipEntry
extends java.util.zip.ZipEntry
implements Cloneable

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

Constructor Summary

ZipEntry()
ZipEntry(String name)
Creates a new zip entry with the specified name.
ZipEntry(java.util.zip.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.

Method Summary

void
addExtraField(ZipExtraField ze)
Adds an extra fields - replacing an already present extra field of the same type.
Object
clone()
Overwrite clone
byte[]
getCentralDirectoryExtra()
Retrieves the extra data for the central directory.
long
getCompressedSize()
Override to make this class work in JDK 1.1 like a 1.2 class.
long
getExternalAttributes()
Retrieves the external file attributes.
ZipExtraField[]
getExtraFields()
Retrieves extra fields.
int
getInternalAttributes()
Retrieves the internal file attributes.
byte[]
getLocalFileDataExtra()
Retrieves the extra data for the local file data.
String
getName()
int
getPlatform()
Platform specification to put into the "version made by" part of the central file header.
int
getUnixMode()
Unix permission.
boolean
isDirectory()
void
removeExtraField(ZipShort type)
Remove an extra fields.
void
setComprSize(long size)
Make this class work in JDK 1.1 like a 1.2 class.
void
setExternalAttributes(long value)
Sets the external file attributes.
protected void
setExtra()
Unfortunately 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.
void
setExtra(byte[] extra)
Throws an Exception if extra data cannot be parsed into extra fields.
void
setExtraFields(ZipExtraField[] fields)
Replaces all currently attached extra fields with the new array.
void
setInternalAttributes(int value)
Sets the internal file attributes.
protected void
setName(String name)
protected void
setPlatform(int platform)
void
setUnixMode(int mode)
Sets Unix permissions in a way that is understood by Info-Zip's unzip command.

Constructor Details

ZipEntry

protected ZipEntry()
Since:
1.9

ZipEntry

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

ZipEntry

public ZipEntry(java.util.zip.ZipEntry entry)
            throws ZipException
Creates a new zip entry with fields taken from the specified zip entry.
Since:
1.1

ZipEntry

public ZipEntry(ZipEntry entry)
            throws ZipException
Creates a new zip entry with fields taken from the specified zip entry.
Since:
1.1

Method Details

addExtraField

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

clone

public Object clone()
Overwrite clone
Since:
1.1

getCentralDirectoryExtra

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

getCompressedSize

public long getCompressedSize()
Override to make this class work in JDK 1.1 like a 1.2 class.
Since:
1.2

getExternalAttributes

public long getExternalAttributes()
Retrieves the external file attributes.
Since:
1.1

getExtraFields

public ZipExtraField[] getExtraFields()
Retrieves extra fields.
Since:
1.1

getInternalAttributes

public int getInternalAttributes()
Retrieves the internal file attributes.
Since:
1.1

getLocalFileDataExtra

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

getName

public String getName()
Since:
1.9

getPlatform

public int getPlatform()
Platform specification to put into the "version made by" part of the central file header.
Returns:
0 (MS-DOS FAT) unless setUnixMode has been called, in which case 3 (Unix) will be returned.
Since:
Ant 1.5.2

getUnixMode

public int getUnixMode()
Unix permission.
Since:
Ant 1.6

isDirectory

public boolean isDirectory()
Since:
1.10

removeExtraField

public void removeExtraField(ZipShort type)
Remove an extra fields.
Since:
1.1

setComprSize

public void setComprSize(long size)
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.

Since:
1.2

setExternalAttributes

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

setExtra

protected void setExtra()
Unfortunately 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

setExtra

public void setExtra(byte[] extra)
            throws RuntimeException
Throws an Exception if extra data cannot be parsed into extra fields.
Since:
1.1

setExtraFields

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

setInternalAttributes

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

setName

protected void setName(String name)

setPlatform

protected void setPlatform(int platform)
Since:
1.9

setUnixMode

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

Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.