de.redsix.pdfcompare

Class CompareResult

java.lang.Object

de.redsix.pdfcompare.CompareResult

All Implemented Interfaces:

ResultCollector

Direct Known Subclasses:

AbstractCompareResultWithSwap, CompareResultWithExpectedAndActual

public class CompareResult
extends Object
implements ResultCollector

A CompareResult tracks the differences, that result from a comparison. The CompareResult only stores the diffImages, for lower memory consumption. If you also need the expected and actual Image, please use the Subclass CompareResultWithExpectedAndActual

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,ImageWithDimension>	diffImages
protected boolean	hasDifferenceInExclusion
protected boolean	isEqual

Constructor Summary

Constructors

Constructor and Description
CompareResult()

Method Summary

Modifier and Type	Method and Description
void	actualOnly()
protected void	addImagesToDocument(org.apache.pdfbox.pdmodel.PDDocument document)
protected void	addImagesToDocument(org.apache.pdfbox.pdmodel.PDDocument document, Map<Integer,ImageWithDimension> images)
void	addPage(boolean hasDifferences, boolean hasDifferenceInExclusion, int pageIndex, ImageWithDimension expectedImage, ImageWithDimension actualImage, ImageWithDimension diffImage)
protected void	addPageToDocument(org.apache.pdfbox.pdmodel.PDDocument document, ImageWithDimension image)
void	expectedOnly()
int	getNumberOfPages()
boolean	hasDifferenceInExclusion()
protected boolean	hasImages()
boolean	hasOnlyActual()
boolean	hasOnlyExpected()
boolean	hasOnlyOneDoc()
boolean	isEqual()
boolean	isNotEqual()
protected boolean	keepImages()
void	noPagesFound()
boolean	writeTo(String filename) Write the result Pdf to a file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.redsix.pdfcompare.ResultCollector

done

Field Detail

diffImages

protected final Map<Integer,ImageWithDimension> diffImages

isEqual

protected boolean isEqual

hasDifferenceInExclusion

protected boolean hasDifferenceInExclusion

Constructor Detail

CompareResult

public CompareResult()

Method Detail

writeTo

public boolean writeTo(String filename)

Write the result Pdf to a file. Warning: This will remove the diffImages from memory! Writing can only be done once.

Parameters:

filename - without pdf-Extension

Returns:

a boolean indicating, whether the comparison is equal. When true, the files are equal.

hasImages

protected boolean hasImages()

addImagesToDocument

protected void addImagesToDocument(org.apache.pdfbox.pdmodel.PDDocument document)
                            throws IOException

Throws:

IOException

addImagesToDocument

protected void addImagesToDocument(org.apache.pdfbox.pdmodel.PDDocument document,
                                   Map<Integer,ImageWithDimension> images)
                            throws IOException

Throws:

IOException

addPageToDocument

protected void addPageToDocument(org.apache.pdfbox.pdmodel.PDDocument document,
                                 ImageWithDimension image)
                          throws IOException

Throws:

IOException

keepImages

protected boolean keepImages()

addPage

public void addPage(boolean hasDifferences,
                    boolean hasDifferenceInExclusion,
                    int pageIndex,
                    ImageWithDimension expectedImage,
                    ImageWithDimension actualImage,
                    ImageWithDimension diffImage)

Specified by:

addPage in interface ResultCollector

noPagesFound

public void noPagesFound()

Specified by:

noPagesFound in interface ResultCollector

isEqual

public boolean isEqual()

isNotEqual

public boolean isNotEqual()

hasDifferenceInExclusion

public boolean hasDifferenceInExclusion()

hasOnlyExpected

public boolean hasOnlyExpected()

hasOnlyActual

public boolean hasOnlyActual()

hasOnlyOneDoc

public boolean hasOnlyOneDoc()

getNumberOfPages

public int getNumberOfPages()

expectedOnly

public void expectedOnly()

actualOnly

public void actualOnly()