org.apache.poi.xwpf

Class XWPFReadException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.poi.POIException

org.apache.poi.xwpf.XWPFReadException

All Implemented Interfaces:

Serializable

public class XWPFReadException
extends POIException

An exception that indicates a problem reading a docx file. Usually, a more specific exception will be wrapped as the cause.

This exception is only used by some new methods. Historically, POI has used RuntimeException for most of its exceptions, but this is not a good practice. This class is a checked class that extends Exception so needs to be explicitly caught or declared in the method signature.

Since:

POI 5.5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XWPFReadException(String msg) Create a new XWPFReadException with the String specified as an error message.
XWPFReadException(String msg, Throwable cause) Create a new XWPFReadException with the String specified as an error message and the cause.

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XWPFReadException

public XWPFReadException(String msg)

Create a new XWPFReadException with the String specified as an error message.

Parameters:

msg - The error message for the exception.

XWPFReadException

public XWPFReadException(String msg,
                         Throwable cause)

Create a new XWPFReadException with the String specified as an error message and the cause.

Parameters:

msg - The error message for the exception.

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)