IsIn (Hamcrest)
Date: 2012-07-09

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.hamcrest.collection
Class IsIn<T>

    java.lang.Object
      org.hamcrest.BaseMatcher<T>
          org.hamcrest.collection.IsIn<T>

All Implemented Interfaces:
  Matcher<T>, SelfDescribing

    public class IsIn<T>

extends BaseMatcher<T>

Constructor Summary
`IsIn(java.util.Collection<T> collection)`
`IsIn(T[] elements)`

Method Summary
`void` | `describeTo(Description buffer)` Generates a description of the object.
`static
`<T> Matcher<T>`
` | `isIn(java.util.Collection<T> collection)` Creates a matcher that matches when the examined object is found within the specified collection.
`static
`<T> Matcher<T>`
` | `isIn(T[] elements)` Creates a matcher that matches when the examined object is found within the specified array.
`static
`<T> Matcher<T>`
` | `isOneOf(T... elements)` Creates a matcher that matches when the examined object is equal to one of the specified elements.
`boolean` | `matches(java.lang.Object o)` Evaluates the matcher for argument item.

Methods inherited from class org.hamcrest.BaseMatcher
`_dont_implement_Matcher___instead_extend_BaseMatcher_, describeMismatch, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### IsIn

    public IsIn(java.util.Collection<T> collection)

### IsIn

    public IsIn(T[] elements)

Method Detail

### matches

    public boolean matches(java.lang.Object o)

  Description copied from interface: `Matcher`
  Evaluates the matcher for argument item.

  This method matches against Object, instead of the generic type T. This is because the caller of the Matcher does not know at runtime what the type is (because of type erasure with Java generics). It is down to the implementations to check the correct type.

  Parameters:
    `o` - the object against which the matcher is evaluated.
  Returns:
    `true` if item matches, otherwise `false`.
  See Also:
    `BaseMatcher`

### describeTo

    public void describeTo(Description buffer)

  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:
    `buffer` - The description to be built or appended to.

### isIn

    public static <T> Matcher<T> isIn(java.util.Collection<T> collection)

  Creates a matcher that matches when the examined object is found within the specified collection.

  For example:

      assertThat("foo", isIn(Arrays.asList("bar", "foo")))

  Parameters:
    `collection` - the collection in which matching items must be found

### isIn

    public static <T> Matcher<T> isIn(T[] elements)

  Creates a matcher that matches when the examined object is found within the specified array.

  For example:

      assertThat("foo", isIn(new String[]{"bar", "foo"}))

  Parameters:
    `elements` - the array in which matching items must be found

### isOneOf

    public static <T> Matcher<T> isOneOf(T... elements)

  Creates a matcher that matches when the examined object is equal to one of the specified elements.

  For example:

      assertThat("foo", isIn("bar", "foo"))

  Parameters:
    `elements` - the elements amongst which matching items will be found

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD