ZipEntry (moe.ios.core API)

java.lang.Object
- java.util.zip.ZipEntry

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

JarEntry
```
public class ZipEntry
extends Object
implements Cloneable
```
An entry within a zip file. An entry has attributes such as its name (which is actually a path) and the uncompressed size of the corresponding data. An entry does not contain the data itself, but can be used as a key with ZipFile.getInputStream(java.util.zip.ZipEntry). The class documentation for ZipInputStream and ZipOutputStream shows how ZipEntry is used in conjunction with those two classes.

Field Summary

Fields
Modifier and Type	Field and Description
`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` Zip entry state: Deflated.
`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` Zip entry state: Stored.

Constructor Summary

Constructors
Constructor and Description
`ZipEntry(String name)` Constructs a new `ZipEntry` with the specified name.
`ZipEntry(String name, String comment, long crc, long compressedSize, long size, int compressionMethod, int time, int modDate, byte[] extra, long localHeaderRelOffset, long dataOffset)`
`ZipEntry(ZipEntry ze)` Constructs a new `ZipEntry` using the values obtained from `ze`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Returns a deep copy of this zip entry.
`String`	`getComment()` Returns the comment for this `ZipEntry`, or `null` if there is no comment.
`long`	`getCompressedSize()` Gets the compressed size of this `ZipEntry`.
`long`	`getCrc()` Gets the checksum for this `ZipEntry`.
`long`	`getDataOffset()`
`byte[]`	`getExtra()` Gets the extra information for this `ZipEntry`.
`int`	`getMethod()` Gets the compression method for this `ZipEntry`.
`String`	`getName()` Gets the name of this `ZipEntry`.
`long`	`getSize()` Gets the uncompressed size of this `ZipEntry`.
`long`	`getTime()` Gets the last modification time of this `ZipEntry`.
`int`	`hashCode()` Returns the hash code for this `ZipEntry`.
`boolean`	`isDirectory()` Determine whether or not this `ZipEntry` is a directory.
`void`	`setComment(String comment)` Sets the comment for this `ZipEntry`.
`void`	`setCompressedSize(long value)` Sets the compressed size for this `ZipEntry`.
`void`	`setCrc(long value)` Sets the checksum for this `ZipEntry`.
`void`	`setDataOffset(long value)`
`void`	`setExtra(byte[] data)` Sets the extra information for this `ZipEntry`.
`void`	`setMethod(int value)` Sets the compression method for this entry to either `DEFLATED` or `STORED`.
`void`	`setSize(long value)` Sets the uncompressed size of this `ZipEntry`.
`void`	`setTime(long value)` Sets the modification time of this `ZipEntry`.
`String`	`toString()` Returns the string representation of this `ZipEntry`.

Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFLATED
```
public static final int DEFLATED
```
    Zip entry state: Deflated.
    
    See Also:
    
    Constant Field Values
  - STORED
```
public static final int STORED
```
    Zip entry state: Stored.
    
    See Also:
    
    Constant Field Values
  - 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,
                String comment,
                long crc,
                long compressedSize,
                long size,
                int compressionMethod,
                int time,
                int modDate,
                byte[] extra,
                long localHeaderRelOffset,
                long dataOffset)
