org.apache.poi.xwpf

Class XWPFParser

java.lang.Object

org.apache.poi.xwpf.XWPFParser

public final class XWPFParser
extends Object

Methods that wrap XWPFDocument parsing functionality. One difference is that the methods in this class try to throw XWPFReadException 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 XWPFDocument	parse(File file) Parse the given InputStream and return a new XWPFDocument instance.
static XWPFDocument	parse(InputStream stream) Parse the given InputStream and return a new XWPFDocument instance.
static XWPFDocument	parse(InputStream stream, boolean closeStream) Parse the given InputStream and return a new XWPFDocument instance.
static XWPFDocument	parse(OPCPackage pkg) Parse the given OPCPackage and return a new XWPFDocument instance.
static XWPFDocument	parse(PackagePart packagePart) Parse the given PackagePart and return a new XWPFDocument instance.

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static XWPFDocument parse(InputStream stream)
                          throws XWPFReadException,
                                 IOException

Parse the given InputStream and return a new XWPFDocument instance.

Parameters:

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

Returns:

a new XWPFDocument instance

Throws:

XWPFReadException - if an error occurs while reading the file

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

parse

public static XWPFDocument parse(InputStream stream,
                                 boolean closeStream)
                          throws XWPFReadException,
                                 IOException

Parse the given InputStream and return a new XWPFDocument instance.

Parameters:

stream - the data to parse

closeStream - whether to close the InputStream after parsing

Returns:

a new XWPFDocument instance

Throws:

XWPFReadException - if an error occurs while reading the file

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

parse

public static XWPFDocument parse(File file)
                          throws XWPFReadException,
                                 IOException

Parse the given InputStream and return a new XWPFDocument instance.

Parameters:

file - to parse

Returns:

a new XWPFDocument instance

Throws:

XWPFReadException - if an error occurs while reading the file

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

parse

public static XWPFDocument parse(OPCPackage pkg)
                          throws XWPFReadException,
                                 IOException

Parse the given OPCPackage and return a new XWPFDocument instance.

Parameters:

pkg - to parse

Returns:

a new XWPFDocument instance

Throws:

XWPFReadException - if an error occurs while reading the file

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

parse

public static XWPFDocument parse(PackagePart packagePart)
                          throws XWPFReadException,
                                 IOException

Parse the given PackagePart and return a new XWPFDocument instance.

Parameters:

packagePart - to parse

Returns:

a new XWPFDocument instance

Throws:

XWPFReadException - if an error occurs while reading the file

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