Class HSSFUserException

java.lang.Object
java.lang.Throwable
java.lang.Exception
org.apache.poi.hssf.eventusermodel.HSSFUserException
All Implemented Interfaces:
Serializable

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.

Since:
2002-04-19
Version:
HSSFUserException.java,v 1.0
See Also:
  • Constructor Details

    • HSSFUserException

      public HSSFUserException()

      Creates a new HSSFUserException.

    • HSSFUserException

      public HSSFUserException(String msg)

      Creates a new HSSFUserException with a message string.

      Parameters:
      msg - the error message
    • HSSFUserException

      public HSSFUserException(Throwable reason)

      Creates a new HSSFUserException with a reason.

      Parameters:
      reason - the causing exception
    • HSSFUserException

      public HSSFUserException(String msg, Throwable reason)

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

      Parameters:
      msg - the error message
      reason - the causing exception
  • Method Details

    • getReason

      public Throwable getReason()

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

      Returns:
      the reason