Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.sl.usermodel
Class SlideShowFactory

java.lang.Object
  extended by org.apache.poi.sl.usermodel.SlideShowFactory

public class SlideShowFactory
extends java.lang.Object

Constructor Summary
SlideShowFactory()
           
 
Method Summary
static SlideShow<?,?> create(java.io.File file)
          Creates the appropriate HSLFSlideShow / XMLSlideShow 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 / XMLSlideShow 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 / XMLSlideShow 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 / XMLSlideShow from the given InputStream.
static SlideShow<?,?> create(java.io.InputStream inp, java.lang.String password)
          Creates the appropriate HSLFSlideShow / XMLSlideShow from the given InputStream, which may be password protected.
static SlideShow<?,?> create(NPOIFSFileSystem fs)
          Creates a SlideShow from the given NPOIFSFileSystem.
static SlideShow<?,?> create(NPOIFSFileSystem fs, java.lang.String password)
          Creates a SlideShow from the given NPOIFSFileSystem, which may be password protected
protected static SlideShow<?,?> createHSLFSlideShow(java.lang.Object... args)
           
protected static SlideShow<?,?> createSlideShow(java.lang.String factoryClass, java.lang.Object[] args)
           
protected static SlideShow<?,?> createXSLFSlideShow(java.lang.Object... args)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SlideShowFactory

public SlideShowFactory()
Method Detail

create

public static SlideShow<?,?> create(NPOIFSFileSystem fs)
                             throws java.io.IOException
Creates a SlideShow from the given NPOIFSFileSystem.

Parameters:
fs - The NPOIFSFileSystem to read the document from
Returns:
The created SlideShow
Throws:
java.io.IOException - if an error occurs while reading the data

create

public static SlideShow<?,?> create(NPOIFSFileSystem fs,
                                    java.lang.String password)
                             throws java.io.IOException
Creates a SlideShow from the given NPOIFSFileSystem, which may be password protected

Parameters:
fs - The NPOIFSFileSystem to read the document from
password - The password that should be used or null if no password is necessary.
Returns:
The created SlideShow
Throws:
java.io.IOException - if an error occurs while reading the data

create

public static SlideShow<?,?> create(java.io.InputStream inp)
                             throws java.io.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:
java.io.IOException - if an error occurs while reading the data
EncryptedDocumentException - If the SlideShow given is password protected

create

public static SlideShow<?,?> create(java.io.InputStream inp,
                                    java.lang.String password)
                             throws java.io.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:
java.io.IOException - if an error occurs while reading the data
EncryptedDocumentException - If the wrong password is given for a protected file

create

public static SlideShow<?,?> create(java.io.File file)
                             throws java.io.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:
java.io.IOException - if an error occurs while reading the data
EncryptedDocumentException - If the SlideShow given is password protected

create

public static SlideShow<?,?> create(java.io.File file,
                                    java.lang.String password)
                             throws java.io.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:
java.io.IOException - if an error occurs while reading the data
EncryptedDocumentException - If the wrong password is given for a protected file

create

public static SlideShow<?,?> create(java.io.File file,
                                    java.lang.String password,
                                    boolean readOnly)
                             throws java.io.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:
java.io.IOException - if an error occurs while reading the data
EncryptedDocumentException - If the wrong password is given for a protected file

createHSLFSlideShow

protected static SlideShow<?,?> createHSLFSlideShow(java.lang.Object... args)
                                             throws java.io.IOException,
                                                    EncryptedDocumentException
Throws:
java.io.IOException
EncryptedDocumentException

createXSLFSlideShow

protected static SlideShow<?,?> createXSLFSlideShow(java.lang.Object... args)
                                             throws java.io.IOException,
                                                    EncryptedDocumentException
Throws:
java.io.IOException
EncryptedDocumentException

createSlideShow

protected static SlideShow<?,?> createSlideShow(java.lang.String factoryClass,
                                                java.lang.Object[] args)
                                         throws java.io.IOException,
                                                EncryptedDocumentException
Throws:
java.io.IOException
EncryptedDocumentException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD