fr.sii.ogham.testing.assertion.hamcrest

Class AbstractHtmlDiffMatcher

java.lang.Object

org.hamcrest.BaseMatcher<String>

fr.sii.ogham.testing.assertion.hamcrest.AbstractHtmlDiffMatcher

All Implemented Interfaces:

ComparisonAwareMatcher, ExpectedValueProvider<String>, org.hamcrest.Matcher<String>, org.hamcrest.SelfDescribing

Direct Known Subclasses:

IdenticalHtmlMatcher, SimilarHtmlMatcher

public abstract class AbstractHtmlDiffMatcher
extends org.hamcrest.BaseMatcher<String>
implements ExpectedValueProvider<String>, ComparisonAwareMatcher

Check if the HTML is identical or similar to the expected. The HTML strings are parsed into Documents. Two documents are considered to be "identical" if they contain the same elements and attributes in the same order.Two documents are considered to be "similar" if they contain the same elements and attributes regardless of order.

This matcher is a ExpectedValueProvider for knowing the original expected value. Thanks to this information, OghamAssertions will generate a ComparisonFailure with the expected string and actual string in order to be able to visualize the differences on sources directly in the IDE.

See HtmlUtils for more information about "identical"/"similar" HTML.

Author:

Aurélien Baudet

Field Summary

Fields

Modifier and Type	Field and Description
protected org.custommonkey.xmlunit.DetailedDiff	diff
protected String	expected
protected String	name
protected Consumer<String>	printer

Constructor Summary

Constructors

Constructor and Description
AbstractHtmlDiffMatcher(String expected, Consumer<String> printer, String name)

Method Summary

Modifier and Type	Method and Description
String	comparisonMessage() Generate the comparison message
void	describeTo(org.hamcrest.Description description)
String	getExpectedValue() Get the expected value
protected abstract boolean	matches(org.custommonkey.xmlunit.DetailedDiff diff)
boolean	matches(Object item)

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, describeMismatch, isNotNull, toString

Methods inherited from class java.lang.Object

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

Field Detail

expected

protected final String expected

printer

protected final Consumer<String> printer

name

protected final String name

diff

protected org.custommonkey.xmlunit.DetailedDiff diff

Constructor Detail

AbstractHtmlDiffMatcher

public AbstractHtmlDiffMatcher(String expected,
                               Consumer<String> printer,
                               String name)

Method Detail

matches

public boolean matches(Object item)

Specified by:

matches in interface org.hamcrest.Matcher<String>

matches

protected abstract boolean matches(org.custommonkey.xmlunit.DetailedDiff diff)

describeTo

public void describeTo(org.hamcrest.Description description)

Specified by:

describeTo in interface org.hamcrest.SelfDescribing

getExpectedValue

public String getExpectedValue()

Description copied from interface: ExpectedValueProvider

Get the expected value

Specified by:

getExpectedValue in interface ExpectedValueProvider<String>

Returns:

the expected value

comparisonMessage

public String comparisonMessage()

Description copied from interface: ComparisonAwareMatcher

Generate the comparison message

Specified by:

comparisonMessage in interface ComparisonAwareMatcher

Returns:

the detailed message