Package de.redsix.pdfcompare.env

Class SimpleEnvironment

java.lang.Object

de.redsix.pdfcompare.env.SimpleEnvironment

All Implemented Interfaces:

Environment

public class SimpleEnvironment
extends Object
implements Environment

A SimpleEnvironment can be used to change environment settings programmatically. All parameters, that were not explicitly set through setter are delegated to a fallback Environment, which defaults to the regular environment backed by the application.conf file.

 new PdfComparator("expected.pdf", "actual.pdf")
         .withEnvironment(new SimpleEnvironment()
                 .setExpectedColor(Color.blue))
         .compare();
 

See Also:

• PdfComparator.withEnvironment(Environment)

Constructor Summary

Constructors

Constructor	Description
SimpleEnvironment()
SimpleEnvironment(Environment fallback)

Method Summary

Modifier and Type	Method	Description
boolean	addEqualPagesToResult()
boolean	failOnMissingIgnoreFile()
Color	getActualColor()
double	getAllowedDiffInPercent()
int	getDocumentCacheSize()
int	getDPI()
int	getExecutorTimeout()
Color	getExpectedColor()
int	getMaxImageSize()
int	getMergeCacheSize()
int	getNrOfImagesToCache()
int	getOverallTimeout()
int	getSwapCacheSize()
Path	getTempDirectory()
SimpleEnvironment	setActualColor(Color actualColor)
SimpleEnvironment	setAddEqualPagesToResult(boolean b)
SimpleEnvironment	setAllowedDiffInPercent(double allowedDiffInPercent)
SimpleEnvironment	setDocumentCacheSize(int documentCacheSize)
SimpleEnvironment	setDPI(int dpi)
SimpleEnvironment	setExecutorTimeout(int executorTimeoutInSeconds)
SimpleEnvironment	setExpectedColor(Color expectedColor)
SimpleEnvironment	setFailOnMissingIgnoreFile(boolean b)
SimpleEnvironment	setMaxImageSize(int maxImageSize)
SimpleEnvironment	setMergeCacheSize(int mergeCacheSize)
SimpleEnvironment	setNrOfImagesToCache(int nrOfImagesToCache)
SimpleEnvironment	setOverallTimeout(int overallTimeoutInMinutes)
SimpleEnvironment	setParallelProcessing(boolean parallelProcessing)
SimpleEnvironment	setSwapCacheSize(int swapCacheSize)
SimpleEnvironment	setTempDirectory(Path tempDirectory)
boolean	useParallelProcessing()

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleEnvironment

public SimpleEnvironment()

SimpleEnvironment

public SimpleEnvironment(Environment fallback)

Method Details

getTempDirectory

public Path getTempDirectory()

Specified by:

getTempDirectory in interface Environment

setTempDirectory

public SimpleEnvironment setTempDirectory(Path tempDirectory)

getNrOfImagesToCache

public int getNrOfImagesToCache()

Specified by:

getNrOfImagesToCache in interface Environment

setNrOfImagesToCache

public SimpleEnvironment setNrOfImagesToCache(int nrOfImagesToCache)

getMergeCacheSize

public int getMergeCacheSize()

Specified by:

getMergeCacheSize in interface Environment

setMergeCacheSize

public SimpleEnvironment setMergeCacheSize(int mergeCacheSize)

getSwapCacheSize

public int getSwapCacheSize()

Specified by:

getSwapCacheSize in interface Environment

setSwapCacheSize

public SimpleEnvironment setSwapCacheSize(int swapCacheSize)

getDocumentCacheSize

public int getDocumentCacheSize()

Specified by:

getDocumentCacheSize in interface Environment

setDocumentCacheSize

public SimpleEnvironment setDocumentCacheSize(int documentCacheSize)

getMaxImageSize

public int getMaxImageSize()

Specified by:

getMaxImageSize in interface Environment

setMaxImageSize

public SimpleEnvironment setMaxImageSize(int maxImageSize)

getOverallTimeout

public int getOverallTimeout()

Specified by:

getOverallTimeout in interface Environment

setOverallTimeout

public SimpleEnvironment setOverallTimeout(int overallTimeoutInMinutes)

getExecutorTimeout

public int getExecutorTimeout()

Specified by:

getExecutorTimeout in interface Environment

setExecutorTimeout

public SimpleEnvironment setExecutorTimeout(int executorTimeoutInSeconds)

useParallelProcessing

public boolean useParallelProcessing()

Specified by:

useParallelProcessing in interface Environment

setParallelProcessing

public SimpleEnvironment setParallelProcessing(boolean parallelProcessing)

getAllowedDiffInPercent

public double getAllowedDiffInPercent()

Specified by:

getAllowedDiffInPercent in interface Environment

setAllowedDiffInPercent

public SimpleEnvironment setAllowedDiffInPercent(double allowedDiffInPercent)

getExpectedColor

public Color getExpectedColor()

Specified by:

getExpectedColor in interface Environment

setExpectedColor

public SimpleEnvironment setExpectedColor(Color expectedColor)

getActualColor

public Color getActualColor()

Specified by:

getActualColor in interface Environment

setActualColor

public SimpleEnvironment setActualColor(Color actualColor)

getDPI

public int getDPI()

Specified by:

getDPI in interface Environment

setDPI

public SimpleEnvironment setDPI(int dpi)

addEqualPagesToResult

public boolean addEqualPagesToResult()

Specified by:

addEqualPagesToResult in interface Environment

setAddEqualPagesToResult

public SimpleEnvironment setAddEqualPagesToResult(boolean b)

failOnMissingIgnoreFile

public boolean failOnMissingIgnoreFile()

Specified by:

failOnMissingIgnoreFile in interface Environment

setFailOnMissingIgnoreFile

public SimpleEnvironment setFailOnMissingIgnoreFile(boolean b)