Class POIXMLDocument

    • Field Detail

      • DOCUMENT_CREATOR

        public static final java.lang.String DOCUMENT_CREATOR
        See Also:
        Constant Field Values
      • OLE_OBJECT_REL_TYPE

        public static final java.lang.String OLE_OBJECT_REL_TYPE
        See Also:
        Constant Field Values
      • PACK_OBJECT_REL_TYPE

        public static final java.lang.String PACK_OBJECT_REL_TYPE
        See Also:
        Constant Field Values
    • Method Detail

      • openPackage

        public static OPCPackage openPackage​(java.lang.String path)
                                      throws java.io.IOException
        Wrapper to open a package, which works around shortcomings in java's this() constructor calls
        Parameters:
        path - the path to the document
        Returns:
        the new OPCPackage
        Throws:
        java.io.IOException - if there was a problem opening the document
      • getPackage

        public OPCPackage getPackage()
        Get the assigned OPCPackage
        Returns:
        the assigned OPCPackage
      • getProperties

        public POIXMLProperties getProperties()
        Get the document properties. This gives you access to the core ooxml properties, and the extended ooxml properties.
        Returns:
        the document properties
      • getAllEmbedds

        @Deprecated
        @Removal(version="4.2")
        public java.util.List<PackagePart> getAllEmbedds()
                                                  throws OpenXML4JException
        Deprecated.
        use getAllEmbeddedParts instead
        Get the document's embedded files.
        Returns:
        the document's embedded files
        Throws:
        OpenXML4JException - if the embedded parts can't be determined
      • getAllEmbeddedParts

        public abstract java.util.List<PackagePart> getAllEmbeddedParts()
                                                                 throws OpenXML4JException
        Get the document's embedded files.
        Returns:
        the document's embedded files
        Throws:
        OpenXML4JException - if the embedded parts can't be determined
        Since:
        POI 4.0.0
      • close

        public void close()
                   throws java.io.IOException
        Closes the underlying OPCPackage from which this document was read, if there is one

        Once this has been called, no further operations, updates or reads should be performed on the document.

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException - for writable packages, if an IO exception occur during the saving process.
      • write

        public final void write​(java.io.OutputStream stream)
                         throws java.io.IOException
        Write out this document to an Outputstream. Note - if the Document was opened from a File rather than an InputStream, you must write out to a different file, overwriting via an OutputStream isn't possible. If stream is a FileOutputStream on a networked drive or has a high cost/latency associated with each written byte, consider wrapping the OutputStream in a BufferedOutputStream to improve write performance.
        Parameters:
        stream - - the java OutputStream you wish to write the file to
        Throws:
        java.io.IOException - if anything can't be written.