Is (JUnit API)
Date: 2011-08-22

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

## org.hamcrest.core
Class Is<T>

    java.lang.Object
      org.hamcrest.BaseMatcher<T>
          org.hamcrest.core.Is<T>

All Implemented Interfaces:
  Matcher<T>, SelfDescribing

    public class Is<T>

extends BaseMatcher<T>

Decorates another Matcher, retaining the behavior but allowing tests to be slightly more expressive. eg. assertThat(cheese, equalTo(smelly)) vs assertThat(cheese, is(equalTo(smelly)))

Constructor Summary
`Is(Matcher<T> matcher)`

Method Summary
`void` | `describeTo(Description description)` Generates a description of the object.
`static Matcher<Object>` | `is(Class<?> type)` This is a shortcut to the frequently used is(instanceOf(SomeClass.class)).
`static
`<T> Matcher<T>`
` | `is(Matcher<T> matcher)` Decorates another Matcher, retaining the behavior but allowing tests to be slightly more expressive.
`static
`<T> Matcher<T>`
` | `is(T value)` This is a shortcut to the frequently used is(equalTo(x)).
`boolean` | `matches(Object arg)` Evaluates the matcher for argument item.

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

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

Constructor Detail

### Is

    public Is(Matcher<T> matcher)

Method Detail

### matches

    public boolean matches(Object arg)

  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:
    `arg` - the object against which the matcher is evaluated.
  Returns:
    `true` if item matches, otherwise `false`.
  See Also:
    `BaseMatcher`

### 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.

### is

    public static <T> Matcher<T> is(Matcher<T> matcher)

  Decorates another Matcher, retaining the behavior but allowing tests to be slightly more expressive. eg. assertThat(cheese, equalTo(smelly)) vs assertThat(cheese, is(equalTo(smelly)))

### is

    public static <T> Matcher<T> is(T value)

  This is a shortcut to the frequently used is(equalTo(x)). eg. assertThat(cheese, is(equalTo(smelly))) vs assertThat(cheese, is(smelly))

### is

    public static Matcher<Object> is(Class<?> type)

  This is a shortcut to the frequently used is(instanceOf(SomeClass.class)). eg. assertThat(cheese, is(instanceOf(Cheddar.class))) vs assertThat(cheese, is(Cheddar.class))

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