com.atlassian.selenium.visualcomparison.v2

Class ComparisonSettings

java.lang.Object

com.atlassian.selenium.visualcomparison.v2.ComparisonSettings

@Immutable
 @ExperimentalApi
public final class ComparisonSettings
extends Object

Represents settings used for visual comparison. This is in essence an immutable bean that holds various settings.

A single instance of code ComparisonSettings can be merged with another instance, which will result in the other instance 'single' fields overriding this instance's corresponding fields, unless they were not set on the other instance at all. Collection fields are merged by combining collections from both merged instances.

A family of short-hand methods is also available on this class (many of them starting with a with prefix) to facilitate creating a new instance of settings overriding, or adding just one specific field from the original instance. Those work in essence as if this instance was merged with another instance of settings that had just that one particular field set.

Since:

2.3

Method Summary

Modifier and Type	Method and Description
static ComparisonSettings	emptySettings() Creates a new empty instance of settings.
File	getBaselineDirectory()
Iterable<PagePart>	getIgnoredParts()
Iterable<Replacement>	getReplacements()
File	getReportingDirectory()
Set<Resolution>	getResolutions()
ComparisonSettings	ignoringPart(PagePart part)
ComparisonSettings	ignoringSingleLineDifferences(boolean value)
boolean	isIgnoreSingleLineDifferences()
boolean	isRefreshAfterResize()
boolean	isReportingEnabled()
ComparisonSettings	merge(ComparisonSettings that)
ComparisonSettings	refreshingAfterResize(boolean refreshAfterResize)
ComparisonSettings	withBaselineDirectory(File baselineDirectory)
ComparisonSettings	withReplacement(Replacement replacement)
ComparisonSettings	withReportingDisabled()
ComparisonSettings	withReportingEnabled(File value)
ComparisonSettings	withResolution(Resolution resolution)
ComparisonSettings	withResolutions(Resolution first, Resolution... more)

Methods inherited from class java.lang.Object

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

Method Detail

emptySettings

@Nonnull
public static ComparisonSettings emptySettings()

Creates a new empty instance of settings. All simple fields are null (not set) and the collection fields are empty collections.

Returns:

new empty instance of ComparisonSettings.

getResolutions

@Nonnull
public Set<Resolution> getResolutions()

getBaselineDirectory

@Nullable
public File getBaselineDirectory()

isReportingEnabled

public boolean isReportingEnabled()

getReportingDirectory

@Nullable
public File getReportingDirectory()

isIgnoreSingleLineDifferences

public boolean isIgnoreSingleLineDifferences()

isRefreshAfterResize

public boolean isRefreshAfterResize()

getIgnoredParts

@Nonnull
public Iterable<PagePart> getIgnoredParts()

getReplacements

@Nonnull
public Iterable<Replacement> getReplacements()

merge

@Nonnull
public ComparisonSettings merge(ComparisonSettings that)

withResolution

@Nonnull
public ComparisonSettings withResolution(@Nonnull
                                                  Resolution resolution)

withResolutions

@Nonnull
public ComparisonSettings withResolutions(@Nonnull
                                                   Resolution first,
                                                   @Nonnull
                                                   Resolution... more)

withBaselineDirectory

@Nonnull
public ComparisonSettings withBaselineDirectory(@Nonnull
                                                         File baselineDirectory)

withReportingEnabled

@Nonnull
public ComparisonSettings withReportingEnabled(@Nonnull
                                                        File value)

withReportingDisabled

@Nonnull
public ComparisonSettings withReportingDisabled()

ignoringSingleLineDifferences

@Nonnull
public ComparisonSettings ignoringSingleLineDifferences(boolean value)

refreshingAfterResize

@Nonnull
public ComparisonSettings refreshingAfterResize(boolean refreshAfterResize)

ignoringPart

@Nonnull
public ComparisonSettings ignoringPart(@Nonnull
                                                PagePart part)

withReplacement

@Nonnull
public ComparisonSettings withReplacement(@Nonnull
                                                   Replacement replacement)