Package org.hamcrest.collection

Class IsIterableWithSize<E>

java.lang.Object

org.hamcrest.BaseMatcher<Iterable<E>>

org.hamcrest.TypeSafeDiagnosingMatcher<Iterable<E>>

org.hamcrest.FeatureMatcher<Iterable<E>,Integer>

org.hamcrest.collection.IsIterableWithSize<E>

Type Parameters:

E - the iterable element type

All Implemented Interfaces:

Matcher<Iterable<E>>, SelfDescribing

public class IsIterableWithSize<E>
extends FeatureMatcher<Iterable<E>,Integer>

Matches if iterable size satisfies a size matcher.

Constructor Summary

Constructors

Constructor	Description
IsIterableWithSize(Matcher<? super Integer> sizeMatcher)	Constructor, best called from iterableWithSize(int) or iterableWithSize(Matcher).

Method Summary

Modifier and Type	Method	Description
protected Integer	featureValueOf(Iterable<E> actual)	Implement this to extract the interesting feature.
static <E> Matcher<Iterable<E>>	iterableWithSize(int size)	Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields an item count that is equal to the specified size argument.
static <E> Matcher<Iterable<E>>	iterableWithSize(Matcher<? super Integer> sizeMatcher)	Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields an item count that satisfies the specified matcher.

Methods inherited from class org.hamcrest.FeatureMatcher

describeTo, matchesSafely

Methods inherited from class org.hamcrest.TypeSafeDiagnosingMatcher

describeMismatch, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull, toString

Methods inherited from class java.lang.Object

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

Constructor Details

IsIterableWithSize

public IsIterableWithSize(Matcher<? super Integer> sizeMatcher)

Constructor, best called from iterableWithSize(int) or iterableWithSize(Matcher).

Parameters:

sizeMatcher - checks the expected size of the iterable

Method Details

featureValueOf

protected Integer featureValueOf(Iterable<E> actual)

Description copied from class: FeatureMatcher

Implement this to extract the interesting feature.

Specified by:

featureValueOf in class FeatureMatcher<Iterable<E>,Integer>

Parameters:

actual - the target object

Returns:

the feature to be matched

iterableWithSize

public static <E> Matcher<Iterable<E>> iterableWithSize(Matcher<? super Integer> sizeMatcher)

Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields an item count that satisfies the specified matcher. For example:

assertThat(Arrays.asList("foo", "bar"), iterableWithSize(equalTo(2)))

Type Parameters:

E - the matcher type.

Parameters:

sizeMatcher - a matcher for the number of items that should be yielded by an examined Iterable

Returns:

The matcher.

iterableWithSize

public static <E> Matcher<Iterable<E>> iterableWithSize(int size)

Creates a matcher for Iterables that matches when a single pass over the examined Iterable yields an item count that is equal to the specified size argument. For example:

assertThat(Arrays.asList("foo", "bar"), iterableWithSize(2))

Type Parameters:

E - the matcher type.

Parameters:

size - the number of items that should be yielded by an examined Iterable

Returns:

The matcher.