org.apache.commons.compress.archivers.zip
Class ZipEntry

java.lang.Object
  extended by java.util.zip.ZipEntry
      extended by org.apache.commons.compress.archivers.zip.ZipEntry
All Implemented Interfaces:
Cloneable

public class ZipEntry
extends ZipEntry

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

Version:
$Revision: 155439 $
Author:
Stefan Bodewig

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 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
           
 
Fields inherited from class java.util.zip.ZipEntry
DEFLATED, STORED
 
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.
 
Method Summary
 void addExtraField(ZipExtraField extraField)
          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.
 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 externalAttributes)
          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.
 
Methods inherited from class java.util.zip.ZipEntry
getComment, getCrc, getExtra, getMethod, getName, getSize, getTime, hashCode, isDirectory, setComment, setCompressedSize, setCrc, setMethod, setSize, setTime, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

LOCSIG

public static final long LOCSIG
See Also:
Constant Field Values

EXTSIG

public static final long EXTSIG
See Also:
Constant Field Values

CENSIG

public static final long CENSIG
See Also:
Constant Field Values

ENDSIG

public static final long ENDSIG
See Also:
Constant Field Values

LOCHDR

public static final int LOCHDR
See Also:
Constant Field Values

EXTHDR

public static final int EXTHDR
See Also:
Constant Field Values

CENHDR

public static final int CENHDR
See Also:
Constant Field Values

ENDHDR

public static final int ENDHDR
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

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

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

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

Parameters:
name - the name of entry
Since:
1.1

ZipEntry

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

Parameters:
entry - the JDK ZipEntry to adapt
Throws:
ZipException - if can not create entry
Since:
1.1

ZipEntry

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

Parameters:
entry - the entry to adapt
Throws:
ZipException - if can not create entry
Since:
1.1
Method Detail

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.

Parameters:
size - The new ComprSize value
Since:
1.2

setExternalAttributes

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

Parameters:
externalAttributes - The new ExternalAttributes value
Since:
1.1

setExtra

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

Overrides:
setExtra in class ZipEntry
Parameters:
extra - The new Extra value
Throws:
RuntimeException - if fail to set extra data
Since:
1.1

setExtraFields

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

Parameters:
fields - The new ExtraFields value
Since:
1.1

setInternalAttributes

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

Parameters:
value - The new InternalAttributes value
Since:
1.1

getCentralDirectoryExtra

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

Returns:
The CentralDirectoryExtra value
Since:
1.1

getCompressedSize

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

Overrides:
getCompressedSize in class ZipEntry
Returns:
The CompressedSize value
Since:
1.2

getExternalAttributes

public long getExternalAttributes()
Retrieves the external file attributes.

Returns:
The ExternalAttributes value
Since:
1.1

getExtraFields

public ZipExtraField[] getExtraFields()
Retrieves extra fields.

Returns:
The ExtraFields value
Since:
1.1

getInternalAttributes

public int getInternalAttributes()
Retrieves the internal file attributes.

Returns:
The InternalAttributes value
Since:
1.1

getLocalFileDataExtra

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

Returns:
The LocalFileDataExtra value
Since:
1.1

addExtraField

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

Parameters:
extraField - The feature to be added to the ExtraField attribute
Since:
1.1

clone

public Object clone()
Overwrite clone

Overrides:
clone in class ZipEntry
Returns:
Description of the Returned Value
Since:
1.1

removeExtraField

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

Parameters:
type - Description of Parameter
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


Copyright © 2011 Apache Software Foundation. All Rights Reserved.