com.atlassian.selenium.visualcomparison.v2

Class DefaultComparer

java.lang.Object

com.atlassian.selenium.visualcomparison.v2.DefaultComparer

All Implemented Interfaces:

Comparer

@ExperimentalApi
 @Immutable
public final class DefaultComparer
extends Object
implements Comparer

Current default implementation of Comparer. This implementation delegates the visual comparison requests to the old visual comparison library, transforming the request, the settings and the results in the process.

BrowserEngine is used as the underlying SPI for the browser automation framework and ComparisonSettings as the vehicle for configuring the visual comparison, both at the instance and at the single comparison level.

NOTE: this implementation is likely to change in the future to migrate away from the old library. Depending on implementation details of this class is highly discouraged.

Since:

2.3

Constructor Summary

Constructors

Constructor and Description
DefaultComparer(BrowserEngine engine, ComparisonSettings settings)

Method Summary

Modifier and Type	Method and Description
void	compare(String id) Take a snapshot of the current page and compare it with a baseline using given id.
void	compare(String id, ComparisonSettings extraSettings) Take a snapshot of the current page and compare it with a baseline using given id.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultComparer

public DefaultComparer(@Nonnull
                       BrowserEngine engine,
                       ComparisonSettings settings)

Method Detail

compare

public void compare(@Nonnull
                    String id)

Description copied from interface: Comparer

Take a snapshot of the current page and compare it with a baseline using given id. Use default settings specific to this instance of Comparer.

Specified by:

compare in interface Comparer

Parameters:

id - ID of the comparison

compare

public void compare(@Nonnull
                    String id,
                    @Nonnull
                    ComparisonSettings extraSettings)

Description copied from interface: Comparer

Take a snapshot of the current page and compare it with a baseline using given id. Use settings in preference, or in addition to any settings specified for this Comparer itself.

Specified by:

compare in interface Comparer

Parameters:

id - ID of the comparison

extraSettings - extra settings specific to this comparison