org.apache.poi.xssf

Class XSSFParser

java.lang.Object

org.apache.poi.xssf.XSSFParser

public final class XSSFParser
extends Object

Methods that wrap XSSFWorkbook parsing functionality. One difference is that the methods in this class try to throw XSSFReadException or IOException instead of RuntimeException. You can still get an Errors like an OutOfMemoryError.

Since:

POI 5.5.0

Method Summary

Modifier and Type	Method and Description
static XSSFWorkbook	parse(File file) Parse the given InputStream and return a new XSSFWorkbook instance.
static XSSFWorkbook	parse(InputStream stream) Parse the given InputStream and return a new XSSFWorkbook instance.
static XSSFWorkbook	parse(InputStream stream, boolean closeStream) Parse the given InputStream and return a new XSSFWorkbook instance.
static XSSFWorkbook	parse(OPCPackage pkg) Parse the given OPCPackage and return a new XSSFWorkbook instance.
static XSSFWorkbook	parse(PackagePart packagePart) Parse the given PackagePart and return a new XSSFWorkbook instance.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static XSSFWorkbook parse(InputStream stream)
                          throws XSSFReadException,
                                 IOException

Parse the given InputStream and return a new XSSFWorkbook instance.

Parameters:

stream - the data to parse (will be closed after parsing)

Returns:

a new XSSFWorkbook instance

Throws:

XSSFReadException - if an error occurs while reading the file

IOException - if an I/O error occurs while reading the file

parse

public static XSSFWorkbook parse(InputStream stream,
                                 boolean closeStream)
                          throws XSSFReadException,
                                 IOException

Parse the given InputStream and return a new XSSFWorkbook instance.

Parameters:

stream - the data to parse

closeStream - whether to close the InputStream after parsing

Returns:

a new XSSFWorkbook instance

Throws:

XSSFReadException - if an error occurs while reading the file

IOException - if an I/O error occurs while reading the file

parse

public static XSSFWorkbook parse(File file)
                          throws XSSFReadException,
                                 IOException

Parse the given InputStream and return a new XSSFWorkbook instance.

Parameters:

file - to parse

Returns:

a new XSSFWorkbook instance

Throws:

XSSFReadException - if an error occurs while reading the file

IOException - if an I/O error occurs while reading the file

parse

public static XSSFWorkbook parse(OPCPackage pkg)
                          throws XSSFReadException,
                                 IOException

Parse the given OPCPackage and return a new XSSFWorkbook instance.

Parameters:

pkg - to parse

Returns:

a new XSSFWorkbook instance

Throws:

XSSFReadException - if an error occurs while reading the file

IOException - if an I/O error occurs while reading the file

parse

public static XSSFWorkbook parse(PackagePart packagePart)
                          throws XSSFReadException,
                                 IOException

Parse the given PackagePart and return a new XSSFWorkbook instance.

Parameters:

packagePart - to parse

Returns:

a new XSSFWorkbook instance

Throws:

XSSFReadException - if an error occurs while reading the file

IOException - if an I/O error occurs while reading the file