org.cthul.matchers.diagnose

Class QuickDiagnosingMatcherBase<T>

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.cthul.matchers.diagnose.QuickDiagnosingMatcherBase<T>

Type Parameters:

T -

All Implemented Interfaces:

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

Direct Known Subclasses:

InstanceOf, NestedMatcher, QuickResultMatcherBase, TypesafeQuickDiagnoseMatcher

public abstract class QuickDiagnosingMatcherBase<T>
extends org.hamcrest.BaseMatcher<T>
implements QuickDiagnosingMatcher<T>

All QuickDiagnosingMatcher implementations should extend this class, or QuickMatcherBase. Only matches(java.lang.Object, org.hamcrest.Description) has to be implemented.

Has some abstract subclasses that provide a more features for matcher implementations. Each also has a typesafe variant.

See Also:

QuickMatcherBase, QuickResultMatcherBase, NestedMatcher, NestedResultMatcher

Constructor Summary

Constructors

Constructor and Description
QuickDiagnosingMatcherBase()

Method Summary

Modifier and Type	Method and Description
void	describeMismatch(Object item, org.hamcrest.Description description)
boolean	matches(Object o)
abstract boolean	matches(Object item, org.hamcrest.Description mismatch) Evaluates the matcher for argument item.
<I> MatchResult<I>	matchResult(I item) Returns a MatchResult that caches the mismatch descripton.
protected static boolean	quickMatch(org.hamcrest.Matcher<?> matcher, Object item, org.hamcrest.Description mismatch) Uses the matcher to validate item.
protected static boolean	quickMatch(org.hamcrest.Matcher<?> matcher, Object item, org.hamcrest.Description mismatch, String message) Similar to quickMatch(org.hamcrest.Matcher, java.lang.Object, org.hamcrest.Description), but allows to override the mismatch message.
protected static <T> MatchResult<T>	quickMatchResult(org.hamcrest.Matcher<?> matcher, T item)

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hamcrest.Matcher

_dont_implement_Matcher___instead_extend_BaseMatcher_

Methods inherited from interface org.hamcrest.SelfDescribing

describeTo

Constructor Detail

QuickDiagnosingMatcherBase

public QuickDiagnosingMatcherBase()

Method Detail

matches

public boolean matches(Object o)

Specified by:

matches in interface org.hamcrest.Matcher<T>

describeMismatch

public void describeMismatch(Object item,
                             org.hamcrest.Description description)

Specified by:

describeMismatch in interface org.hamcrest.Matcher<T>

Overrides:

describeMismatch in class org.hamcrest.BaseMatcher<T>

matches

public abstract 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.

Specified by:

matches in interface QuickDiagnosingMatcher<T>

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

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

Returns a MatchResult that caches the mismatch descripton.

Specified by:

matchResult in interface QuickDiagnosingMatcher<T>

Type Parameters:

I -

Parameters:

item -

Returns:

match result

quickMatch

protected static boolean quickMatch(org.hamcrest.Matcher<?> matcher,
                                    Object item,
                                    org.hamcrest.Description mismatch)

Uses the matcher to validate item. If validation fails, an error message is appended to mismatch.

The code is equivalent to

 if (matcher.matches(item)) {
     return true;
 } else {
     matcher.describeMismatch(item, mismatch);
     return false;
 }
 

but uses optimizations for diagnosing matchers.

Parameters:

matcher -

item -

mismatch -

Returns:

true iif item was matched

See Also:

DiagnosingMatcher, QuickDiagnosingMatcher

quickMatch

protected static boolean quickMatch(org.hamcrest.Matcher<?> matcher,
                                    Object item,
                                    org.hamcrest.Description mismatch,
                                    String message)

Similar to quickMatch(org.hamcrest.Matcher, java.lang.Object, org.hamcrest.Description), but allows to override the mismatch message.

If matching fails, message will be appended to mismatch. Any occurrence of "$1" in (@code message} will be replaced with the actual mismatch description of matcher.

Parameters:

matcher -

item -

mismatch -

message -

Returns:

true iif item was matched

quickMatchResult

protected static <T> MatchResult<T> quickMatchResult(org.hamcrest.Matcher<?> matcher,
                                                     T item)