ZipArchiveFakeEntry (poi-ooxml 5.5.1 API)

java.lang.Object
- java.util.zip.ZipEntry
- - org.apache.commons.compress.archivers.zip.ZipArchiveEntry
  - - org.apache.poi.openxml4j.util.ZipArchiveFakeEntry

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, org.apache.commons.compress.archivers.ArchiveEntry, org.apache.commons.compress.archivers.EntryStreamOffsets
```
public final class ZipArchiveFakeEntry
extends org.apache.commons.compress.archivers.zip.ZipArchiveEntry
implements Closeable
```
So we can close the real zip entry and still effectively work with it. Holds the (decompressed!) data in memory (or since POI 5.1.0, possibly in a temp file), so close this as soon as you can!

See Also:

ZipInputStreamZipEntrySource.setThresholdBytesForTempFiles(int)

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.commons.compress.archivers.zip.ZipArchiveEntry
  org.apache.commons.compress.archivers.zip.ZipArchiveEntry.CommentSource, org.apache.commons.compress.archivers.zip.ZipArchiveEntry.ExtraFieldParsingMode, org.apache.commons.compress.archivers.zip.ZipArchiveEntry.NameSource

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`	`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 org.apache.commons.compress.archivers.zip.ZipArchiveEntry
CRC_UNKNOWN, PLATFORM_FAT, PLATFORM_UNIX

Fields inherited from class java.util.zip.ZipEntry
DEFLATED, STORED

Fields inherited from interface org.apache.commons.compress.archivers.ArchiveEntry
SIZE_UNKNOWN

Fields inherited from interface org.apache.commons.compress.archivers.EntryStreamOffsets
OFFSET_UNKNOWN

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Deletes any temp files and releases any byte arrays.
`InputStream`	`getInputStream()` Returns zip entry.
`static int`	`getMaxEntrySize()`
`static void`	`setMaxEntrySize(int maxEntrySize)` Set the maximum size of a single entry in a zip-file.

Methods inherited from class org.apache.commons.compress.archivers.zip.ZipArchiveEntry
addAsFirstExtraField, addExtraField, clone, equals, getAlignment, getCentralDirectoryExtra, getCommentSource, getDataOffset, getDiskNumberStart, getExternalAttributes, getExtraField, getExtraFields, getExtraFields, getExtraFields, getGeneralPurposeBit, getInternalAttributes, getLastModifiedDate, getLocalFileDataExtra, getLocalHeaderOffset, getMethod, getName, getNameSource, getPlatform, getRawFlag, getRawName, getSize, getTime, getUnixMode, getUnparseableExtraFieldData, getVersionMadeBy, getVersionRequired, hashCode, isDirectory, isStreamContiguous, isUnixSymlink, removeExtraField, removeUnparseableExtraFieldData, setAlignment, setCentralDirectoryExtra, setCommentSource, setCreationTime, setDataOffset, setDiskNumberStart, setExternalAttributes, setExtra, setExtra, setExtraFields, setGeneralPurposeBit, setInternalAttributes, setLastAccessTime, setLastModifiedTime, setLocalHeaderOffset, setMethod, setName, setName, setNameSource, setPlatform, setRawFlag, setSize, setStreamContiguous, setTime, setTime, setUnixMode, setVersionMadeBy, setVersionRequired

Methods inherited from class java.util.zip.ZipEntry
getComment, getCompressedSize, getCrc, getCreationTime, getExtra, getLastAccessTime, getLastModifiedTime, setComment, setCompressedSize, setCrc, toString

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

Methods inherited from interface org.apache.commons.compress.archivers.ArchiveEntry
resolveIn

- 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
- Method Detail
  - setMaxEntrySize
```
public static void setMaxEntrySize(int maxEntrySize)
```
    Set the maximum size of a single entry in a zip-file.
    
    Parameters:
    
    maxEntrySize - number of bytes at which a zip entry is regarded as too large for holding in memory - defaults to 100_000_000 (approx 100Mb). A value of -1 means the default value is used.
  - getMaxEntrySize
```
public static int getMaxEntrySize()
```
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    Returns zip entry.
    
    Returns:
    
    input stream
    
    Throws:
    
    IOException - since POI 5.2.0, an IOException can occur if the optional temp file has been removed (was a RuntimeException in POI 5.1.0)
    
    See Also:
    
    ZipInputStreamZipEntrySource.setThresholdBytesForTempFiles(int)
  - close
```
public void close()
           throws IOException
```
    Deletes any temp files and releases any byte arrays.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - If closing the entry fails.
    
    Since:
    
    POI 5.1.0

Class ZipArchiveFakeEntry

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.compress.archivers.zip.ZipArchiveEntry

Field Summary

Fields inherited from class org.apache.commons.compress.archivers.zip.ZipArchiveEntry

Fields inherited from class java.util.zip.ZipEntry

Fields inherited from interface org.apache.commons.compress.archivers.ArchiveEntry

Fields inherited from interface org.apache.commons.compress.archivers.EntryStreamOffsets

Method Summary

Methods inherited from class org.apache.commons.compress.archivers.zip.ZipArchiveEntry

Methods inherited from class java.util.zip.ZipEntry

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.compress.archivers.ArchiveEntry

Field Detail

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

Method Detail

setMaxEntrySize

getMaxEntrySize

getInputStream

close