Class SlideShowFactory

java.lang.Object
org.apache.poi.sl.usermodel.SlideShowFactory
Direct Known Subclasses:
HSLFSlideShowFactory, XSLFSlideShowFactory

public class SlideShowFactory extends Object
  • Constructor Details

    • SlideShowFactory

      public SlideShowFactory()
  • Method Details

    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(POIFSFileSystem fs) throws IOException
      Creates a SlideShow from the given NPOIFSFileSystem.
      Parameters:
      fs - The POIFSFileSystem to read the document from
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(POIFSFileSystem fs, String password) throws IOException
      Creates a SlideShow from the given NPOIFSFileSystem, which may be password protected
      Parameters:
      fs - The POIFSFileSystem to read the document from
      password - The password that should be used or null if no password is necessary.
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(DirectoryNode root) throws IOException
      Creates a SlideShow from the given NPOIFSFileSystem.
      Parameters:
      root - The DirectoryNode to start reading the document from
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(DirectoryNode root, String password) throws IOException
      Creates a SlideShow from the given NPOIFSFileSystem, which may be password protected
      Parameters:
      root - The DirectoryNode to start reading the document from
      password - The password that should be used or null if no password is necessary.
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(InputStream inp) throws IOException, EncryptedDocumentException
      Creates the appropriate HSLFSlideShow / XMLSlideShow from the given InputStream.

      Note that using an InputStream has a higher memory footprint than using a File.

      Note that in order to properly release resources the SlideShow should be closed after use. Note also that loading from an InputStream requires more memory than loading from a File, so prefer create(File) where possible.

      Parameters:
      inp - The InputStream to read data from.
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
      EncryptedDocumentException - If the SlideShow given is password protected
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(InputStream inp, String password) throws IOException, EncryptedDocumentException
      Creates the appropriate HSLFSlideShow / XMLSlideShow from the given InputStream, which may be password protected.

      Note that using an InputStream has a higher memory footprint than using a File.

      Note that in order to properly release resources the SlideShow should be closed after use. Note also that loading from an InputStream requires more memory than loading from a File, so prefer create(File) where possible.

      Parameters:
      inp - The InputStream to read data from.
      password - The password that should be used or null if no password is necessary.
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
      EncryptedDocumentException - If the wrong password is given for a protected file
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(File file) throws IOException, EncryptedDocumentException
      Creates the appropriate HSLFSlideShow / XMLSlideShow from the given File, which must exist and be readable.

      Note that in order to properly release resources the SlideShow should be closed after use.

      Parameters:
      file - The file to read data from.
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
      EncryptedDocumentException - If the SlideShow given is password protected
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(File file, String password) throws IOException, EncryptedDocumentException
      Creates the appropriate HSLFSlideShow / XMLSlideShow from the given File, which must exist and be readable, and may be password protected

      Note that in order to properly release resources the SlideShow should be closed after use.

      Parameters:
      file - The file to read data from.
      password - The password that should be used or null if no password is necessary.
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
      EncryptedDocumentException - If the wrong password is given for a protected file
    • create

      public static <S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>> SlideShow<S,P> create(File file, String password, boolean readOnly) throws IOException, EncryptedDocumentException
      Creates the appropriate HSLFSlideShow / XMLSlideShow from the given File, which must exist and be readable, and may be password protected

      Note that in order to properly release resources the SlideShow should be closed after use.

      Parameters:
      file - The file to read data from.
      password - The password that should be used or null if no password is necessary.
      readOnly - If the SlideShow should be opened in read-only mode to avoid writing back changes when the document is closed.
      Returns:
      The created SlideShow
      Throws:
      IOException - if an error occurs while reading the data
      EncryptedDocumentException - If the wrong password is given for a protected file