File Doc Category Size Date Package
HSSFUserException.java API Doc Apache Poi 3.0.1 2766 Mon Jan 01 12:39:36 GMT 2007 org.apache.poi.hssf.eventusermodel

HSSFUserException

java.lang.Object
- java.lang.Throwable
  - java.lang.Exception

public class HSSFUserException extends Exception

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.

author: Rainer Klute (klute@rainer-klute.de)
author: Carey Sublette (careysub@earthling.net)
version: HSSFUserException.java,v 1.0
since: 2002-04-19

Fields Summary
private Throwable
reason
Constructors Summary
public HSSFUserException()
Creates a new {@link HSSFUserException}.
super();
public HSSFUserException(String msg)
Creates a new {@link HSSFUserException} with a message string.
super(msg);
public HSSFUserException(Throwable reason)
Creates a new {@link HSSFUserException} with a reason.
super(); this.reason = reason;
public HSSFUserException(String msg, Throwable reason)
Creates a new {@link HSSFUserException} with a message string and a reason.
super(msg); this.reason = reason;
Methods Summary
public java.lang.Throwable getReason()
Returns the {@link Throwable} that caused this exception to be thrown or null if there was no such {@link Throwable}.
return reason;