Interface OutputFile

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getFileName()
      Returns the file name of the OutputFile.
      java.lang.String getMIMEType()
      Get the MIME type of the OutputFile.
      boolean isMasterDocument()
      Test whether this document is part of the main document flow (master documents) or an auxiliary document
      void write​(java.io.OutputStream os)
      Writes the OutputFile to an OutputStream.
    • Method Detail

      • write

        void write​(java.io.OutputStream os)
            throws java.io.IOException
        Writes the OutputFile to an OutputStream.
        Parameters:
        os - OutputStream to which the content should be written
        Throws:
        java.io.IOException - if any I/O error occurs
      • getFileName

        java.lang.String getFileName()
        Returns the file name of the OutputFile. This includes the file extension and may also include a relative path, always using / as separator.
        Returns:
        the file name of this OutputFile
      • getMIMEType

        java.lang.String getMIMEType()
        Get the MIME type of the OutputFile.
        Returns:
        string representation of the MIME type
      • isMasterDocument

        boolean isMasterDocument()
        Test whether this document is part of the main document flow (master documents) or an auxiliary document
        Returns:
        true if this document is a master document