Package org.hamcrest.collection

Class IsEmptyCollection<E>

java.lang.Object

org.hamcrest.BaseMatcher<Collection<? extends E>>

org.hamcrest.TypeSafeMatcher<Collection<? extends E>>

org.hamcrest.collection.IsEmptyCollection<E>

Type Parameters:

E - the collection element type

All Implemented Interfaces:

Matcher<Collection<? extends E>>, SelfDescribing

public class IsEmptyCollection<E>
extends TypeSafeMatcher<Collection<? extends E>>

Tests if a collection is empty.

Constructor Summary

Constructors

Constructor	Description
IsEmptyCollection()	Constructor, best called from empty() or emptyCollectionOf(Class).

Method Summary

Modifier and Type	Method	Description
void	describeMismatchSafely(Collection<? extends E> item, Description mismatchDescription)	Describe the mismatch.
void	describeTo(Description description)	Generates a description of the object.
static <E> Matcher<Collection<? extends E>>	empty()	Creates a matcher for Collections matching examined collections whose isEmpty method returns true.
static <E> Matcher<Collection<E>>	emptyCollectionOf(Class<E> unusedToForceReturnType)	Creates a matcher for Collections matching examined collections whose isEmpty method returns true.
boolean	matchesSafely(Collection<? extends E> item)	Check if the item matches.

Methods inherited from class org.hamcrest.TypeSafeMatcher

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

IsEmptyCollection

public IsEmptyCollection()

Constructor, best called from empty() or emptyCollectionOf(Class).

Method Details

matchesSafely

public boolean matchesSafely(Collection<? extends E> item)

Description copied from class: TypeSafeMatcher

Check if the item matches. The item will already have been checked for the specific type and will never be null. Subclasses should implement this.

Specified by:

matchesSafely in class TypeSafeMatcher<Collection<? extends E>>

Parameters:

item - the type safe item to match against.

Returns:

boolean true/false depending if item matches matcher.

describeMismatchSafely

public void describeMismatchSafely(Collection<? extends E> item,
 Description mismatchDescription)

Description copied from class: TypeSafeMatcher

Describe the mismatch. The item will already have been checked for the specific type and will never be null. Subclasses should override this.

Overrides:

describeMismatchSafely in class TypeSafeMatcher<Collection<? extends E>>

Parameters:

item - the type safe item to match against.

mismatchDescription - the mismatch description.

describeTo

public void describeTo(Description description)

Description copied from interface: SelfDescribing

Generates a description of the object. The description may be part of a description of a larger object of which this is just a component, so it should be worded appropriately.

Parameters:

description - The description to be built or appended to.

empty

public static <E> Matcher<Collection<? extends E>> empty()

Creates a matcher for Collections matching examined collections whose isEmpty method returns true. For example:

assertThat(new ArrayList<String>(), is(empty()))

Type Parameters:

E - the matcher type.

Returns:

The matcher.

emptyCollectionOf

public static <E> Matcher<Collection<E>> emptyCollectionOf(Class<E> unusedToForceReturnType)

Creates a matcher for Collections matching examined collections whose isEmpty method returns true. For example:

assertThat(new ArrayList<String>(), is(emptyCollectionOf(String.class)))

Type Parameters:

E - the matcher type.

Parameters:

unusedToForceReturnType - the type of the collection's content

Returns:

The matcher.