org.cornutum.hamcrest

Class BaseCompositeMatcher<T>

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.cornutum.hamcrest.BaseCompositeMatcher<T>

All Implemented Interfaces:

Matcher<T>, SelfDescribing

Direct Known Subclasses:

ClassCompositeMatcher, MapEntryMatcher

public abstract class BaseCompositeMatcher<T>
extends BaseMatcher<T>

Base class for a Matcher that applies a sequence of Matchers to a single object.

To define a "deep match" between two instances of type T, create a subclass that uses expectThat() to add Matchers that compare instances property-by-property.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseCompositeMatcher(T expected) Creates a new BaseCompositeMatcher instance.

Method Summary

Modifier and Type	Method and Description
protected static <T> ContainsElements.Supplier<T>	containsElementsMatching(Function<T,Matcher<T>> elementMatcherSupplier) Returns a new ContainsElements.Supplier that supplies a ContainsElements matcher using the given element Matcher supplier.
protected static <K,V> ContainsEntries.Supplier<K,V>	containsEntriesMatching(Function<K,Matcher<K>> keyMatcherSupplier, Function<V,Matcher<V>> valueMatcherSupplier) Returns a new ContainsEntries.Supplier that supplies a ContainsEntries matcher that matches entries using the given key and value Matcher suppliers.
protected static <K,V> ContainsEntries.Supplier<K,V>	containsEntriesMatching(Function<V,Matcher<V>> valueMatcherSupplier) Returns a new ContainsEntries.Supplier that supplies a ContainsEntries matcher that matches entries using the given value Matcher supplier.
protected static <T,S extends Iterable<T>> ContainsMembers.Supplier<T,S>	containsMembersMatching(Function<T,Matcher<T>> memberMatcherSupplier) Returns a new ContainsMembers.Supplier that supplies a ContainsMembers matcher using the given member Matcher supplier.
void	describeMismatch(Object actual, Description description)
void	describeTo(Description description)
protected void	expectThat(Function<T,Matcher<? super T>> matcherSupplier) Adds the Matcher supplied for the expected object to the matchers applied by this Matcher.
protected <R> void	expectThat(String functionName, Function<T,R> function, Function<R,Matcher<R>> resultMatcherSupplier) Adds a MatchesFunction matcher for the expected object to the matchers applied by this Matcher.
protected Matcher<? super T>	getTypeMismatch(Object object) If the given object is incompatible with the expected type, returns a Matcher that describes the mismatch.
protected static <T> ListsElements.Supplier<T>	listsElementsMatching(Function<T,Matcher<T>> elementMatcherSupplier) Returns a new ListsElements.Supplier that supplies a ListsElements matcher using the given element Matcher supplier.
protected static <T,S extends Iterable<T>> ListsMatching.Supplier<T,S>	listsMatching(Function<T,Matcher<T>> memberMatcherSupplier) Returns a new ListsMatching.Supplier that supplies a ListsMatching matcher using the given member Matcher supplier.
protected static <T,S extends Iterable<T>> ListsMembers.Supplier<T,S>	listsMembersMatching(Function<T,Matcher<T>> memberMatcherSupplier) Returns a new ListsMembers.Supplier that supplies a ListsMembers matcher using the given member Matcher supplier.
protected Function<T,Matcher<? super T>>	matches(Function<T,Matcher<? super T>> matcherSupplier) Decorates another Matcher supplier to provide a more expressive interface.
boolean	matches(Object actual)
String	toString()
protected <R> MatchesFunction.Supplier<T,R>	valueOf(String functionName, Function<T,R> function) Returns a new MatchesFunction.Supplier that supplies a MatchesFunction matcher using the given function.
protected static <T> VisitsList.Supplier<T>	visitsListMatching(Function<T,Matcher<T>> memberMatcherSupplier) Returns a new VisitsList.Supplier that supplies a VisitsList matcher using the given member Matcher supplier.
protected static <T> VisitsMembers.Supplier<T>	visitsMembersMatching(Function<T,Matcher<T>> memberMatcherSupplier) Returns a new VisitsMembers.Supplier that supplies a VisitsMembers matcher using the given member Matcher supplier.

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCompositeMatcher

protected BaseCompositeMatcher(T expected)

Creates a new BaseCompositeMatcher instance.

Method Detail

matches

public boolean matches(Object actual)

describeTo

public void describeTo(Description description)

describeMismatch

public void describeMismatch(Object actual,
                             Description description)

Specified by:

describeMismatch in interface Matcher<T>

Overrides:

describeMismatch in class BaseMatcher<T>

getTypeMismatch

protected Matcher<? super T> getTypeMismatch(Object object)

If the given object is incompatible with the expected type, returns a Matcher that describes the mismatch. Otherwise, return null;

expectThat

protected void expectThat(Function<T,Matcher<? super T>> matcherSupplier)

Adds the Matcher supplied for the expected object to the matchers applied by this Matcher.

expectThat

protected <R> void expectThat(String functionName,
                              Function<T,R> function,
                              Function<R,Matcher<R>> resultMatcherSupplier)

Adds a MatchesFunction matcher for the expected object to the matchers applied by this Matcher.

matches

protected Function<T,Matcher<? super T>> matches(Function<T,Matcher<? super T>> matcherSupplier)

Decorates another Matcher supplier to provide a more expressive interface.

valueOf

protected <R> MatchesFunction.Supplier<T,R> valueOf(String functionName,
                                                    Function<T,R> function)

Returns a new MatchesFunction.Supplier that supplies a MatchesFunction matcher using the given function.

containsMembersMatching

protected static <T,S extends Iterable<T>> ContainsMembers.Supplier<T,S> containsMembersMatching(Function<T,Matcher<T>> memberMatcherSupplier)

Returns a new ContainsMembers.Supplier that supplies a ContainsMembers matcher using the given member Matcher supplier.

containsElementsMatching

protected static <T> ContainsElements.Supplier<T> containsElementsMatching(Function<T,Matcher<T>> elementMatcherSupplier)

Returns a new ContainsElements.Supplier that supplies a ContainsElements matcher using the given element Matcher supplier.

visitsMembersMatching

protected static <T> VisitsMembers.Supplier<T> visitsMembersMatching(Function<T,Matcher<T>> memberMatcherSupplier)

Returns a new VisitsMembers.Supplier that supplies a VisitsMembers matcher using the given member Matcher supplier.

listsMembersMatching

protected static <T,S extends Iterable<T>> ListsMembers.Supplier<T,S> listsMembersMatching(Function<T,Matcher<T>> memberMatcherSupplier)

Returns a new ListsMembers.Supplier that supplies a ListsMembers matcher using the given member Matcher supplier.

listsMatching

protected static <T,S extends Iterable<T>> ListsMatching.Supplier<T,S> listsMatching(Function<T,Matcher<T>> memberMatcherSupplier)

Returns a new ListsMatching.Supplier that supplies a ListsMatching matcher using the given member Matcher supplier.

listsElementsMatching

protected static <T> ListsElements.Supplier<T> listsElementsMatching(Function<T,Matcher<T>> elementMatcherSupplier)

Returns a new ListsElements.Supplier that supplies a ListsElements matcher using the given element Matcher supplier.

visitsListMatching

protected static <T> VisitsList.Supplier<T> visitsListMatching(Function<T,Matcher<T>> memberMatcherSupplier)

Returns a new VisitsList.Supplier that supplies a VisitsList matcher using the given member Matcher supplier.

containsEntriesMatching

protected static <K,V> ContainsEntries.Supplier<K,V> containsEntriesMatching(Function<V,Matcher<V>> valueMatcherSupplier)

Returns a new ContainsEntries.Supplier that supplies a ContainsEntries matcher that matches entries using the given value Matcher supplier.

containsEntriesMatching

protected static <K,V> ContainsEntries.Supplier<K,V> containsEntriesMatching(Function<K,Matcher<K>> keyMatcherSupplier,
                                                                             Function<V,Matcher<V>> valueMatcherSupplier)

Returns a new ContainsEntries.Supplier that supplies a ContainsEntries matcher that matches entries using the given key and value Matcher suppliers.

toString

public String toString()

Overrides:

toString in class BaseMatcher<T>