de.redsix.pdfcompare

Class AbstractCompareResultWithSwap

java.lang.Object

de.redsix.pdfcompare.CompareResult

de.redsix.pdfcompare.AbstractCompareResultWithSwap

All Implemented Interfaces:

ResultCollector

Direct Known Subclasses:

CompareResultWithMemoryOverflow, CompareResultWithPageOverflow

public abstract class AbstractCompareResultWithSwap
extends CompareResult

This CompareResult monitors the memory the JVM consumes through Runtime.totalMemory() - Runtime.freeMemory() when a new page is added. When the consumed memory crosses a threshold, images are swapped to disk and removed from memory. The threshold defaults to 70% of Runtime.maxMemory() but at least 200MB, which worked for me. After swapping, a System.gc() is triggered.

Field Summary

Fields inherited from class de.redsix.pdfcompare.CompareResult

diffImages, hasDifferenceInExclusion, isEqual

Constructor Summary

Constructors

Constructor and Description
AbstractCompareResultWithSwap()

Method Summary

Modifier and Type	Method and Description
void	addPage(boolean hasDifferences, boolean hasDifferenceInExclusion, int pageIndex, ImageWithDimension expectedImage, ImageWithDimension actualImage, ImageWithDimension diffImage)
protected void	afterSwap()
protected void	finalize()
protected boolean	hasImages()
protected abstract boolean	needToSwap()
boolean	writeTo(String filename) Write the result Pdf to a file.

Methods inherited from class de.redsix.pdfcompare.CompareResult

actualOnly, addImagesToDocument, addImagesToDocument, addPageToDocument, expectedOnly, getNumberOfPages, hasDifferenceInExclusion, hasOnlyActual, hasOnlyExpected, hasOnlyOneDoc, isEqual, isNotEqual, keepImages, noPagesFound

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.redsix.pdfcompare.ResultCollector

done

Constructor Detail

AbstractCompareResultWithSwap

public AbstractCompareResultWithSwap()

Method Detail

writeTo

public boolean writeTo(String filename)

Description copied from class: CompareResult

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

Overrides:

writeTo in class CompareResult

Parameters:

filename - without pdf-Extension

Returns:

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

addPage

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

Specified by:

addPage in interface ResultCollector

Overrides:

addPage in class CompareResult

afterSwap

protected void afterSwap()

needToSwap

protected abstract boolean needToSwap()

hasImages

protected boolean hasImages()

Overrides:

hasImages in class CompareResult

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable