com.gnostice.documents

Class ConverterErrorEvent

java.lang.Object

java.util.EventObject

com.gnostice.documents.ConverterEvent

com.gnostice.documents.ConverterErrorEvent

All Implemented Interfaces:

Serializable

public class ConverterErrorEvent
extends ConverterEvent

This class represents an event when a user class instance implementing the ConverterListener encounters an error when converting a document.

See Also:

ConverterListener.error(ConverterErrorEvent), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConverterErrorEvent(Object source, ConverterJobInfoEvent jobInfo, String errorMessage, int inputDocumentIndex, Exception cause)

Method Summary

Modifier and Type	Method and Description
Exception	getCause() Returns exception raised by the error.
String	getErrorMessage() Returns information about the error.
int	getInputDocumentIndex() Returns index of the current document that was being converted.
boolean	isRethrowError() Returns whether exceptions encountered by the DocumentConverter need to be re-thrown.
void	setRethrowError(boolean rethrowError) Specifies whether exceptions encountered by the DocumentConverter need to be raised by the user class instance.

Methods inherited from class com.gnostice.documents.ConverterEvent

getJobInfo, isCancel, setCancel

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConverterErrorEvent

public ConverterErrorEvent(Object source,
                           ConverterJobInfoEvent jobInfo,
                           String errorMessage,
                           int inputDocumentIndex,
                           Exception cause)

Method Detail

getErrorMessage

public String getErrorMessage()

Returns information about the error.

Returns:

information about the error

getInputDocumentIndex

public int getInputDocumentIndex()

Returns index of the current document that was being converted.

Returns:

index of the current document that was being converted

getCause

public Exception getCause()

Returns exception raised by the error.

Returns:

exception raised by the error

isRethrowError

public boolean isRethrowError()

Returns whether exceptions encountered by the DocumentConverter need to be re-thrown. By default, this is false.

Returns:

true if the exceptions are set to be raised; false if otherwise

setRethrowError

public void setRethrowError(boolean rethrowError)

Specifies whether exceptions encountered by the DocumentConverter need to be raised by the user class instance.

Parameters:

rethrowError - true if the exceptions need to be raised; false if otherwise