org.apache.poi.openxml4j.util

## Class ZipFileZipEntrySource

- java.lang.Object
- - org.apache.poi.openxml4j.util.ZipFileZipEntrySource

- All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, ZipEntrySource

      public class ZipFileZipEntrySource
      extends java.lang.Object
      implements ZipEntrySource

  A ZipEntrySource wrapper around a ZipFile. Should be as low in terms of memory as a normal ZipFile implementation is.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ZipFileZipEntrySource(org.apache.commons.compress.archivers.zip.ZipFile zipFile)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Indicates we are done with reading, and resources may be freed
    `java.util.Enumeration<? extends org.apache.commons.compress.archivers.zip.ZipArchiveEntry>` | `getEntries()` Returns an Enumeration of all the Entries
    `org.apache.commons.compress.archivers.zip.ZipArchiveEntry` | `getEntry(java.lang.String path)` Return an entry by its path
    `java.io.InputStream` | `getInputStream(org.apache.commons.compress.archivers.zip.ZipArchiveEntry entry)` Returns an InputStream of the decompressed data that makes up the entry
    `boolean` | `isClosed()` Has close been called already?

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### ZipFileZipEntrySource

          public ZipFileZipEntrySource(org.apache.commons.compress.archivers.zip.ZipFile zipFile)

  - ### Method Detail

    - #### close

          public void close()
                     throws java.io.IOException

      Description copied from interface: `ZipEntrySource`
      Indicates we are done with reading, and resources may be freed
      Specified by:
        `close` in interface `java.io.Closeable`
      Specified by:
        `close` in interface `java.lang.AutoCloseable`
      Specified by:
        `close` in interface `ZipEntrySource`
      Throws:
        `java.io.IOException`

    - #### isClosed

          public boolean isClosed()

      Description copied from interface: `ZipEntrySource`
      Has close been called already?
      Specified by:
        `isClosed` in interface `ZipEntrySource`

    - #### getEntries

          public java.util.Enumeration<? extends org.apache.commons.compress.archivers.zip.ZipArchiveEntry> getEntries()

      Description copied from interface: `ZipEntrySource`
      Returns an Enumeration of all the Entries
      Specified by:
        `getEntries` in interface `ZipEntrySource`

    - #### getInputStream

          public java.io.InputStream getInputStream(org.apache.commons.compress.archivers.zip.ZipArchiveEntry entry)
                                             throws java.io.IOException

      Description copied from interface: `ZipEntrySource`
      Returns an InputStream of the decompressed data that makes up the entry
      Specified by:
        `getInputStream` in interface `ZipEntrySource`
      Throws:
        `java.io.IOException`

    - #### getEntry

          public org.apache.commons.compress.archivers.zip.ZipArchiveEntry getEntry(java.lang.String path)

      Description copied from interface: `ZipEntrySource`
      Return an entry by its path
      Specified by:
        `getEntry` in interface `ZipEntrySource`
      Parameters:
        `path` - the path in unix-notation
      Returns:
        the entry or `null` if not found

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.