org.cthul.matchers.diagnose.result

Class MatchResultMismatch<T,M extends org.hamcrest.Matcher<?>>

java.lang.Object

org.cthul.matchers.diagnose.SelfDescribingBase

org.cthul.matchers.diagnose.nested.PrecedencedSelfDescribingBase

org.cthul.matchers.diagnose.result.MatchResultBase<T,M>

org.cthul.matchers.diagnose.result.MatchResultMismatch<T,M>

All Implemented Interfaces:

PrecedencedSelfDescribing, MatchResult<T>, MatchResult.Mismatch<T>, org.hamcrest.SelfDescribing

Direct Known Subclasses:

AbstractMatchResult, AtomicMismatch, Nested.Mismatch

public class MatchResultMismatch<T,M extends org.hamcrest.Matcher<?>>
extends MatchResultBase<T,M>
implements MatchResult.Mismatch<T>

Implements a failed match.

Nested Class Summary

Nested classes/interfaces inherited from interface org.cthul.matchers.diagnose.result.MatchResult

MatchResult.Match<T>, MatchResult.Mismatch<T>

Field Summary

Fields inherited from interface org.cthul.matchers.diagnose.nested.PrecedencedSelfDescribing

P_AND, P_ATOMIC, P_COMPLEX, P_NONE, P_OR, P_UNARY, P_UNARY_NO_PAREN

Constructor Summary

Constructors

Constructor and Description
MatchResultMismatch(T value, M matcher)
MatchResultMismatch(T value, M matcher, PrecedencedSelfDescribing mismatchDescription)
MatchResultMismatch(T value, M matcher, org.hamcrest.SelfDescribing mismatchDescription)
MatchResultMismatch(T value, M matcher, String mismatchDescription)

Method Summary

Modifier and Type	Method and Description
void	describeExpected(org.hamcrest.Description d) Describes what was expected (e.g., describes the matcher).
void	describeMismatch(org.hamcrest.Description d) Describes the mismatch (e.g., uses the matcher's mismatch description).
void	describeTo(org.hamcrest.Description description)
int	getDescriptionPrecedence()
PrecedencedSelfDescribing	getExpectedDescription() Returns an object that will describe itself as the expected message.
int	getExpectedPrecedence() Returns the precedence of the expected message
MatchResult.Match<T>	getMatch() Returns details about a successful match.
MatchResult.Mismatch<T>	getMismatch() Returns details about a failed match.
PrecedencedSelfDescribing	getMismatchDescription() Returns an object that will describe itself as the mismatch.
int	getMismatchPrecedence() Returns the precedence of the mismatch
boolean	matched() Returns whether the value was matched.

Methods inherited from class org.cthul.matchers.diagnose.result.MatchResultBase

describeMatcher, getMatcher, getMatcherDescription, getMatcherPrecedence, getValue

Methods inherited from class org.cthul.matchers.diagnose.SelfDescribingBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cthul.matchers.diagnose.result.MatchResult

describeMatcher, getMatcher, getMatcherDescription, getMatcherPrecedence, getValue

Constructor Detail

MatchResultMismatch

public MatchResultMismatch(T value,
                           M matcher)

MatchResultMismatch

public MatchResultMismatch(T value,
                           M matcher,
                           String mismatchDescription)

MatchResultMismatch

public MatchResultMismatch(T value,
                           M matcher,
                           org.hamcrest.SelfDescribing mismatchDescription)

MatchResultMismatch

public MatchResultMismatch(T value,
                           M matcher,
                           PrecedencedSelfDescribing mismatchDescription)

Method Detail

matched

public boolean matched()

Description copied from interface: MatchResult

Returns whether the value was matched.

Specified by:

matched in interface MatchResult<T>

Returns:

true iff the value was matched.

getMatch

public MatchResult.Match<T> getMatch()

Description copied from interface: MatchResult

Returns details about a successful match.

Specified by:

getMatch in interface MatchResult<T>

Returns:

match or null

getMismatch

public MatchResult.Mismatch<T> getMismatch()

Description copied from interface: MatchResult

Returns details about a failed match.

Specified by:

getMismatch in interface MatchResult<T>

Returns:

mismatch or null

describeTo

public void describeTo(org.hamcrest.Description description)

Specified by:

describeTo in interface org.hamcrest.SelfDescribing

Specified by:

describeTo in class SelfDescribingBase

getDescriptionPrecedence

public int getDescriptionPrecedence()

Specified by:

getDescriptionPrecedence in interface PrecedencedSelfDescribing

describeExpected

public void describeExpected(org.hamcrest.Description d)

Description copied from interface: MatchResult.Mismatch

Describes what was expected (e.g., describes the matcher).

Specified by:

describeExpected in interface MatchResult.Mismatch<T>

getExpectedPrecedence

public int getExpectedPrecedence()

Description copied from interface: MatchResult.Mismatch

Returns the precedence of the expected message

Specified by:

getExpectedPrecedence in interface MatchResult.Mismatch<T>

Returns:

precdence

See Also:

PrecedencedSelfDescribing

getExpectedDescription

public PrecedencedSelfDescribing getExpectedDescription()

Description copied from interface: MatchResult.Mismatch

Returns an object that will describe itself as the expected message.

Specified by:

getExpectedDescription in interface MatchResult.Mismatch<T>

Returns:

match description

describeMismatch

public void describeMismatch(org.hamcrest.Description d)

Description copied from interface: MatchResult.Mismatch

Describes the mismatch (e.g., uses the matcher's mismatch description).

Specified by:

describeMismatch in interface MatchResult.Mismatch<T>

getMismatchPrecedence

public int getMismatchPrecedence()

Description copied from interface: MatchResult.Mismatch

Returns the precedence of the mismatch

Specified by:

getMismatchPrecedence in interface MatchResult.Mismatch<T>

Returns:

precdence

See Also:

PrecedencedSelfDescribing

getMismatchDescription

public PrecedencedSelfDescribing getMismatchDescription()

Description copied from interface: MatchResult.Mismatch

Returns an object that will describe itself as the mismatch.

Specified by:

getMismatchDescription in interface MatchResult.Mismatch<T>

Returns:

match description