org.cthul.matchers.diagnose

Class QuickDiagnose

java.lang.Object

org.cthul.matchers.diagnose.QuickDiagnose

public class QuickDiagnose
extends Object

Provides utility methods to get quick-diagnose features for matchers of unknown type.

See Also:

matches(org.hamcrest.Matcher, java.lang.Object, org.hamcrest.Description), matches(org.hamcrest.Matcher, java.lang.Object, org.hamcrest.Description, java.lang.String)

Constructor Summary

Constructors

Constructor and Description
QuickDiagnose()

Method Summary

Modifier and Type	Method and Description
static boolean	diagnosingHackActivated()
static void	disableDiagnosingHack() Disables the optimization hack for DiagnosingMatcher, which calls DiagnosingMatcher.matches(java.lang.Object, org.hamcrest.Description) directly.
static <T> QuickDiagnosingMatcher<T>	matcher(org.hamcrest.Matcher<T> matcher)
static boolean	matches(org.hamcrest.Matcher<?> matcher, Object item, org.hamcrest.Description mismatch) Uses the matcher to validate item.
static boolean	matches(org.hamcrest.Matcher<?> matcher, Object item, org.hamcrest.Description mismatch, String message) Similar to matches(org.hamcrest.Matcher, java.lang.Object, org.hamcrest.Description), but allows to override the mismatch message.
static <T> MatchResult<T>	matchResult(org.hamcrest.Matcher<?> matcher, T item)

Methods inherited from class java.lang.Object

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

Constructor Detail

QuickDiagnose

public QuickDiagnose()

Method Detail

matches

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

Uses the matcher to validate item. If validation fails, an error message is stored in 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

matches

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

Similar to matches(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:

match result

matchResult

public static <T> MatchResult<T> matchResult(org.hamcrest.Matcher<?> matcher,
                                             T item)

matcher

public static <T> QuickDiagnosingMatcher<T> matcher(org.hamcrest.Matcher<T> matcher)

disableDiagnosingHack

public static void disableDiagnosingHack()

Disables the optimization hack for DiagnosingMatcher, which calls DiagnosingMatcher.matches(java.lang.Object, org.hamcrest.Description) directly.

This method has to be invoked before the hack is executed the first time.

Throws:

IllegalStateException - if the hack was already activated.

diagnosingHackActivated

public static boolean diagnosingHackActivated()