Top Description Fields Constructors Methods
org.apache.poi.hssf.eventusermodel

public Class HSSFUserException

extends Exception
Class Inheritance

This exception is provided as a way for API users to throw exceptions from their event handling code. By doing so they abort file processing by the HSSFEventFactory and by catching it from outside the HSSFEventFactory.processEvents method they can diagnose the cause for the abort.

The HSSFUserException supports a nested "reason" throwable, i.e. an exception that caused this one to be thrown.

The HSSF package does not itself throw any of these exceptions.

Since
2002-04-19
Version
HSSFUserException.java,v 1.0

Field Summary

Modifier and TypeField and Description
private Throwable

Constructor Summary

AccessConstructor and Description
public
public
HSSFUserException(final String
the error message
msg
)

Creates a new HSSFUserException with a message string.

public
HSSFUserException(final Throwable
the causing exception
reason
)

Creates a new HSSFUserException with a reason.

public
HSSFUserException(final String
the error message
msg
,
final Throwable
the causing exception
reason
)

Creates a new HSSFUserException 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

Constructor Detail

HSSFUserExceptionback to summary
public HSSFUserException()

Creates a new HSSFUserException.

HSSFUserExceptionback to summary
public HSSFUserException(final String msg)

Creates a new HSSFUserException with a message string.

Parameters
msg:String

the error message

HSSFUserExceptionback to summary
public HSSFUserException(final Throwable reason)

Creates a new HSSFUserException with a reason.

Parameters
reason:Throwable

the causing exception

HSSFUserExceptionback to summary
public HSSFUserException(final String msg, final Throwable reason)

Creates a new HSSFUserException with a message string and a reason.

Parameters
msg:String

the error message

reason:Throwable

the causing 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