com.ibm.excelaccessor.event
Class ExcelAccessorErrorEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.excelaccessor.event.ExcelAccessorErrorEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ExcelCellErrorEvent, ExcelRangeErrorEvent, ExcelWorkbookErrorEvent

public class ExcelAccessorErrorEvent

extends java.util.EventObject

The ExcelAccessorErrorEvent is the abstract base class for events occurring in the ExcelAccessor suite of beans. This event encapsulates the exception occurred and the related error message. This exception could be used to obtain more detailed information about the exception.

See Also:

Serialized Form

Field Summary

static int

EXCEL_ERROR The flag indicating the event to be fired

Fields inherited from class java.util.EventObject

source

Constructor Summary

protected

ExcelAccessorErrorEvent(java.lang.Object source, int messageCode, java.lang.Exception currentException, java.lang.String message, java.lang.String workbookName) Constructs a ExcelAccessorErrorEvent object with the specified source object.

Method Summary

java.lang.Exception	getCurrentException() Returns the exception that caused this event to be fired.
java.lang.String	getMessage() Returns the error message.
int	getMessageCode() Returns the error code representing the error message.
java.lang.String	getWorkbookName() Returns the workbook that caused this event to be fired.
java.lang.String	toString() Overrides toString in Object

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

EXCEL_ERROR

public static final int EXCEL_ERROR

The flag indicating the event to be fired

Constructor Detail

ExcelAccessorErrorEvent

protected ExcelAccessorErrorEvent(java.lang.Object source,
                                  int messageCode,
                                  java.lang.Exception currentException,
                                  java.lang.String message,
                                  java.lang.String workbookName)

Constructs a ExcelAccessorErrorEvent object with the specified source object.

Parameters:

source - The object where the event originated.

messageCode - The code of the error message.

currentException - The exception that is thrown.

message - The detailed error message.

workbookName - The name of the workbook.

Method Detail

getCurrentException

public java.lang.Exception getCurrentException()

Returns the exception that caused this event to be fired.

Returns:

The exception that caused this error event.

getMessage

public java.lang.String getMessage()

Returns the error message.

Returns:

The error message.

getMessageCode

public int getMessageCode()

Returns the error code representing the error message.

Returns:

The error message code.

getWorkbookName

public java.lang.String getWorkbookName()

Returns the workbook that caused this event to be fired.

Returns:

The workbook that caused this error event.

toString

public java.lang.String toString()

Overrides toString in Object

Overrides:

toString in class java.util.EventObject

Returns:

The message.