Apache POI - Common 5.3.0 · org.apache.poi.sl.usermodel.SlideShowFactory

Modifier and Type	Class and Description
private static interface	SlideShowFactory.ProviderMethod
private static class	SlideShowFactory.Singleton

Modifier and Type	Field and Description
private final List<SlideShowProvider<?, ?>>	provider

Access	Constructor and Description
private	SlideShowFactory()

Method Summary

Modifier and Type	Method and Description
public static void	addProvider(SlideShowProvider<?, ?> provider)
public static SlideShow<?, ?>	Returns: The created SlideShow create(boolean If an XSLFSlideShow or a HSLFSlideShow should be created XSLF) Create a new empty SlideShow, either XSLF or HSLF depending on the parameter
public static SlideShow<?, ?>	Returns: The created SlideShow create(POIFSFileSystem The `POIFSFileSystem` to read the document from fs) Creates a HSLFSlideShow from the given POIFSFileSystem Note that in order to properly release resources the SlideShow should be closed after use.
private static SlideShow<?, ?>	Returns: The created SlideShow create(final POIFSFileSystem The `POIFSFileSystem` to read the document from fs, String The password that should be used or null if no password is necessary. password) Creates a SlideShow from the given POIFSFileSystem, which may be password protected
public static SlideShow<?, ?>	Returns: The created SlideShow create(final DirectoryNode The `DirectoryNode` to start reading the document from root) Creates a SlideShow from the given DirectoryNode.
public static SlideShow<?, ?>	Returns: The created SlideShow create(final DirectoryNode The `DirectoryNode` to start reading the document from root, String The password that should be used or null if no password is necessary. password) Creates a SlideShow from the given DirectoryNode, which may be password protected
public static SlideShow<?, ?>	Returns: The created SlideShow create(InputStream The `InputStream` to read data from. inp) Creates the appropriate HSLFSlideShow / XSLFSlideShow from the given InputStream.
public static SlideShow<?, ?>	Returns: The created SlideShow create(InputStream The `InputStream` to read data from. inp, String The password that should be used or null if no password is necessary. password) Creates the appropriate HSLFSlideShow / XSLFSlideShow from the given InputStream, which may be password protected.
public static SlideShow<?, ?>	Returns: The created SlideShow create(File The file to read data from. file) Creates the appropriate HSLFSlideShow / XSLFSlideShow from the given File, which must exist and be readable.
public static SlideShow<?, ?>	Returns: The created SlideShow create(File The file to read data from. file, String The password that should be used or null if no password is necessary. password) Creates the appropriate HSLFSlideShow / XSLFSlideShow 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.
public static SlideShow<?, ?>	Returns: The created SlideShow create(File The file to read data from. file, String The password that should be used or null if no password is necessary. password, boolean If the SlideShow should be opened in read-only mode to avoid writing back changes when the document is closed. readOnly) Creates the appropriate HSLFSlideShow / XSLFSlideShow 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.
public static void	removeProvider(Class<? extends SlideShowProvider<?, ?>> provider)
private static SlideShow<?, ?>	wp(FileMagic fm, SlideShowFactory.ProviderMethod fun)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

provider	back to summary
private final List<SlideShowProvider<?, ?>> provider

SlideShowFactory	back to summary
private SlideShowFactory()

Method Detail

addProvider	back to summary
public static void addProvider(SlideShowProvider<?, ?> provider)

create	back to summary
public static SlideShow<?, ?> create(boolean XSLF) throws IOException Create a new empty SlideShow, either XSLF or HSLF depending on the parameter Parameters XSLF:boolean If an XSLFSlideShow or a HSLFSlideShow should be created Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while creating the objects

create

back to summary

public static SlideShow<?, ?> create(boolean XSLF) throws IOException

Create a new empty SlideShow, either XSLF or HSLF depending on the parameter

Parameters

XSLF:boolean: If an XSLFSlideShow or a HSLFSlideShow should be created

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while creating the objects

create back to summary

create	back to summary
public static SlideShow<?, ?> create(POIFSFileSystem fs) throws IOException Creates a HSLFSlideShow from the given POIFSFileSystem Note that in order to properly release resources the SlideShow should be closed after use. Parameters fs:POIFSFileSystem The `POIFSFileSystem` to read the document from Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data

public static SlideShow<?, ?> create(POIFSFileSystem fs) throws IOException

Creates a HSLFSlideShow from the given POIFSFileSystem

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

Parameters

fs:POIFSFileSystem: The POIFSFileSystem to read the document from

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data

create back to summary

create	back to summary
private static SlideShow<?, ?> create(final POIFSFileSystem fs, String password) throws IOException Creates a SlideShow from the given POIFSFileSystem, which may be password protected Parameters fs:POIFSFileSystem The `POIFSFileSystem` to read the document from password:String The password that should be used or null if no password is necessary. Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data

private static SlideShow<?, ?> create(final POIFSFileSystem fs, String password) throws IOException

Creates a SlideShow from the given POIFSFileSystem, which may be password protected

Parameters

fs:POIFSFileSystem: The POIFSFileSystem to read the document from
password:String: The password that should be used or null if no password is necessary.

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data

create back to summary

