org.cthul.matchers.diagnose

Interface QuickDiagnosingMatcher<T>

Type Parameters:

T -

All Superinterfaces:

org.hamcrest.Matcher<T>, org.hamcrest.SelfDescribing

All Known Implementing Classes:

AndChainMatcher, AndChainMatcher.Builder, CausedBy, ChainBuilderBase, CIs, ContainsPattern, ExceptionMessage, HasDescription, HasMatchResult, InstanceOf, IsMatchResult, MatcherAccepts, MatcherChainBase, MatcherDescription, MatcherProxy, MatchResultExpected, NestedMatcher, NestedResultMatcher, NOrChainMatcher, NOrChainMatcher.Builder, OrChainMatcher, OrChainMatcher.Builder, QuickDiagnosingMatcherBase, QuickMatcherBase, QuickResultMatcherBase, Raises, Returns, SomeOfChainMatcher, SomeOfChainMatcher.Builder, TypesafeFeatureMatcher, TypesafeNestedMatcher, TypesafeNestedResultMatcher, TypesafeQuickDiagnoseMatcher, TypesafeQuickMatcher, TypesafeQuickResultMatcher, XOrChainMatcher, XOrChainMatcher.Builder

public interface QuickDiagnosingMatcher<T>
extends org.hamcrest.Matcher<T>

A Matcher that is able to match and diagnose in one step, but, unlike DiagnosingMatcher, also provides an efficient implementation for the simple match.

The matcher is also able to provide a MatchResult that caches all relevant information about the match.

Implementations of this interface should extend QuickDiagnosingMatcherBase. See this class for more implementation tips.

Method Summary

Modifier and Type	Method and Description
boolean	matches(Object item, org.hamcrest.Description mismatch) Evaluates the matcher for argument item.
<I> MatchResult<I>	matchResult(I item) Returns a MatchResult for item

Methods inherited from interface org.hamcrest.Matcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, describeMismatch, matches

Methods inherited from interface org.hamcrest.SelfDescribing

describeTo

Method Detail

matches

boolean matches(Object item,
                org.hamcrest.Description mismatch)

Evaluates the matcher for argument item.

A mismatch description is appended to mismatch if and only if the match fails.

Parameters:

item - The object against which the matcher is evaluated.

mismatch - The description to be built or appended to.

Returns:

true if item matches, otherwise false.

matchResult

<I> MatchResult<I> matchResult(I item)

Returns a MatchResult for item

Type Parameters:

I -

Parameters:

item -

Returns:

match result