org.cthul.matchers.diagnose.result

Class MatchResultProxy<I,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>

org.cthul.matchers.diagnose.result.AbstractMatchResult<I,M>

org.cthul.matchers.diagnose.result.MatchResultProxy<I,M>

Type Parameters:

I -

M -

All Implemented Interfaces:

PrecedencedSelfDescribing, MatchResult<I>, MatchResult.Match<I>, MatchResult.Mismatch<I>, org.hamcrest.SelfDescribing

public class MatchResultProxy<I,M extends org.hamcrest.Matcher<?>>
extends AbstractMatchResult<I,M>

Can be used as a base class to decorate another match result. The other result is never exposed.

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
MatchResultProxy(MatchResult<?> result)
MatchResultProxy(MatchResult<?> result, I value, M matcher)

Method Summary

Modifier and Type	Method and Description
void	describeExpected(org.hamcrest.Description description) Describes what was expected (e.g., describes the matcher).
void	describeMatch(org.hamcrest.Description description) Describes the match (e.g., describes the matcher).
void	describeMismatch(org.hamcrest.Description description) Describes the mismatch (e.g., uses the matcher's mismatch description).
void	describeTo(org.hamcrest.Description description)
protected boolean	fastProxy()
int	getDescriptionPrecedence()
PrecedencedSelfDescribing	getExpectedDescription() Returns an object that will describe itself as the expected message.
int	getExpectedPrecedence() Returns the precedence of the expected message
PrecedencedSelfDescribing	getMatchDescription() Returns an object that will describe itself as the match.
int	getMatchPrecedence() Returns the precedence of the match message
PrecedencedSelfDescribing	getMismatchDescription() Returns an object that will describe itself as the mismatch.
int	getMismatchPrecedence() Returns the precedence of the mismatch
protected MatchResult.Match<?>	match() For internal use.
boolean	matched() Returns whether the value was matched.
protected MatchResult.Mismatch<?>	mismatch() For internal use.
protected MatchResult<?>	result()

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

getMatch, getMismatch

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

MatchResultProxy

public MatchResultProxy(MatchResult<?> result,
                        I value,
                        M matcher)

MatchResultProxy

public MatchResultProxy(MatchResult<?> result)

Method Detail

fastProxy

protected boolean fastProxy()

result

protected MatchResult<?> result()

match

protected MatchResult.Match<?> match()

For internal use. Fails if this is a mismatch.

Returns:

this

mismatch

protected MatchResult.Mismatch<?> mismatch()

For internal use. Fails if this is a match.

Returns:

this

matched

public boolean matched()

Description copied from interface: MatchResult

Returns whether the value was matched.

Specified by:

matched in interface MatchResult<I>

Overrides:

matched in class AbstractMatchResult<I,M extends org.hamcrest.Matcher<?>>

Returns:

true iff the value was matched.

describeTo

public void describeTo(org.hamcrest.Description description)

Specified by:

describeTo in interface org.hamcrest.SelfDescribing

Overrides:

describeTo in class AbstractMatchResult<I,M extends org.hamcrest.Matcher<?>>

getDescriptionPrecedence

public int getDescriptionPrecedence()

Specified by:

getDescriptionPrecedence in interface PrecedencedSelfDescribing

Overrides:

getDescriptionPrecedence in class AbstractMatchResult<I,M extends org.hamcrest.Matcher<?>>

describeMatch

public void describeMatch(org.hamcrest.Description description)

Description copied from interface: MatchResult.Match

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

Specified by:

describeMatch in interface MatchResult.Match<I>

Overrides:

describeMatch in class AbstractMatchResult<I,M extends org.hamcrest.Matcher<?>>

getMatchPrecedence

public int getMatchPrecedence()

Description copied from interface: MatchResult.Match

Returns the precedence of the match message

Specified by:

getMatchPrecedence in interface MatchResult.Match<I>

Overrides:

getMatchPrecedence in class AbstractMatchResult<I,M extends org.hamcrest.Matcher<?>>

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<I>

Overrides:

getMatchDescription in class AbstractMatchResult<I,M extends org.hamcrest.Matcher<?>>

Returns:

match description

describeExpected

public void describeExpected(org.hamcrest.Description description)

Description copied from interface: MatchResult.Mismatch

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

Specified by:

describeExpected in interface MatchResult.Mismatch<I>

Overrides:

describeExpected in class MatchResultMismatch<I,M extends org.hamcrest.Matcher<?>>

getExpectedPrecedence

public int getExpectedPrecedence()

Description copied from interface: MatchResult.Mismatch

Returns the precedence of the expected message

Specified by:

getExpectedPrecedence in interface MatchResult.Mismatch<I>

Overrides:

getExpectedPrecedence in class MatchResultMismatch<I,M extends org.hamcrest.Matcher<?>>

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<I>

Overrides:

getExpectedDescription in class MatchResultMismatch<I,M extends org.hamcrest.Matcher<?>>

Returns:

match description

describeMismatch

public void describeMismatch(org.hamcrest.Description description)

Description copied from interface: MatchResult.Mismatch

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

Specified by:

describeMismatch in interface MatchResult.Mismatch<I>

Overrides:

describeMismatch in class MatchResultMismatch<I,M extends org.hamcrest.Matcher<?>>

getMismatchPrecedence

public int getMismatchPrecedence()

Description copied from interface: MatchResult.Mismatch

Returns the precedence of the mismatch

Specified by:

getMismatchPrecedence in interface MatchResult.Mismatch<I>

Overrides:

getMismatchPrecedence in class MatchResultMismatch<I,M extends org.hamcrest.Matcher<?>>

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<I>

Overrides:

getMismatchDescription in class MatchResultMismatch<I,M extends org.hamcrest.Matcher<?>>

Returns:

match description