com.itextpdf.kernel.utils

Class CompareTool.CompareResult

java.lang.Object

com.itextpdf.kernel.utils.CompareTool.CompareResult

Enclosing class:

CompareTool

public class CompareTool.CompareResult
extends Object

Class containing results of the comparison of two documents.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<CompareTool.ObjectPath,String>	differences
protected int	messageLimit

Constructor Summary

Constructors

Constructor and Description
CompareResult(int messageLimit) Creates new empty instance of CompareResult with given limit of difference messages.

Method Summary

Modifier and Type	Method and Description
protected void	addError(CompareTool.ObjectPath path, String message)
Map<CompareTool.ObjectPath,String>	getDifferences() Returns map with CompareTool.ObjectPath as keys and difference descriptions as values.
int	getErrorCount() Returns number of differences between two documents detected during comparison.
String	getReport() Converts this CompareResult into text form.
protected boolean	isMessageLimitReached()
boolean	isOk() Verifies if documents are considered equal after comparison.
void	writeReportToXml(OutputStream stream) Converts this CompareResult into xml form.

Methods inherited from class java.lang.Object

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

Field Detail

differences

protected Map<CompareTool.ObjectPath,String> differences

messageLimit

protected int messageLimit

Constructor Detail

CompareResult

public CompareResult(int messageLimit)

Creates new empty instance of CompareResult with given limit of difference messages.

Parameters:

messageLimit - maximum number of difference messages to be handled by this CompareResult.

Method Detail

isOk

public boolean isOk()

Verifies if documents are considered equal after comparison.

Returns:

true if documents are equal, false otherwise.

getErrorCount

public int getErrorCount()

Returns number of differences between two documents detected during comparison.

Returns:

number of differences.

getReport

public String getReport()

Converts this CompareResult into text form.

Returns:

text report on the differences between two documents.

getDifferences

public Map<CompareTool.ObjectPath,String> getDifferences()

Returns map with CompareTool.ObjectPath as keys and difference descriptions as values.

Returns:

differences map which could be used to find in the document the objects that are different.

writeReportToXml

public void writeReportToXml(OutputStream stream)
                      throws ParserConfigurationException,
                             TransformerException

Converts this CompareResult into xml form.

Parameters:

stream - output stream to which xml report will be written.

Throws:

ParserConfigurationException - if a XML DocumentBuilder cannot be created which satisfies the configuration requested.

TransformerException - if it is not possible to create an XML Transformer instance or an unrecoverable error occurs during the course of the transformation.

isMessageLimitReached

protected boolean isMessageLimitReached()

addError

protected void addError(CompareTool.ObjectPath path,
                        String message)