Package com.itextpdf.signatures.validation.report

Class ReportItem

java.lang.Object

com.itextpdf.signatures.validation.report.ReportItem

Direct Known Subclasses:

CertificateReportItem

public class ReportItem
extends java.lang.Object

Report item to be used for single failure or log message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportItem.ReportItemStatus	Enum representing possible report item statuses that determine validation result.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Exception	cause
private java.lang.String	checkName
private java.lang.String	message
private ReportItem.ReportItemStatus	status

Constructor Summary

Constructors

Constructor	Description
ReportItem(java.lang.String checkName, java.lang.String message, ReportItem.ReportItemStatus status)	Create ReportItem instance.
ReportItem(java.lang.String checkName, java.lang.String message, java.lang.Exception cause, ReportItem.ReportItemStatus status)	Create ReportItem instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCheckName()	Get the check name related to this report item.
java.lang.Exception	getExceptionCause()	Get the exception, which caused this report item.
java.lang.String	getMessage()	Get the message related to this report item.
ReportItem.ReportItemStatus	getStatus()	Get report item status that determines validation result this report item corresponds to.
ReportItem	setStatus(ReportItem.ReportItemStatus status)	Set report item status that determines validation result this report item corresponds to.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

checkName

private final java.lang.String checkName

message

private final java.lang.String message

cause

private final java.lang.Exception cause

status

private ReportItem.ReportItemStatus status

Constructor Detail

ReportItem

public ReportItem(java.lang.String checkName,
                  java.lang.String message,
                  ReportItem.ReportItemStatus status)

Create ReportItem instance.

Parameters:

checkName - String, which represents a check name during which report item occurred

message - String with the exact report item message

status - ReportItem.ReportItemStatus report item status that determines validation result

ReportItem

public ReportItem(java.lang.String checkName,
                  java.lang.String message,
                  java.lang.Exception cause,
                  ReportItem.ReportItemStatus status)

Create ReportItem instance.

Parameters:

checkName - String, which represents a check name during which report item occurred

message - String with the exact report item message

cause - Exception, which caused this report item

status - ReportItem.ReportItemStatus report item status that determines validation result

Method Detail

getCheckName

public java.lang.String getCheckName()

Get the check name related to this report item.

Returns:

String check name related to this report item.

getMessage

public java.lang.String getMessage()

Get the message related to this report item.

Returns:

String message related to this report item.

getExceptionCause

public java.lang.Exception getExceptionCause()

Get the exception, which caused this report item.

Returns:

Exception, which cause this report item.

getStatus

public ReportItem.ReportItemStatus getStatus()

Get report item status that determines validation result this report item corresponds to.

Returns:

ReportItem.ReportItemStatus report item status that determines validation result.

setStatus

public ReportItem setStatus(ReportItem.ReportItemStatus status)

Set report item status that determines validation result this report item corresponds to.

Parameters:

status - ReportItem.ReportItemStatus report item status that determines validation result

Returns:

this ReportItem instance.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns: