Package org.hamcrest.core
Class IsCollectionContaining<T>
- java.lang.Object
-
- org.hamcrest.BaseMatcher<T>
-
- org.hamcrest.TypeSafeDiagnosingMatcher<java.lang.Iterable<? super T>>
-
- org.hamcrest.core.IsCollectionContaining<T>
-
- All Implemented Interfaces:
Matcher<java.lang.Iterable<? super T>>
,SelfDescribing
public class IsCollectionContaining<T> extends TypeSafeDiagnosingMatcher<java.lang.Iterable<? super T>>
-
-
Constructor Summary
Constructors Constructor Description IsCollectionContaining(Matcher<? super T> elementMatcher)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
describeTo(Description description)
Generates a description of the object.static <T> Matcher<java.lang.Iterable<? super T>>
hasItem(Matcher<? super T> itemMatcher)
Creates a matcher forIterable
s that only matches when a single pass over the examinedIterable
yields at least one item that is matched by the specifieditemMatcher
.static <T> Matcher<java.lang.Iterable<? super T>>
hasItem(T item)
Creates a matcher forIterable
s that only matches when a single pass over the examinedIterable
yields at least one item that is equal to the specifieditem
.static <T> Matcher<java.lang.Iterable<T>>
hasItems(Matcher<? super T>... itemMatchers)
Creates a matcher forIterable
s that matches when consecutive passes over the examinedIterable
yield at least one item that is matched by the corresponding matcher from the specifieditemMatchers
.static <T> Matcher<java.lang.Iterable<T>>
hasItems(T... items)
Creates a matcher forIterable
s that matches when consecutive passes over the examinedIterable
yield at least one item that is equal to the corresponding item from the specifieditems
.protected boolean
matchesSafely(java.lang.Iterable<? super T> collection, Description mismatchDescription)
Subclasses should implement this.-
Methods inherited from class org.hamcrest.TypeSafeDiagnosingMatcher
describeMismatch, matches
-
Methods inherited from class org.hamcrest.BaseMatcher
_dont_implement_Matcher___instead_extend_BaseMatcher_, toString
-
-
-
-
Method Detail
-
matchesSafely
protected boolean matchesSafely(java.lang.Iterable<? super T> collection, Description mismatchDescription)
Description copied from class:TypeSafeDiagnosingMatcher
Subclasses should implement this. The item will already have been checked for the specific type and will never be null.- Specified by:
matchesSafely
in classTypeSafeDiagnosingMatcher<java.lang.Iterable<? super T>>
-
describeTo
public void describeTo(Description description)
Description copied from interface:SelfDescribing
Generates a description of the object. The description may be part of a 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.
-
hasItem
public static <T> Matcher<java.lang.Iterable<? super T>> hasItem(Matcher<? super T> itemMatcher)
Creates a matcher forIterable
s that only matches when a single pass over the examinedIterable
yields at least one item that is matched by the specifieditemMatcher
. Whilst matching, the traversal of the examinedIterable
will stop as soon as a matching item is found. For example:assertThat(Arrays.asList("foo", "bar"), hasItem(startsWith("ba")))
- Parameters:
itemMatcher
- the matcher to apply to items provided by the examinedIterable
-
hasItem
public static <T> Matcher<java.lang.Iterable<? super T>> hasItem(T item)
Creates a matcher forIterable
s that only matches when a single pass over the examinedIterable
yields at least one item that is equal to the specifieditem
. Whilst matching, the traversal of the examinedIterable
will stop as soon as a matching item is found. For example:assertThat(Arrays.asList("foo", "bar"), hasItem("bar"))
- Parameters:
item
- the item to compare against the items provided by the examinedIterable
-
hasItems
public static <T> Matcher<java.lang.Iterable<T>> hasItems(Matcher<? super T>... itemMatchers)
Creates a matcher forIterable
s that matches when consecutive passes over the examinedIterable
yield at least one item that is matched by the corresponding matcher from the specifieditemMatchers
. Whilst matching, each traversal of the examinedIterable
will stop as soon as a matching item is found. For example:assertThat(Arrays.asList("foo", "bar", "baz"), hasItems(endsWith("z"), endsWith("o")))
- Parameters:
itemMatchers
- the matchers to apply to items provided by the examinedIterable
-
hasItems
public static <T> Matcher<java.lang.Iterable<T>> hasItems(T... items)
Creates a matcher forIterable
s that matches when consecutive passes over the examinedIterable
yield at least one item that is equal to the corresponding item from the specifieditems
. Whilst matching, each traversal of the examinedIterable
will stop as soon as a matching item is found. For example:assertThat(Arrays.asList("foo", "bar", "baz"), hasItems("baz", "foo"))
- Parameters:
items
- the items to compare against the items provided by the examinedIterable
-
-