com.atlassian.selenium.visualcomparison.v2

Interface Comparer

All Known Implementing Classes:

DefaultComparer

@ExperimentalApi
public interface Comparer

The main tool for visual comparison. Instances of this interface can be used for performing visual comparison of a single page. They should be configurable at the instance level, as well as per single comparison. The settings passed on for comparison should merge into, or override the comparer settings where appropriate.

Since:

2.3

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 settings) Take a snapshot of the current page and compare it with a baseline using given id.

Method Detail

compare

void compare(@Nonnull
             String id)

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.

Parameters:

id - ID of the comparison

Throws:

VisualComparisonFailedException - if the visual comparison fails. Depending on the settings, this may also trigger generating a report containing details of what parts of the page did not match the baseline.

IllegalStateException - if settings associated with this comparison are invalid for the purpose of this comparison

compare

void compare(@Nonnull
             String id,
             @Nonnull
             ComparisonSettings settings)

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.

Parameters:

id - ID of the comparison

settings - extra settings specific to this comparison

Throws:

VisualComparisonFailedException - if the visual comparison fails. Depending on the settings, this may also trigger generating a report containing details of what parts of the page did not match the baseline.

IllegalStateException - if settings associated with this comparison are invalid for the purpose of this comparison