Package com.inet.pdfc.error

Class PresenterExceptionData

java.lang.Object

com.inet.pdfc.error.ExceptionData

com.inet.pdfc.error.PresenterExceptionData

All Implemented Interfaces:

com.inet.error.HasErrorCode

@JsonData
public class PresenterExceptionData
extends ExceptionData

A class to get the exceptions of a presenter. Since the presenters are executed after the actual comparison, any internal error in the presenter may lead to a missing result but not to a failed comparison task. If you want to make sure that all presenters were executed properly, you'll have to PDFComparer.getPresenterExceptions().

Constructor Summary

Constructors

Constructor	Description
PresenterExceptionData(ExceptionData data, java.lang.String presenterName, com.inet.pdfc.util.Pair<java.lang.String> documents)	Creates an instance for a Throwable

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFirstDocument()	Returns the file name of the first comparison document
java.lang.String	getPresenterName()	Returns the name of the presenter that has thrown an exception.
java.lang.String	getSecondDocument()	Returns the file name of the second comparison document
java.lang.String	toString()

Methods inherited from class com.inet.pdfc.error.ExceptionData

equals, getErrorClass, getErrorCode, getMessage, getStack

Methods inherited from class java.lang.Object

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

Constructor Detail

PresenterExceptionData

public PresenterExceptionData(ExceptionData data,
                              java.lang.String presenterName,
                              com.inet.pdfc.util.Pair<java.lang.String> documents)

Creates an instance for a Throwable

Parameters:

data - exception data

presenterName - the name for the presenter, that throw an exception

documents - the files for the first and second comparision documents

Since:

5.0

Method Detail

getPresenterName

public java.lang.String getPresenterName()

Returns the name of the presenter that has thrown an exception. This value is equal to the value returned by NamedExtension.getExtensionName().

Returns:

the name of the presenter that has thrown an exception

Since:

5.0

getFirstDocument

public java.lang.String getFirstDocument()

Returns the file name of the first comparison document

Returns:

the file name of the first comparison document

Since:

5.0

getSecondDocument

public java.lang.String getSecondDocument()

Returns the file name of the second comparison document

Returns:

the file name of the second comparison document

Since:

5.0

toString

public java.lang.String toString()

Overrides:

toString in class ExceptionData