Class ZipPackagePart

java.lang.Object
org.apache.poi.openxml4j.opc.PackagePart
org.apache.poi.openxml4j.opc.ZipPackagePart
All Implemented Interfaces:
Comparable<PackagePart>, RelationshipSource

public class ZipPackagePart extends PackagePart
Zip implementation of a PackagePart.
Version:
1.0
Author:
Julien Chable
See Also:
  • Constructor Details

    • ZipPackagePart

      public ZipPackagePart(OPCPackage container, org.apache.commons.compress.archivers.zip.ZipArchiveEntry zipEntry, PackagePartName partName, String contentType) throws InvalidFormatException
      Constructor.
      Parameters:
      container - The container package.
      zipEntry - The zip entry corresponding to this part.
      partName - The part name.
      contentType - Content type.
      Throws:
      InvalidFormatException - Throws if the content of this part is invalid.
  • Method Details

    • getZipArchive

      public org.apache.commons.compress.archivers.zip.ZipArchiveEntry getZipArchive()
      Get the zip entry of this part.
      Returns:
      The zip entry in the zip structure coresponding to this part.
    • getInputStreamImpl

      protected InputStream getInputStreamImpl() throws IOException
      Implementation of the getInputStream() which return the inputStream of this part zip entry.
      Specified by:
      getInputStreamImpl in class PackagePart
      Returns:
      Input stream of this part zip entry.
      Throws:
      IOException - Throws if an IO Exception occur in the implementation method.
    • getOutputStreamImpl

      protected OutputStream getOutputStreamImpl()
      Implementation of the getOutputStream(). Return null. Normally will never be called since the MemoryPackage is use instead.
      Specified by:
      getOutputStreamImpl in class PackagePart
      Returns:
      null
    • getSize

      public long getSize()
      Overrides:
      getSize in class PackagePart
      Returns:
      The length of the part in bytes, or -1 if not known
    • save

      public boolean save(OutputStream os) throws OpenXML4JException
      Description copied from class: PackagePart
      Save the content of this part and the associated relationships part (if this part own at least one relationship) into the specified output stream.
      Specified by:
      save in class PackagePart
      Parameters:
      os - Output stream to save this part.
      Returns:
      boolean flag that shows if the save succeeded
      Throws:
      OpenXML4JException - If any exception occur.
    • load

      @NotImplemented public boolean load(InputStream ios)
      Description copied from class: PackagePart
      Load the content of this part.
      Specified by:
      load in class PackagePart
      Parameters:
      ios - The input stream of the content to load.
      Returns:
      true if the content has been successfully loaded, else false.
    • close

      @NotImplemented public void close()
      Description copied from class: PackagePart
      Close this part : flush this part, close the input stream and output stream. After this method call, the part must be available for packaging.
      Specified by:
      close in class PackagePart
    • flush

      @NotImplemented public void flush()
      Description copied from class: PackagePart
      Flush the content of this part. If the input stream and/or output stream as in a waiting state to read or write, the must to empty their respective buffer.
      Specified by:
      flush in class PackagePart