Package org.hamcrest.collection

Class IsMapWithSize<K,V>

java.lang.Object

org.hamcrest.BaseMatcher<Map<? extends K,? extends V>>

org.hamcrest.TypeSafeDiagnosingMatcher<Map<? extends K,? extends V>>

org.hamcrest.FeatureMatcher<Map<? extends K,? extends V>,Integer>

org.hamcrest.collection.IsMapWithSize<K,V>

Type Parameters:

K - the map key type.

V - the map value type.

All Implemented Interfaces:

Matcher<Map<? extends K,? extends V>>, SelfDescribing

public final class IsMapWithSize<K,V>
extends FeatureMatcher<Map<? extends K,? extends V>,Integer>

Matches if map size satisfies a nested matcher.

Constructor Summary

Constructors

Constructor	Description
IsMapWithSize(Matcher<? super Integer> sizeMatcher)	Constructor, best called from aMapWithSize(int), aMapWithSize(Matcher), or anEmptyMap().

Method Summary

Modifier and Type	Method	Description
static <K, V> Matcher<Map<? extends K,? extends V>>	aMapWithSize(int size)	Creates a matcher for Maps that matches when the size() method returns a value equal to the specified size.
static <K, V> Matcher<Map<? extends K,? extends V>>	aMapWithSize(Matcher<? super Integer> sizeMatcher)	Creates a matcher for Maps that matches when the size() method returns a value that satisfies the specified matcher.
static <K, V> Matcher<Map<? extends K,? extends V>>	anEmptyMap()	Creates a matcher for Maps that matches when the size() method returns zero.
protected Integer	featureValueOf(Map<? extends K,? extends V> actual)	Implement this to extract the interesting feature.

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

IsMapWithSize

public IsMapWithSize(Matcher<? super Integer> sizeMatcher)

Constructor, best called from aMapWithSize(int), aMapWithSize(Matcher), or anEmptyMap().

Parameters:

sizeMatcher - matcher for the expected size of the map

Method Details

featureValueOf

protected Integer featureValueOf(Map<? extends K,? extends V> actual)

Description copied from class: FeatureMatcher

Implement this to extract the interesting feature.

Specified by:

featureValueOf in class FeatureMatcher<Map<? extends K,? extends V>,Integer>

Parameters:

actual - the target object

Returns:

the feature to be matched

aMapWithSize

public static <K,
V>
Matcher<Map<? extends K,? extends V>> aMapWithSize(Matcher<? super Integer> sizeMatcher)

Creates a matcher for Maps that matches when the size() method returns a value that satisfies the specified matcher. For example:

assertThat(myMap, is(aMapWithSize(equalTo(2))))

Type Parameters:

K - the map key type.

V - the map value type.

Parameters:

sizeMatcher - a matcher for the size of an examined Map

Returns:

The matcher.

aMapWithSize

public static <K,
V>
Matcher<Map<? extends K,? extends V>> aMapWithSize(int size)

Creates a matcher for Maps that matches when the size() method returns a value equal to the specified size. For example:

assertThat(myMap, is(aMapWithSize(2)))

Type Parameters:

K - the map key type.

V - the map value type.

Parameters:

size - the expected size of an examined Map

Returns:

The matcher.

anEmptyMap

public static <K,
V>
Matcher<Map<? extends K,? extends V>> anEmptyMap()

Creates a matcher for Maps that matches when the size() method returns zero. For example:

assertThat(myMap, is(anEmptyMap()))

Type Parameters:

K - the map key type.

V - the map value type.

Returns:

The matcher.