Package org.apache.poi.xssf.usermodel

Class XSSFWorkbookFactory

java.lang.Object

org.apache.poi.xssf.usermodel.XSSFWorkbookFactory

All Implemented Interfaces:

WorkbookProvider

@Internal
public class XSSFWorkbookFactory
extends Object
implements WorkbookProvider

Constructor Summary

Constructors

Constructor	Description
XSSFWorkbookFactory()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(FileMagic fm)
XSSFWorkbook	create()	Create a new empty Workbook
XSSFWorkbook	create(File file, String password, boolean readOnly)	Creates the XSSFWorkbook from the given File, which must exist and be readable.
XSSFWorkbook	create(InputStream stream)	Creates a XSSFWorkbook from the given InputStream
Workbook	create(InputStream inp, String password)
XSSFWorkbook	create(DirectoryNode root, String password)
static XSSFWorkbook	createWorkbook(OPCPackage pkg)	Creates a XSSFWorkbook from the given OOXML Package

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XSSFWorkbookFactory

public XSSFWorkbookFactory()

Method Details

accepts

public boolean accepts(FileMagic fm)

Specified by:

accepts in interface WorkbookProvider

create

public XSSFWorkbook create()

Create a new empty Workbook

Specified by:

create in interface WorkbookProvider

Returns:

The created workbook

create

public XSSFWorkbook create(DirectoryNode root,
 String password)
                    throws IOException

Specified by:

create in interface WorkbookProvider

Throws:

IOException

create

public Workbook create(InputStream inp,
 String password)
                throws IOException

Specified by:

create in interface WorkbookProvider

Throws:

IOException

create

public XSSFWorkbook create(InputStream stream)
                    throws IOException

Creates a XSSFWorkbook from the given InputStream

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

Specified by:

create in interface WorkbookProvider

Parameters:

stream - The InputStream to read data from.

Returns:

The created Workbook

Throws:

IOException - if an error occurs while reading the data

createWorkbook

public static XSSFWorkbook createWorkbook(OPCPackage pkg)
                                   throws IOException

Creates a XSSFWorkbook from the given OOXML Package

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

Parameters:

pkg - The OPCPackage opened for reading data.

Returns:

The created Workbook

Throws:

IOException - if an error occurs while reading the data

create

public XSSFWorkbook create(File file,
 String password,
 boolean readOnly)
                    throws IOException

Creates the XSSFWorkbook from the given File, which must exist and be readable.

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

Specified by:

create in interface WorkbookProvider

Parameters:

file - The file to read data from.

readOnly - If the Workbook should be opened in read-only mode to avoid writing back changes when the document is closed.

Returns:

The created Workbook

Throws:

IOException - if an error occurs while reading the data

EncryptedDocumentException - If the wrong password is given for a protected file