org.codehaus.plexus.archiver.zip
Class ZipEntry

java.lang.Object
  extended byjava.util.zip.ZipEntry
      extended byorg.codehaus.plexus.archiver.zip.ZipEntry
All Implemented Interfaces:
java.lang.Cloneable, java.util.zip.ZipConstants

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

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

Version:
$Revision: 2436 $ $Date: 2005-09-01 19:20:41 +0200 (Thu, 01 Sep 2005) $ from org.apache.ant.tools.zip.ZipEntry v1.16

Field Summary
private  java.lang.Long compressedSize
          Helper for JDK 1.1 <-> 1.2 incompatibility.
private  long externalAttributes
           
private  java.util.Vector extraFields
           
private  int internalAttributes
           
private static java.lang.Object lockReflection
          Helper for JDK 1.1
private  java.lang.String name
           
private  int platform
           
private static int PLATFORM_FAT
           
private static int PLATFORM_UNIX
           
private static java.lang.reflect.Method setCompressedSizeMethod
          Helper for JDK 1.1
private static boolean triedToGetMethod
          Helper for JDK 1.1
 
Fields inherited from class java.util.zip.ZipEntry
CENATT, CENATX, CENCOM, CENCRC, CENDSK, CENEXT, CENFLG, CENHDR, CENHOW, CENLEN, CENNAM, CENOFF, CENSIG, CENSIZ, CENTIM, CENVEM, CENVER, DEFLATED, ENDCOM, ENDHDR, ENDOFF, ENDSIG, ENDSIZ, ENDSUB, ENDTOT, EXTCRC, EXTHDR, EXTLEN, EXTSIG, EXTSIZ, LOCCRC, LOCEXT, LOCFLG, LOCHDR, LOCHOW, LOCLEN, LOCNAM, LOCSIG, LOCSIZ, LOCTIM, LOCVER, STORED
 
Constructor Summary
protected ZipEntry()
           
  ZipEntry(java.lang.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.
private static void checkSCS()
          Try to get a handle to the setCompressedSize method.
 java.lang.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.
 java.lang.String getName()
           
 int getPlatform()
          Platform specification to put into the "version made by" part of the central file header.
 int getUnixMode()
          Unix permission.
private static boolean haveSetCompressedSize()
          Are we running JDK 1.2 or higher?
 boolean isDirectory()
           
private static void performSetCompressedSize(ZipEntry ze, long size)
          Invoke setCompressedSize via reflection.
 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(java.lang.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.
 
Methods inherited from class java.util.zip.ZipEntry
getComment, getCrc, getExtra, getMethod, getSize, getTime, hashCode, setComment, setCompressedSize, setCrc, setMethod, setSize, setTime, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

PLATFORM_UNIX

private static final int PLATFORM_UNIX
See Also:
Constant Field Values

PLATFORM_FAT

private static final int PLATFORM_FAT
See Also:
Constant Field Values

internalAttributes

private int internalAttributes

platform

private int platform

externalAttributes

private long externalAttributes

extraFields

private java.util.Vector extraFields

name

private java.lang.String name

compressedSize

private java.lang.Long compressedSize
Helper for JDK 1.1 <-> 1.2 incompatibility.

Since:
1.2

setCompressedSizeMethod

private static java.lang.reflect.Method setCompressedSizeMethod
Helper for JDK 1.1

Since:
1.2

lockReflection

private static final java.lang.Object lockReflection
Helper for JDK 1.1

Since:
1.2

triedToGetMethod

private static boolean triedToGetMethod
Helper for JDK 1.1

Since:
1.2
Constructor Detail

ZipEntry

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

Since:
1.1

ZipEntry

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

Since:
1.1

ZipEntry

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

Since:
1.1

ZipEntry

protected ZipEntry()
Since:
1.9
Method Detail

clone

public java.lang.Object clone()
Overwrite clone

Since:
1.1

getInternalAttributes

public int getInternalAttributes()
Retrieves the internal file attributes.

Since:
1.1

setInternalAttributes

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

Since:
1.1

getExternalAttributes

public long getExternalAttributes()
Retrieves the external file attributes.

Since:
1.1

setExternalAttributes

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

Since:
1.1

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

getUnixMode

public int getUnixMode()
Unix permission.

Since:
Ant 1.6

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

setPlatform

protected void setPlatform(int platform)
Since:
1.9

setExtraFields

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

Since:
1.1

getExtraFields

public ZipExtraField[] getExtraFields()
Retrieves extra fields.

Since:
1.1

addExtraField

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

Since:
1.1

removeExtraField

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

Since:
1.1

setExtra

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

Throws:
java.lang.RuntimeException
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

getLocalFileDataExtra

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

Since:
1.1

getCentralDirectoryExtra

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

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

getCompressedSize

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

Since:
1.2

getName

public java.lang.String getName()
Since:
1.9

isDirectory

public boolean isDirectory()
Since:
1.10

setName

protected void setName(java.lang.String name)

haveSetCompressedSize

private static boolean haveSetCompressedSize()
Are we running JDK 1.2 or higher?

Since:
1.2

performSetCompressedSize

private static void performSetCompressedSize(ZipEntry ze,
                                             long size)
Invoke setCompressedSize via reflection.

Since:
1.2

checkSCS

private static void checkSCS()
Try to get a handle to the setCompressedSize method.

Since:
1.2