```
  - ZipEntry
```
public ZipEntry(String name)
```
    Constructs a new ZipEntry with the specified name. The name is actually a path, and may contain / characters.
    
    Throws:
    
    IllegalArgumentException - if the name length is outside the range (> 0xFFFF).
  - ZipEntry
```
public ZipEntry(ZipEntry ze)
```
    Constructs a new ZipEntry using the values obtained from ze.
    
    Parameters:
    
    ze - the ZipEntry from which to obtain values.
- Method Detail
  - getComment
```
public String getComment()
```
    Returns the comment for this ZipEntry, or null if there is no comment. If we're reading a zip file using ZipInputStream, the comment is not available.
  - getCompressedSize
```
public long getCompressedSize()
```
    Gets the compressed size of this ZipEntry.
    
    Returns:
    
    the compressed size, or -1 if the compressed size has not been set.
  - getCrc
```
public long getCrc()
```
    Gets the checksum for this ZipEntry.
    
    Returns:
    
    the checksum, or -1 if the checksum has not been set.
  - getExtra
```
public byte[] getExtra()
```
    Gets the extra information for this ZipEntry.
    
    Returns:
    
    a byte array containing the extra information, or null if there is none.
  - getMethod
```
public int getMethod()
```
    Gets the compression method for this ZipEntry.
    
    Returns:
    
    the compression method, either DEFLATED, STORED or -1 if the compression method has not been set.
  - getName
```
public String getName()
```
    Gets the name of this ZipEntry.
    Security note: Entry names can represent relative paths. foo/../bar or ../bar/baz, for example. If the entry name is being used to construct a filename or as a path component, it must be validated or sanitized to ensure that files are not written outside of the intended destination directory.
    
    Returns:
    
    the entry name.
  - getSize
```
public long getSize()
```
    Gets the uncompressed size of this ZipEntry.
    
    Returns:
    
    the uncompressed size, or -1 if the size has not been set.
  - getTime
```
public long getTime()
```
    Gets the last modification time of this ZipEntry.
    
    Returns:
    
    the last modification time as the number of milliseconds since Jan. 1, 1970.
  - isDirectory
```
public boolean isDirectory()
```
    Determine whether or not this ZipEntry is a directory.
    
    Returns:
    
    true when this ZipEntry is a directory, false otherwise.
  - setComment
```
public void setComment(String comment)
```
    Sets the comment for this ZipEntry.
    
    Throws:
    
    IllegalArgumentException - if the comment is >= 64 Ki UTF-8 bytes.
  - setCompressedSize
```
public void setCompressedSize(long value)
```
    Sets the compressed size for this ZipEntry.
    
    Parameters:
    
    value - the compressed size (in bytes).
  - setCrc
```
public void setCrc(long value)
```
    Sets the checksum for this ZipEntry.
    
    Parameters:
    
    value - the checksum for this entry.
    
    Throws:
    
    IllegalArgumentException - if value is < 0 or > 0xFFFFFFFFL.
  - setExtra
```
public void setExtra(byte[] data)
```
    Sets the extra information for this ZipEntry.
    
    Throws:
    
    IllegalArgumentException - if the data length >= 64 KiB.
  - setMethod
```
public void setMethod(int value)
```
    Sets the compression method for this entry to either DEFLATED or STORED. The default is DEFLATED, which will cause the size, compressed size, and CRC to be set automatically, and the entry's data to be compressed. If you switch to STORED note that you'll have to set the size (or compressed size; they must be the same, but it's okay to only set one) and CRC yourself because they must appear before the user data in the resulting zip file. See setSize(long) and setCrc(long).
    
    Throws:
    
    IllegalArgumentException - when value is not DEFLATED or STORED.
  - setSize
```
public void setSize(long value)
```
    Sets the uncompressed size of this ZipEntry.
    
    Parameters:
    
    value - the uncompressed size for this entry.
    
    Throws:
    
    IllegalArgumentException - if value < 0.
  - setTime
```
public void setTime(long value)
```
    Sets the modification time of this ZipEntry.
    
    Parameters:
    
    value - the modification time as the number of milliseconds since Jan. 1, 1970.
  - setDataOffset
```
public void setDataOffset(long value)
```
  - getDataOffset
```
public long getDataOffset()
```
  - toString
```
public String toString()
```
    Returns the string representation of this ZipEntry.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of this ZipEntry.
  - clone
```
public Object clone()
```
    Returns a deep copy of this zip entry.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a copy of this object.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this ZipEntry.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code of the entry.
    
    See Also:
    
    Object.equals(java.lang.Object)

Class ZipEntry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFLATED

STORED

LOCSIG

EXTSIG

CENSIG

ENDSIG

LOCHDR

EXTHDR

CENHDR

ENDHDR

LOCVER

LOCFLG

LOCHOW

LOCTIM

LOCCRC

LOCSIZ

LOCLEN

LOCNAM

LOCEXT

EXTCRC

EXTSIZ

EXTLEN

CENVEM

CENVER

CENFLG

CENHOW

CENTIM

CENCRC

CENSIZ

CENLEN

CENNAM

CENEXT

CENCOM

CENDSK

CENATT

CENATX

CENOFF

ENDSUB

ENDTOT

ENDSIZ

ENDOFF

ENDCOM

Constructor Detail

ZipEntry

ZipEntry

ZipEntry

Method Detail

getComment

getCompressedSize

getCrc

getExtra

getMethod

getName

getSize

getTime

isDirectory

setComment

setCompressedSize

setCrc

setExtra

setMethod

setSize

setTime

setDataOffset

getDataOffset

toString

clone

hashCode