Top Description Fields Constructors Methods
org.apache.poi.hpsf

public Class HPSFException

extends Exception
Class Inheritance
Known Direct Subclasses
org.apache.poi.hpsf.NoPropertySetStreamException, org.apache.poi.hpsf.UnexpectedPropertySetTypeException, org.apache.poi.hpsf.VariantTypeException

This exception is the superclass of all other checked exceptions thrown in this package. It supports a nested "reason" throwable, i.e. an exception that caused this one to be thrown.

Field Summary

Modifier and TypeField and Description
private Throwable
reason

The underlying reason for this exception - may be null.

Constructor Summary

AccessConstructor and Description
public
HPSFException()

Creates an HPSFException.

public
HPSFException(final String
The message string.
msg)

Creates an HPSFException with a message string.

public
HPSFException(final Throwable
The reason, i.e. a throwable that indirectly caused this exception.
reason)

Creates a new HPSFException with a reason.

public
HPSFException(final String
The message string.
msg, final Throwable
The reason, i.e. a throwable that indirectly caused this exception.
reason)

Creates an HPSFException with a message string and a reason.

Method Summary

Modifier and TypeMethod and Description
public Throwable

Returns:

The reason
getReason()

Returns the Throwable that caused this exception to be thrown or null if there was no such Throwable.

Field Detail

reasonback to summary
private Throwable reason

The underlying reason for this exception - may be null.

Constructor Detail

HPSFExceptionback to summary
public HPSFException()

Creates an HPSFException.

HPSFExceptionback to summary
public HPSFException(final String msg)

Creates an HPSFException with a message string.

Parameters
msg:String

The message string.

HPSFExceptionback to summary
public HPSFException(final Throwable reason)

Creates a new HPSFException with a reason.

Parameters
reason:Throwable

The reason, i.e. a throwable that indirectly caused this exception.

HPSFExceptionback to summary
public HPSFException(final String msg, final Throwable reason)

Creates an HPSFException with a message string and a reason.

Parameters
msg:String

The message string.

reason:Throwable

The reason, i.e. a throwable that indirectly caused this exception.

Method Detail

getReasonback to summary
public Throwable getReason()

Returns the Throwable that caused this exception to be thrown or null if there was no such Throwable.

Returns:Throwable

The reason