public final class SlideShowFactory
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static void |
addProvider(SlideShowProvider<?,?> provider) |
static SlideShow<?,?> |
create(boolean XSLF)
Create a new empty SlideShow, either XSLF or HSLF depending
on the parameter
|
static SlideShow<?,?> |
create(DirectoryNode root)
Creates a SlideShow from the given DirectoryNode.
|
static SlideShow<?,?> |
create(DirectoryNode root,
java.lang.String password)
Creates a SlideShow from the given DirectoryNode, which may
be password protected
|
static SlideShow<?,?> |
create(java.io.File file)
Creates the appropriate HSLFSlideShow / XSLFSlideShow from
the given File, which must exist and be readable.
|
static SlideShow<?,?> |
create(java.io.File file,
java.lang.String password)
Creates the appropriate HSLFSlideShow / XSLFSlideShow from
the given File, which must exist and be readable, and
may be password protected
|
static SlideShow<?,?> |
create(java.io.File file,
java.lang.String password,
boolean readOnly)
Creates the appropriate HSLFSlideShow / XSLFSlideShow from
the given File, which must exist and be readable, and
may be password protected
|
static SlideShow<?,?> |
create(java.io.InputStream inp)
Creates the appropriate HSLFSlideShow / XSLFSlideShow from
the given InputStream.
|
static SlideShow<?,?> |
create(java.io.InputStream inp,
java.lang.String password)
Creates the appropriate HSLFSlideShow / XSLFSlideShow from
the given InputStream, which may be password protected.
|
static SlideShow<?,?> |
create(POIFSFileSystem fs)
Creates a HSLFSlideShow from the given POIFSFileSystem
|
static void |
removeProvider(java.lang.Class<? extends SlideShowProvider<?,?>> provider) |
public static SlideShow<?,?> create(boolean XSLF) throws java.io.IOException
XSLF
- If an XSLFSlideShow or a HSLFSlideShow should be createdjava.io.IOException
- if an error occurs while creating the objectspublic static SlideShow<?,?> create(POIFSFileSystem fs) throws java.io.IOException
Note that in order to properly release resources the SlideShow should be closed after use.
fs
- The POIFSFileSystem
to read the document fromjava.io.IOException
- if an error occurs while reading the datapublic static SlideShow<?,?> create(DirectoryNode root) throws java.io.IOException
root
- The DirectoryNode
to start reading the document fromjava.io.IOException
- if an error occurs while reading the datapublic static SlideShow<?,?> create(DirectoryNode root, java.lang.String password) throws java.io.IOException
root
- The DirectoryNode
to start reading the document frompassword
- The password that should be used or null if no password is necessary.java.io.IOException
- if an error occurs while reading the datapublic static SlideShow<?,?> create(java.io.InputStream inp) throws java.io.IOException, EncryptedDocumentException
Your input stream MUST either support mark/reset, or
be wrapped as a BufferedInputStream
!
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.
inp
- The InputStream
to read data from.java.io.IOException
- if an error occurs while reading the dataEncryptedDocumentException
- If the SlideShow given is password protectedpublic static SlideShow<?,?> create(java.io.InputStream inp, java.lang.String password) throws java.io.IOException, EncryptedDocumentException
Your input stream MUST either support mark/reset, or
be wrapped as a BufferedInputStream
!
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.
inp
- The InputStream
to read data from.password
- The password that should be used or null if no password is necessary.java.io.IOException
- if an error occurs while reading the dataEncryptedDocumentException
- If the wrong password is given for a protected filepublic static SlideShow<?,?> create(java.io.File file) throws java.io.IOException, EncryptedDocumentException
Note that in order to properly release resources the SlideShow should be closed after use.
file
- The file to read data from.java.io.IOException
- if an error occurs while reading the dataEncryptedDocumentException
- If the SlideShow given is password protectedpublic static SlideShow<?,?> create(java.io.File file, java.lang.String password) throws java.io.IOException, EncryptedDocumentException
Note that in order to properly release resources the SlideShow should be closed after use.
file
- The file to read data from.password
- The password that should be used or null if no password is necessary.java.io.IOException
- if an error occurs while reading the dataEncryptedDocumentException
- If the wrong password is given for a protected filepublic static SlideShow<?,?> create(java.io.File file, java.lang.String password, boolean readOnly) throws java.io.IOException, EncryptedDocumentException
Note that in order to properly release resources the SlideShow should be closed after use.
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.java.io.IOException
- if an error occurs while reading the dataEncryptedDocumentException
- If the wrong password is given for a protected filepublic static void addProvider(SlideShowProvider<?,?> provider)
public static void removeProvider(java.lang.Class<? extends SlideShowProvider<?,?>> provider)
Copyright 2022 The Apache Software Foundation or its licensors, as applicable.