org.cthul.matchers.diagnose.result

Interface MatchResult<T>

Type Parameters:

T -

All Superinterfaces:

PrecedencedSelfDescribing, org.hamcrest.SelfDescribing

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractMatchResult, AtomicMismatch, MatchResultBase, MatchResultMismatch, MatchResultProxy, MatchResultSuccess, Nested.Match, Nested.Mismatch, Nested.Result, NestedMatcher.NestedMatch, NestedMatcher.NestedMismatch, NestedMatcher.NestedResult, NestedResultMatcher.NestedMatch, NestedResultMatcher.NestedMismatch, NestedResultMatcher.NestedResult

public interface MatchResult<T>
extends PrecedencedSelfDescribing

Provides detailed information about the result of a match. The result's description is the match or mismatch description.

Implementations should extends MatchResultBase

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MatchResult.Match<T> Provides detailed information about a match.
static interface	MatchResult.Mismatch<T> Provides detailed information about a mismatch.

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

Method Summary

Modifier and Type	Method and Description
void	describeMatcher(org.hamcrest.Description description) Describes the matcher.
MatchResult.Match<T>	getMatch() Returns details about a successful match.
org.hamcrest.Matcher<?>	getMatcher() Returns the matcher.
PrecedencedSelfDescribing	getMatcherDescription() Returns an object that will describe itself as the matcher.
int	getMatcherPrecedence() Returns the matcher's message precedence.
MatchResult.Mismatch<T>	getMismatch() Returns details about a failed match.
T	getValue() Returns the value that was matched.
boolean	matched() Returns whether the value was matched.

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

getDescriptionPrecedence

Methods inherited from interface org.hamcrest.SelfDescribing

describeTo

Method Detail

matched

boolean matched()

Returns whether the value was matched.

Returns:

true iff the value was matched.

getMatch

MatchResult.Match<T> getMatch()

Returns details about a successful match.

Returns:

match or null

getMismatch

MatchResult.Mismatch<T> getMismatch()

Returns details about a failed match.

Returns:

mismatch or null

getValue

T getValue()

Returns the value that was matched.

Returns:

value

getMatcher

org.hamcrest.Matcher<?> getMatcher()

Returns the matcher.

Returns:

matcher

describeMatcher

void describeMatcher(org.hamcrest.Description description)

Describes the matcher.

Parameters:

description -

getMatcherPrecedence

int getMatcherPrecedence()

Returns the matcher's message precedence.

Returns:

precedence

See Also:

PrecedencedSelfDescribing

getMatcherDescription

PrecedencedSelfDescribing getMatcherDescription()

Returns an object that will describe itself as the matcher.

Returns:

matcher description