Top Constructors Methods
org.hamcrest.collection

public Class ArrayMatching

extends Object
Class Inheritance
Imports
org.hamcrest.Matcher, org.hamcrest.internal.NullSafety, java.util.ArrayList, .Collection, .List
Author
Steve Freeman 2016 http://www.hamcrest.com Collected helper code for converting matchers between lists and iterables.

Constructor Summary

AccessConstructor and Description
public
ArrayMatching()

Method Summary

Modifier and TypeMethod and Description
public static <E> Matcher<E[]>
arrayContaining(E...
the items that must equal the items within an examined array
items)

Creates a matcher for arrays that matches when each item in the examined array is logically equal to the corresponding item in the specified items.

public static <E> Matcher<E[]>
arrayContaining(Matcher<? super E>...
the matchers that must be satisfied by the items in the examined array
itemMatchers)

Creates a matcher for arrays that matches when each item in the examined array satisfies the corresponding matcher in the specified matchers.

public static <E> Matcher<E[]>
arrayContaining(List<Matcher<? super E>>
a list of matchers, each of which must be satisfied by the corresponding item in an examined array
itemMatchers)

Creates a matcher for arrays that matches when each item in the examined array satisfies the corresponding matcher in the specified list of matchers.

public static <E> Matcher<E[]>
arrayContainingInAnyOrder(Matcher<? super E>...
a list of matchers, each of which must be satisfied by an entry in an examined array
itemMatchers)

Creates an order agnostic matcher for arrays that matches when each item in the examined array satisfies one matcher anywhere in the specified matchers.

public static <E> Matcher<E[]>
arrayContainingInAnyOrder(Collection<Matcher<? super E>>
a list of matchers, each of which must be satisfied by an item provided by an examined array
itemMatchers)

Creates an order agnostic matcher for arrays that matches when each item in the examined array satisfies one matcher anywhere in the specified collection of matchers.

public static <E> Matcher<E[]>
arrayContainingInAnyOrder(E...
the items that must equal the entries of an examined array, in any order
items)

Creates an order agnostic matcher for arrays that matches when each item in the examined array is logically equal to one item anywhere in the specified items.

public static <E> List<Matcher<? super E>>
asEqualMatchers(E[] items)

public static <T> Matcher<T[]>
hasItemInArray(Matcher<? super T>
the matcher to apply to elements in examined arrays
elementMatcher)

Creates a matcher for arrays that matches when the examined array contains at least one item that is matched by the specified elementMatcher.

public static <T> Matcher<T[]>
hasItemInArray(T
the element that should be present in examined arrays
element)

A shortcut to the frequently used hasItemInArray(equalTo(x)).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

ArrayMatchingback to summary
public ArrayMatching()

Method Detail

arrayContainingback to summary
public static <E> Matcher<E[]> arrayContaining(E... items)

Creates a matcher for arrays that matches when each item in the examined array is logically equal to the corresponding item in the specified items. For a positive match, the examined array must be of the same length as the number of specified items. For example: 

assertThat(new String[]{"foo", "bar"}, contains("foo", "bar"))
Parameters
items:E[]

the items that must equal the items within an examined array

Annotations
@SafeVarargs
arrayContainingback to summary
public static <E> Matcher<E[]> arrayContaining(Matcher<? super E>... itemMatchers)

Creates a matcher for arrays that matches when each item in the examined array satisfies the corresponding matcher in the specified matchers. For a positive match, the examined array must be of the same length as the number of specified matchers. For example: 

assertThat(new String[]{"foo", "bar"}, arrayContaining(equalTo("foo"), equalTo("bar")))
Parameters
itemMatchers:Matcher<? super E>[]

the matchers that must be satisfied by the items in the examined array

Annotations
@SafeVarargs
arrayContainingback to summary
public static <E> Matcher<E[]> arrayContaining(List<Matcher<? super E>> itemMatchers)

Creates a matcher for arrays that matches when each item in the examined array satisfies the corresponding matcher in the specified list of matchers. For a positive match, the examined array must be of the same length as the specified list of matchers. For example: 

assertThat(new String[]{"foo", "bar"}, arrayContaining(Arrays.asList(equalTo("foo"), equalTo("bar"))))
Parameters
itemMatchers:List<Matcher<? super E>>

a list of matchers, each of which must be satisfied by the corresponding item in an examined array

arrayContainingInAnyOrderback to summary
public static <E> Matcher<E[]> arrayContainingInAnyOrder(Matcher<? super E>... itemMatchers)

Creates an order agnostic matcher for arrays that matches when each item in the examined array satisfies one matcher anywhere in the specified matchers. For a positive match, the examined array must be of the same length as the number of specified matchers.

N.B. each of the specified matchers will only be used once during a given examination, so be careful when specifying matchers that may be satisfied by more than one entry in an examined array.

For example: 

assertThat(new String[]{"foo", "bar"}, arrayContainingInAnyOrder(equalTo("bar"), equalTo("foo")))
Parameters
itemMatchers:Matcher<? super E>[]

a list of matchers, each of which must be satisfied by an entry in an examined array

Annotations
@SafeVarargs
arrayContainingInAnyOrderback to summary
public static <E> Matcher<E[]> arrayContainingInAnyOrder(Collection<Matcher<? super E>> itemMatchers)

Creates an order agnostic matcher for arrays that matches when each item in the examined array satisfies one matcher anywhere in the specified collection of matchers. For a positive match, the examined array must be of the same length as the specified collection of matchers.

N.B. each matcher in the specified collection will only be used once during a given examination, so be careful when specifying matchers that may be satisfied by more than one entry in an examined array.

For example: 

assertThat(new String[]{"foo", "bar"}, arrayContainingInAnyOrder(Arrays.asList(equalTo("bar"), equalTo("foo"))))
Parameters
itemMatchers:Collection<Matcher<? super E>>

a list of matchers, each of which must be satisfied by an item provided by an examined array

arrayContainingInAnyOrderback to summary
public static <E> Matcher<E[]> arrayContainingInAnyOrder(E... items)

Creates an order agnostic matcher for arrays that matches when each item in the examined array is logically equal to one item anywhere in the specified items. For a positive match, the examined array must be of the same length as the number of specified items.

N.B. each of the specified items will only be used once during a given examination, so be careful when specifying items that may be equal to more than one entry in an examined array.

For example: 

assertThat(new String[]{"foo", "bar"}, containsInAnyOrder("bar", "foo"))
Parameters
items:E[]

the items that must equal the entries of an examined array, in any order

Annotations
@SafeVarargs
asEqualMatchersback to summary
public static <E> List<Matcher<? super E>> asEqualMatchers(E[] items)
hasItemInArrayback to summary
public static <T> Matcher<T[]> hasItemInArray(Matcher<? super T> elementMatcher)

Creates a matcher for arrays that matches when the examined array contains at least one item that is matched by the specified elementMatcher. Whilst matching, the traversal of the examined array will stop as soon as a matching element is found. For example: 

assertThat(new String[] {"foo", "bar"}, hasItemInArray(startsWith("ba")))
Parameters
elementMatcher:Matcher<? super T>

the matcher to apply to elements in examined arrays

hasItemInArrayback to summary
public static <T> Matcher<T[]> hasItemInArray(T element)

A shortcut to the frequently used hasItemInArray(equalTo(x)). For example: 

assertThat(hasItemInArray(x))
instead of: 
assertThat(hasItemInArray(equalTo(x)))
Parameters
element:T

the element that should be present in examined arrays