iText.Kernel.Utils.CompareTool.CompareResult Class Reference

Class containing results of the comparison of two documents. More...

Public Member Functions
	CompareResult (int messageLimit)
	Creates new empty instance of CompareResult with given limit of difference messages. More...
virtual bool	IsOk ()
	Verifies if documents are considered equal after comparison. More...
virtual int	GetErrorCount ()
	Returns number of differences between two documents detected during comparison. More...
virtual String	GetReport ()
	Converts this CompareResult into text form. More...
virtual IDictionary< ObjectPath, String >	GetDifferences ()
	Returns map with iText.Kernel.Utils.Objectpathitems.ObjectPath as keys and difference descriptions as values. More...
virtual void	WriteReportToXml (Stream stream)
	Converts this CompareResult into xml form. More...

Detailed Description

Class containing results of the comparison of two documents.

Constructor & Destructor Documentation

CompareResult()

iText.Kernel.Utils.CompareTool.CompareResult.CompareResult ( int  messageLimit )

inline

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.

Member Function Documentation

GetDifferences()

virtual IDictionary<ObjectPath, String> iText.Kernel.Utils.CompareTool.CompareResult.GetDifferences ( )

inlinevirtual

Returns map with iText.Kernel.Utils.Objectpathitems.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.

GetErrorCount()

virtual int iText.Kernel.Utils.CompareTool.CompareResult.GetErrorCount ( )

inlinevirtual

Returns number of differences between two documents detected during comparison.

Returns

number of differences.

GetReport()

virtual String iText.Kernel.Utils.CompareTool.CompareResult.GetReport ( )

inlinevirtual

Converts this CompareResult into text form.

Returns

text report on the differences between two documents.

IsOk()

virtual bool iText.Kernel.Utils.CompareTool.CompareResult.IsOk ( )

inlinevirtual

Verifies if documents are considered equal after comparison.

Returns

true if documents are equal, false otherwise.

WriteReportToXml()

virtual void iText.Kernel.Utils.CompareTool.CompareResult.WriteReportToXml ( Stream  stream )

inlinevirtual

Converts this CompareResult into xml form.

Parameters

stream

output stream to which xml report will be written.