create	back to summary
public static SlideShow<?, ?> create(final DirectoryNode root) throws IOException Creates a SlideShow from the given DirectoryNode. Parameters root:DirectoryNode The `DirectoryNode` to start reading the document from Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data

public static SlideShow<?, ?> create(final DirectoryNode root) throws IOException

Creates a SlideShow from the given DirectoryNode.

Parameters

root:DirectoryNode: The DirectoryNode to start reading the document from

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data

create back to summary

create	back to summary
public static SlideShow<?, ?> create(final DirectoryNode root, String password) throws IOException Creates a SlideShow from the given DirectoryNode, which may be password protected Parameters root:DirectoryNode The `DirectoryNode` to start reading the document from password:String The password that should be used or null if no password is necessary. Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data

public static SlideShow<?, ?> create(final DirectoryNode root, String password) throws IOException

Creates a SlideShow from the given DirectoryNode, which may be password protected

Parameters

root:DirectoryNode: The DirectoryNode to start reading the document from
password:String: The password that should be used or null if no password is necessary.

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data

create back to summary

create	back to summary
public static SlideShow<?, ?> create(InputStream inp) throws IOException, EncryptedDocumentException Creates the appropriate HSLFSlideShow / XSLFSlideShow from the given InputStream. 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. Parameters inp:InputStream The `InputStream` to read data from. Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data EncryptedDocumentException: If the SlideShow given is password protected

public static SlideShow<?, ?> create(InputStream inp) throws IOException, EncryptedDocumentException

Creates the appropriate HSLFSlideShow / XSLFSlideShow from the given InputStream.

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.

Parameters

inp:InputStream: The InputStream to read data from.

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data
EncryptedDocumentException:: If the SlideShow given is password protected

create back to summary

create	back to summary
public static SlideShow<?, ?> create(InputStream inp, String password) throws IOException, EncryptedDocumentException Creates the appropriate HSLFSlideShow / XSLFSlideShow from the given InputStream, which may be password protected. 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. Parameters inp:InputStream The `InputStream` to read data from. password:String The password that should be used or null if no password is necessary. Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data EncryptedDocumentException: If the wrong password is given for a protected file

public static SlideShow<?, ?> create(InputStream inp, String password) throws IOException, EncryptedDocumentException

Creates the appropriate HSLFSlideShow / XSLFSlideShow from the given InputStream, which may be password protected.

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.

Parameters

inp:InputStream: The InputStream to read data from.
password:String: The password that should be used or null if no password is necessary.

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data
EncryptedDocumentException:: If the wrong password is given for a protected file

create	back to summary
public static SlideShow<?, ?> create(File file) throws IOException, EncryptedDocumentException Creates the appropriate HSLFSlideShow / XSLFSlideShow 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:File The file to read data from. Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data EncryptedDocumentException: If the SlideShow given is password protected

create

back to summary

public static SlideShow<?, ?> create(File file) throws IOException, EncryptedDocumentException

Creates the appropriate HSLFSlideShow / XSLFSlideShow 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:File: The file to read data from.

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data
EncryptedDocumentException:: If the SlideShow given is password protected

create	back to summary
public static SlideShow<?, ?> create(File file, String password) throws IOException, EncryptedDocumentException Creates the appropriate HSLFSlideShow / XSLFSlideShow 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:File The file to read data from. password:String The password that should be used or null if no password is necessary. Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data EncryptedDocumentException: If the wrong password is given for a protected file

create

back to summary

public static SlideShow<?, ?> create(File file, String password) throws IOException, EncryptedDocumentException

Creates the appropriate HSLFSlideShow / XSLFSlideShow 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:File: The file to read data from.
password:String: The password that should be used or null if no password is necessary.

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data
EncryptedDocumentException:: If the wrong password is given for a protected file

create	back to summary
public static SlideShow<?, ?> create(File file, String password, boolean readOnly) throws IOException, EncryptedDocumentException Creates the appropriate HSLFSlideShow / XSLFSlideShow 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:File The file to read data from. password:String The password that should be used or null if no password is necessary. readOnly:boolean If the SlideShow should be opened in read-only mode to avoid writing back changes when the document is closed. Returns:SlideShow<?, ?> The created SlideShow Exceptions IOException: if an error occurs while reading the data EncryptedDocumentException: If the wrong password is given for a protected file

create

back to summary

public static SlideShow<?, ?> create(File file, String password, boolean readOnly) throws IOException, EncryptedDocumentException

Creates the appropriate HSLFSlideShow / XSLFSlideShow 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:File: The file to read data from.
password:String: The password that should be used or null if no password is necessary.
readOnly:boolean: If the SlideShow should be opened in read-only mode to avoid writing back changes when the document is closed.

Returns:SlideShow<?, ?>

The created SlideShow

Exceptions

IOException:: if an error occurs while reading the data
EncryptedDocumentException:: If the wrong password is given for a protected file

removeProvider	back to summary
public static void removeProvider(Class<? extends SlideShowProvider<?, ?>> provider)

wp	back to summary
private static SlideShow<?, ?> wp(FileMagic fm, SlideShowFactory.ProviderMethod fun) throws IOException

public final Class SlideShowFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface SlideShowFactory.ProviderMethod

Method Summary

Method Detail

private Class SlideShowFactory.Singleton

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail