org.cornutum.hamcrest

Class Composites

java.lang.Object

org.cornutum.hamcrest.Composites

public final class Composites
extends Object

Defines methods to create composite matchers.

Method Summary

Modifier and Type	Method and Description
static <T,R> MatchesFunction.Builder<T,R>	comparedTo(T expected) Returns a new MatchesFunction.Builder for the given expected object.
static <T> Matcher<T[]>	containsElements(Function<T,Matcher<T>> elementMatcherSupplier, Iterable<? extends T> expected) Returns a Matcher for an array containing the given collection of elements in any order, with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.
static <T> Matcher<T[]>	containsElements(Function<T,Matcher<T>> elementMatcherSupplier, Iterator<T> expected) Returns a Matcher for an array containing the given collection of elements in any order, with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.
static <T> Matcher<T[]>	containsElements(Function<T,Matcher<T>> elementMatcherSupplier, T... expected) Returns a Matcher for an array containing the given collection of elements in any order, with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected array.
static <T> Matcher<T[]>	containsElements(Iterable<? extends T> expected) Returns a Matcher for an array containing the given collection of elements in any order.
static <T> Matcher<T[]>	containsElements(Iterator<T> expected) Returns a Matcher for an array containing the given collection of elements in any order.
static <T> Matcher<T[]>	containsElements(T... expected) Returns a Matcher for an array containing the given collection of elements in any order.
static <K,V> Matcher<Map<K,V>>	containsEntries(Function<K,Matcher<K>> keyMatcherSupplier, Function<V,Matcher<V>> valueMatcherSupplier, Map<K,V> expected) Returns a Matcher for the expected Map, matching each entry with its expected counterpart using the key and value Matchers returned by the given suppliers.
static <K,V> Matcher<Map<K,V>>	containsEntries(Function<V,Matcher<V>> valueMatcherSupplier, Map<K,V> expected) Returns a Matcher for the expected Map, matching each entry with its expected counterpart using the value Matcher returned by the given supplier.
static <K,V> Matcher<Map<K,V>>	containsEntries(Map<K,V> expected) Returns a Matcher for the expected Map.
static <T> Matcher<Iterable<T>>	containsMembers(Function<T,Matcher<T>> memberMatcherSupplier, Iterable<? extends T> expected) Returns a Matcher for an Iterable containing the given collection of members in any order, with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected Iterable.
static <T> Matcher<Iterable<T>>	containsMembers(Function<T,Matcher<T>> memberMatcherSupplier, Iterator<T> expected) Returns a Matcher for an Iterable containing the given collection of members in any order, with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected Iterable.
static <T> Matcher<Iterable<T>>	containsMembers(Function<T,Matcher<T>> memberMatcherSupplier, T... expected) Returns a Matcher for an Iterable containing the given collection of members in any order, with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected Iterable.
static <T> Matcher<Iterable<T>>	containsMembers(Iterable<? extends T> expected) Returns a Matcher for an Iterable containing the given collection of members in any order.
static <T> Matcher<Iterable<T>>	containsMembers(Iterator<T> expected) Returns a Matcher for an Iterable containing the given collection of members in any order.
static <T> Matcher<Iterable<T>>	containsMembers(T... expected) Returns a Matcher for an Iterable containing the given collection of members in any order.
static <T> Matcher<T[]>	listsElements(Function<T,Matcher<T>> elementMatcherSupplier, Iterable<? extends T> expected) Returns a Matcher for an array containing the given sequence of elements (in order), with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.
static <T> Matcher<T[]>	listsElements(Function<T,Matcher<T>> elementMatcherSupplier, Iterator<T> expected) Returns a Matcher for an array containing the given sequence of elements (in order), with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.
static <T> Matcher<T[]>	listsElements(Function<T,Matcher<T>> elementMatcherSupplier, T... expected) Returns a Matcher for an array containing the given sequence of elements (in order), with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its counterpart in the given expected array.
static <T> Matcher<T[]>	listsElements(Iterable<? extends T> expected) Returns a Matcher for an array containing the given sequence of elements (in order).
static <T> Matcher<T[]>	listsElements(Iterator<T> expected) Returns a Matcher for an array containing the given sequence of elements (in order).
static <T> Matcher<T[]>	listsElements(T... expected) Returns a Matcher for an array containing the given sequence of elements (in order).
static <T> Matcher<Iterable<T>>	listsMatching(Function<T,Matcher<T>> memberMatcherSupplier, Iterable<? extends T> expected) Returns a Matcher for an Iterable containing the given sequence of members (in order).
static <T> Matcher<Iterable<T>>	listsMatching(Function<T,Matcher<T>> memberMatcherSupplier, Iterator<T> expected) Returns a Matcher for an Iterable containing the given sequence of members (in order).
static <T> Matcher<Iterable<T>>	listsMatching(Function<T,Matcher<T>> memberMatcherSupplier, T... expected) Returns a Matcher for an Iterable containing the given sequence of members (in order).
static <T> Matcher<Iterable<T>>	listsMembers(Function<T,Matcher<T>> memberMatcherSupplier, Iterable<? extends T> expected) Returns a Matcher for an Iterable containing the given sequence of members (in order), with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.
static <T> Matcher<Iterable<T>>	listsMembers(Function<T,Matcher<T>> memberMatcherSupplier, Iterator<T> expected) Returns a Matcher for an Iterable containing the given sequence of members (in order), with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.
static <T> Matcher<Iterable<T>>	listsMembers(Function<T,Matcher<T>> memberMatcherSupplier, T... expected) Returns a Matcher for an Iterable containing the given sequence of members (in order), with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.
static <T> Matcher<Iterable<T>>	listsMembers(Iterable<? extends T> expected) Returns a Matcher for an Iterable containing the given sequence of members (in order).
static <T> Matcher<Iterable<T>>	listsMembers(Iterator<T> expected) Returns a Matcher for an Iterable containing the given sequence of members (in order).
static <T> Matcher<Iterable<T>>	listsMembers(T... expected) Returns a Matcher for an Iterable containing the given sequence of members (in order).
static <T> Matcher<T>	matches(Matcher<T> matcherExpression) To create a more expressive reference, especially for a constructor expression, simply returns the given Matcher value.
static <T,R> Matcher<T>	matchesFunction(String functionName, Function<T,R> function, T source, Function<R,Matcher<R>> resultMatcherSupplier) Returns a Matcher that compares values of the given function, using a result Matcher returned by the given supplier.
static <T> Matcher<Iterator<T>>	visitsList(Function<T,Matcher<T>> memberMatcherSupplier, Iterable<? extends T> expected) Returns a Matcher for an Iterator that visits the given sequence of members (in order), with an additional match condition: each member of a matched sequence must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.
static <T> Matcher<Iterator<T>>	visitsList(Function<T,Matcher<T>> memberMatcherSupplier, Iterator<T> expected) Returns a Matcher for an Iterator that visits the given sequence of members (in order), with an additional match condition: each member of a matched sequence must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.
static <T> Matcher<Iterator<T>>	visitsList(Function<T,Matcher<T>> memberMatcherSupplier, T... expected) Returns a Matcher for an Iterator that visits the given sequence of members (in order), with an additional match condition: each member of a matched sequence must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.
static <T> Matcher<Iterator<T>>	visitsList(Iterable<? extends T> expected) Returns a Matcher for an Iterator that visits the given sequence of members (in order).
static <T> Matcher<Iterator<T>>	visitsList(Iterator<T> expected) Returns a Matcher for an Iterator that visits the given sequence of members (in order).
static <T> Matcher<Iterator<T>>	visitsList(T... expected) Returns a Matcher for an Iterator that visits the given sequence of members (in order).
static <T> Matcher<Iterator<T>>	visitsMembers(Function<T,Matcher<T>> memberMatcherSupplier, Iterable<? extends T> expected) Returns a Matcher for an Iterator that visits the given collection of members in any order, with an additional match condition: each member of a matched collection must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.
static <T> Matcher<Iterator<T>>	visitsMembers(Function<T,Matcher<T>> memberMatcherSupplier, Iterator<T> expected) Returns a Matcher for an Iterator that visits the given collection of members in any order, with an additional match condition: each member of a matched collection must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.
static <T> Matcher<Iterator<T>>	visitsMembers(Function<T,Matcher<T>> memberMatcherSupplier, T... expected) Returns a Matcher for an Iterator that visits the given collection of members in any order, with an additional match condition: each member of a matched collection must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.
static <T> Matcher<Iterator<T>>	visitsMembers(Iterable<? extends T> expected) Returns a Matcher for an Iterator that visits the given collection of members in any order.
static <T> Matcher<Iterator<T>>	visitsMembers(Iterator<T> expected) Returns a Matcher for an Iterator that visits the given collection of members in any order.
static <T> Matcher<Iterator<T>>	visitsMembers(T... expected) Returns a Matcher for an Iterator that visits the given collection of members in any order.

Methods inherited from class java.lang.Object

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

Method Detail

containsMembers

public static <T> Matcher<Iterable<T>> containsMembers(Iterable<? extends T> expected)

Returns a Matcher for an Iterable containing the given collection of members in any order.

containsMembers

public static <T> Matcher<Iterable<T>> containsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                       Iterable<? extends T> expected)

Returns a Matcher for an Iterable containing the given collection of members in any order, with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected Iterable.

containsMembers

@SafeVarargs
public static <T> Matcher<Iterable<T>> containsMembers(T... expected)

Returns a Matcher for an Iterable containing the given collection of members in any order.

containsMembers

@SafeVarargs
public static <T> Matcher<Iterable<T>> containsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                                    T... expected)

Returns a Matcher for an Iterable containing the given collection of members in any order, with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected Iterable.

containsMembers

public static <T> Matcher<Iterable<T>> containsMembers(Iterator<T> expected)

Returns a Matcher for an Iterable containing the given collection of members in any order.

containsMembers

public static <T> Matcher<Iterable<T>> containsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                       Iterator<T> expected)

Returns a Matcher for an Iterable containing the given collection of members in any order, with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected Iterable.

containsElements

@SafeVarargs
public static <T> Matcher<T[]> containsElements(T... expected)

Returns a Matcher for an array containing the given collection of elements in any order.

containsElements

@SafeVarargs
public static <T> Matcher<T[]> containsElements(Function<T,Matcher<T>> elementMatcherSupplier,
                                                             T... expected)

Returns a Matcher for an array containing the given collection of elements in any order, with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected array.

containsElements

public static <T> Matcher<T[]> containsElements(Iterable<? extends T> expected)

Returns a Matcher for an array containing the given collection of elements in any order.

containsElements

public static <T> Matcher<T[]> containsElements(Function<T,Matcher<T>> elementMatcherSupplier,
                                                Iterable<? extends T> expected)

Returns a Matcher for an array containing the given collection of elements in any order, with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.

containsElements

public static <T> Matcher<T[]> containsElements(Iterator<T> expected)

Returns a Matcher for an array containing the given collection of elements in any order.

containsElements

public static <T> Matcher<T[]> containsElements(Function<T,Matcher<T>> elementMatcherSupplier,
                                                Iterator<T> expected)

Returns a Matcher for an array containing the given collection of elements in any order, with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.

visitsMembers

@SafeVarargs
public static <T> Matcher<Iterator<T>> visitsMembers(T... expected)

Returns a Matcher for an Iterator that visits the given collection of members in any order.

visitsMembers

@SafeVarargs
public static <T> Matcher<Iterator<T>> visitsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                                  T... expected)

Returns a Matcher for an Iterator that visits the given collection of members in any order, with an additional match condition: each member of a matched collection must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.

visitsMembers

public static <T> Matcher<Iterator<T>> visitsMembers(Iterable<? extends T> expected)

Returns a Matcher for an Iterator that visits the given collection of members in any order.

visitsMembers

public static <T> Matcher<Iterator<T>> visitsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                     Iterable<? extends T> expected)

Returns a Matcher for an Iterator that visits the given collection of members in any order, with an additional match condition: each member of a matched collection must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.

visitsMembers

public static <T> Matcher<Iterator<T>> visitsMembers(Iterator<T> expected)

Returns a Matcher for an Iterator that visits the given collection of members in any order.

visitsMembers

public static <T> Matcher<Iterator<T>> visitsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                     Iterator<T> expected)

Returns a Matcher for an Iterator that visits the given collection of members in any order, with an additional match condition: each member of a matched collection must satisfy the Matcher returned by the given supplier for its equals-matching counterpart in the given expected collection.

listsMembers

public static <T> Matcher<Iterable<T>> listsMembers(Iterable<? extends T> expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order).

listsMembers

public static <T> Matcher<Iterable<T>> listsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                    Iterable<? extends T> expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order), with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.

listsMembers

@SafeVarargs
public static <T> Matcher<Iterable<T>> listsMembers(T... expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order).

listsMembers

@SafeVarargs
public static <T> Matcher<Iterable<T>> listsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                                 T... expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order), with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.

listsMembers

public static <T> Matcher<Iterable<T>> listsMembers(Iterator<T> expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order).

listsMembers

public static <T> Matcher<Iterable<T>> listsMembers(Function<T,Matcher<T>> memberMatcherSupplier,
                                                    Iterator<T> expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order), with an additional match condition: each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.

listsElements

@SafeVarargs
public static <T> Matcher<T[]> listsElements(T... expected)

Returns a Matcher for an array containing the given sequence of elements (in order).

listsElements

@SafeVarargs
public static <T> Matcher<T[]> listsElements(Function<T,Matcher<T>> elementMatcherSupplier,
                                                          T... expected)

Returns a Matcher for an array containing the given sequence of elements (in order), with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its counterpart in the given expected array.

listsElements

public static <T> Matcher<T[]> listsElements(Iterable<? extends T> expected)

Returns a Matcher for an array containing the given sequence of elements (in order).

listsElements

public static <T> Matcher<T[]> listsElements(Function<T,Matcher<T>> elementMatcherSupplier,
                                             Iterable<? extends T> expected)

Returns a Matcher for an array containing the given sequence of elements (in order), with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.

listsElements

public static <T> Matcher<T[]> listsElements(Iterator<T> expected)

Returns a Matcher for an array containing the given sequence of elements (in order).

listsElements

public static <T> Matcher<T[]> listsElements(Function<T,Matcher<T>> elementMatcherSupplier,
                                             Iterator<T> expected)

Returns a Matcher for an array containing the given sequence of elements (in order), with an additional match condition: each element of a matched array must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.

visitsList

@SafeVarargs
public static <T> Matcher<Iterator<T>> visitsList(T... expected)

Returns a Matcher for an Iterator that visits the given sequence of members (in order).

visitsList

@SafeVarargs
public static <T> Matcher<Iterator<T>> visitsList(Function<T,Matcher<T>> memberMatcherSupplier,
                                                               T... expected)

Returns a Matcher for an Iterator that visits the given sequence of members (in order), with an additional match condition: each member of a matched sequence must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.

visitsList

public static <T> Matcher<Iterator<T>> visitsList(Iterable<? extends T> expected)

Returns a Matcher for an Iterator that visits the given sequence of members (in order).

visitsList

public static <T> Matcher<Iterator<T>> visitsList(Function<T,Matcher<T>> memberMatcherSupplier,
                                                  Iterable<? extends T> expected)

Returns a Matcher for an Iterator that visits the given sequence of members (in order), with an additional match condition: each member of a matched sequence must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.

visitsList

public static <T> Matcher<Iterator<T>> visitsList(Iterator<T> expected)

Returns a Matcher for an Iterator that visits the given sequence of members (in order).

visitsList

public static <T> Matcher<Iterator<T>> visitsList(Function<T,Matcher<T>> memberMatcherSupplier,
                                                  Iterator<T> expected)

Returns a Matcher for an Iterator that visits the given sequence of members (in order), with an additional match condition: each member of a matched sequence must satisfy the Matcher returned by the given supplier for its counterpart in the given expected sequence.

listsMatching

public static <T> Matcher<Iterable<T>> listsMatching(Function<T,Matcher<T>> memberMatcherSupplier,
                                                     Iterable<? extends T> expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order). Each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.

listsMatching

@SafeVarargs
public static <T> Matcher<Iterable<T>> listsMatching(Function<T,Matcher<T>> memberMatcherSupplier,
                                                                  T... expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order). Each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.

listsMatching

public static <T> Matcher<Iterable<T>> listsMatching(Function<T,Matcher<T>> memberMatcherSupplier,
                                                     Iterator<T> expected)

Returns a Matcher for an Iterable containing the given sequence of members (in order). Each member of a matched Iterable must satisfy the Matcher returned by the given supplier for its counterpart in the given expected Iterable.

containsEntries

public static <K,V> Matcher<Map<K,V>> containsEntries(Map<K,V> expected)

Returns a Matcher for the expected Map.

containsEntries

public static <K,V> Matcher<Map<K,V>> containsEntries(Function<V,Matcher<V>> valueMatcherSupplier,
                                                      Map<K,V> expected)

Returns a Matcher for the expected Map, matching each entry with its expected counterpart using the value Matcher returned by the given supplier.

containsEntries

public static <K,V> Matcher<Map<K,V>> containsEntries(Function<K,Matcher<K>> keyMatcherSupplier,
                                                      Function<V,Matcher<V>> valueMatcherSupplier,
                                                      Map<K,V> expected)

Returns a Matcher for the expected Map, matching each entry with its expected counterpart using the key and value Matchers returned by the given suppliers.

matchesFunction

public static <T,R> Matcher<T> matchesFunction(String functionName,
                                               Function<T,R> function,
                                               T source,
                                               Function<R,Matcher<R>> resultMatcherSupplier)

Returns a Matcher that compares values of the given function, using a result Matcher returned by the given supplier.

matches

public static <T> Matcher<T> matches(Matcher<T> matcherExpression)

To create a more expressive reference, especially for a constructor expression, simply returns the given Matcher value.

comparedTo

public static <T,R> MatchesFunction.Builder<T,R> comparedTo(T expected)

Returns a new MatchesFunction.Builder for the given expected object.