org.cthul.matchers.diagnose.result

Class MatchResultSuccess<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.MatchResultSuccess<T,M>

All Implemented Interfaces:

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

Direct Known Subclasses:

Nested.Match

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

Implements a successful 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
MatchResultSuccess(T value, M matcher)
MatchResultSuccess(T value, M matcher, PrecedencedSelfDescribing matchDescription)
MatchResultSuccess(T value, M matcher, org.hamcrest.SelfDescribing matchDescription)
MatchResultSuccess(T value, M matcher, String matchDescription)

Method Summary

Modifier and Type	Method and Description
void	describeMatch(org.hamcrest.Description d) Describes the match (e.g., describes the matcher).
void	describeTo(org.hamcrest.Description description)
int	getDescriptionPrecedence()
MatchResult.Match<T>	getMatch() Returns details about a successful match.
PrecedencedSelfDescribing	getMatchDescription() Returns an object that will describe itself as the match.
int	getMatchPrecedence() Returns the precedence of the match message
MatchResult.Mismatch<T>	getMismatch() Returns details about a failed match.
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

MatchResultSuccess

public MatchResultSuccess(T value,
                          M matcher)

MatchResultSuccess

public MatchResultSuccess(T value,
                          M matcher,
                          String matchDescription)

MatchResultSuccess

public MatchResultSuccess(T value,
                          M matcher,
                          org.hamcrest.SelfDescribing matchDescription)

MatchResultSuccess

public MatchResultSuccess(T value,
                          M matcher,
                          PrecedencedSelfDescribing matchDescription)

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

describeMatch

public void describeMatch(org.hamcrest.Description d)

Description copied from interface: MatchResult.Match

Describes the match (e.g., describes the matcher).

Specified by:

describeMatch in interface MatchResult.Match<T>

getMatchPrecedence

public int getMatchPrecedence()

Description copied from interface: MatchResult.Match

Returns the precedence of the match message

Specified by:

getMatchPrecedence in interface MatchResult.Match<T>

Returns:

precdence

See Also:

PrecedencedSelfDescribing

getMatchDescription

public PrecedencedSelfDescribing getMatchDescription()

Description copied from interface: MatchResult.Match

Returns an object that will describe itself as the match.

Specified by:

getMatchDescription in interface MatchResult.Match<T>

Returns:

match description