Class SlideShowFactory
- Direct Known Subclasses:
HSLFSlideShowFactory
,XSLFSlideShowFactory
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> Creates the appropriate HSLFSlideShow / XMLSlideShow from the given File, which must exist and be readable.static <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> Creates the appropriate HSLFSlideShow / XMLSlideShow from the given File, which must exist and be readable, and may be password protectedstatic <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> Creates the appropriate HSLFSlideShow / XMLSlideShow from the given File, which must exist and be readable, and may be password protectedstatic <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> create
(InputStream inp) Creates the appropriate HSLFSlideShow / XMLSlideShow from the given InputStream.static <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> create
(InputStream inp, String password) Creates the appropriate HSLFSlideShow / XMLSlideShow from the given InputStream, which may be password protected.static <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> create
(DirectoryNode root) Creates a SlideShow from the given NPOIFSFileSystem.static <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> create
(DirectoryNode root, String password) Creates a SlideShow from the given NPOIFSFileSystem, which may be password protectedstatic <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> Creates a SlideShow from the given NPOIFSFileSystem.static <S extends Shape<S,
P>, P extends TextParagraph<S, P, ? extends TextRun>>
SlideShow<S, P> create
(POIFSFileSystem fs, String password) Creates a SlideShow from the given NPOIFSFileSystem, which may be password protected
-
Constructor Details
-
SlideShowFactory
public SlideShowFactory()
-
-
Method Details
-
create
public static <S extends Shape<S,P>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> P> create(POIFSFileSystem fs) throws IOException Creates a SlideShow from the given NPOIFSFileSystem.- Parameters:
fs
- ThePOIFSFileSystem
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>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> P> create(POIFSFileSystem fs, String password) throws IOException Creates a SlideShow from the given NPOIFSFileSystem, which may be password protected- Parameters:
fs
- ThePOIFSFileSystem
to read the document frompassword
- 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>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> P> create(DirectoryNode root) throws IOException Creates a SlideShow from the given NPOIFSFileSystem.- Parameters:
root
- TheDirectoryNode
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>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> P> create(DirectoryNode root, String password) throws IOException Creates a SlideShow from the given NPOIFSFileSystem, which may be password protected- Parameters:
root
- TheDirectoryNode
to start reading the document frompassword
- 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>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> 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 aFile
.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
- TheInputStream
to read data from.- Returns:
- The created SlideShow
- Throws:
IOException
- if an error occurs while reading the dataEncryptedDocumentException
- If the SlideShow given is password protected
-
create
public static <S extends Shape<S,P>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> 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 aFile
.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
- TheInputStream
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 dataEncryptedDocumentException
- If the wrong password is given for a protected file
-
create
public static <S extends Shape<S,P>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> 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 dataEncryptedDocumentException
- If the SlideShow given is password protected
-
create
public static <S extends Shape<S,P>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> 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 protectedNote 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 dataEncryptedDocumentException
- If the wrong password is given for a protected file
-
create
public static <S extends Shape<S,P>, SlideShow<S,P extends TextParagraph<S, P, ? extends TextRun>> 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 protectedNote 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 dataEncryptedDocumentException
- If the wrong password is given for a protected file
-