io.wcm.qa.glnm.hamcrest.galen

Class VisuallyCompare

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeMatcher<T>

io.wcm.qa.glnm.hamcrest.TypeSafeWrappingMatcher<Selector,T>

io.wcm.qa.glnm.hamcrest.selector.SelectorMatcher<GalenSpecRun>

io.wcm.qa.glnm.hamcrest.galen.VisuallyCompare

All Implemented Interfaces:

Differences, DifferentiatingMatcher<Selector>, Iterable<Difference>, org.hamcrest.Matcher<Selector>, org.hamcrest.SelfDescribing

public class VisuallyCompare
extends SelectorMatcher<GalenSpecRun>
implements DifferentiatingMatcher<Selector>

Matcher doing visual comparison on element defined by Selector.

Since:

5.0.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VisuallyCompare()

Method Summary

Modifier and Type	Method and Description
void	add(Difference difference) add.
protected MutableDifferences	getDifferences()
String	getKey()
Iterator<Difference>	iterator()
protected GalenSpecRun	map(Selector item)
void	prepend(Difference difference) prepend.
static VisuallyCompare	visuallyCompare() visuallyCompare.
VisuallyCompare	whileIgnoring(Selector... ignore) whileIgnoring.
VisuallyCompare	withAllowedErrorPercent(double error) withAllowedErrorPercent.
VisuallyCompare	withAllowedErrorPixel(int error) withAllowedErrorPixel.
VisuallyCompare	withAllowedOffset(int offset) withAllowedOffset.
VisuallyCompare	withCorrections(GalenCorrectionRect corrections) withCorrections.
VisuallyCompare	withCropIfOutside(boolean crop) withCropIfOutside.
VisuallyCompare	withDifferences(Collection<Difference> differences) withDifferences.
VisuallyCompare	withElementName(String name) withElementName.
VisuallyCompare	withSectionName(String name) withSectionName.
VisuallyCompare	withZeroToleranceWarning(boolean warning) withZeroToleranceWarning.

Methods inherited from class io.wcm.qa.glnm.hamcrest.selector.SelectorMatcher

getSelector, getSelectorName, matchesSafely, setSelector

Methods inherited from class io.wcm.qa.glnm.hamcrest.TypeSafeWrappingMatcher

describeMismatchSafely, describeTo, getInternalMatcher, setInternalMatcher

Methods inherited from class org.hamcrest.TypeSafeMatcher

describeMismatch, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hamcrest.Matcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, describeMismatch, matches

Methods inherited from interface org.hamcrest.SelfDescribing

describeTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

VisuallyCompare

protected VisuallyCompare()

Method Detail

add

public void add(Difference difference)

add.

Specified by:

add in interface DifferentiatingMatcher<Selector>

Parameters:

difference - a Difference object.

getKey

public String getKey()

Specified by:

getKey in interface Differences

iterator

public Iterator<Difference> iterator()

Specified by:

iterator in interface Iterable<Difference>

prepend

public void prepend(Difference difference)

prepend.

Specified by:

prepend in interface DifferentiatingMatcher<Selector>

Parameters:

difference - a Difference object.

whileIgnoring

public VisuallyCompare whileIgnoring(Selector... ignore)

whileIgnoring.

Parameters:

ignore - a Selector object.

Returns:

a VisuallyCompare object.

withAllowedErrorPercent

public VisuallyCompare withAllowedErrorPercent(double error)

withAllowedErrorPercent.

Parameters:

error - a double.

Returns:

a VisuallyCompare object.

withAllowedErrorPixel

public VisuallyCompare withAllowedErrorPixel(int error)

withAllowedErrorPixel.

Parameters:

error - a int.

Returns:

a VisuallyCompare object.

withAllowedOffset

public VisuallyCompare withAllowedOffset(int offset)

withAllowedOffset.

Parameters:

offset - a int.

Returns:

a VisuallyCompare object.

withCorrections

public VisuallyCompare withCorrections(GalenCorrectionRect corrections)

withCorrections.

Parameters:

corrections - a GalenCorrectionRect object.

Returns:

a VisuallyCompare object.

withCropIfOutside

public VisuallyCompare withCropIfOutside(boolean crop)

withCropIfOutside.

Parameters:

crop - a boolean.

Returns:

a VisuallyCompare object.

withDifferences

public VisuallyCompare withDifferences(Collection<Difference> differences)

withDifferences.

Parameters:

differences - a Collection object.

Returns:

a VisuallyCompare object.

withElementName

public VisuallyCompare withElementName(String name)

withElementName.

Parameters:

name - a String object.

Returns:

a VisuallyCompare object.

withSectionName

public VisuallyCompare withSectionName(String name)

withSectionName.

Parameters:

name - a String object.

Returns:

a VisuallyCompare object.

withZeroToleranceWarning

public VisuallyCompare withZeroToleranceWarning(boolean warning)

withZeroToleranceWarning.

Parameters:

warning - a boolean.

Returns:

a VisuallyCompare object.

getDifferences

protected MutableDifferences getDifferences()

map

protected GalenSpecRun map(Selector item)

Specified by:

map in class TypeSafeWrappingMatcher<Selector,GalenSpecRun>

visuallyCompare

public static VisuallyCompare visuallyCompare()

visuallyCompare.

Returns:

visual comparison matcher

Since:

5.0.0