Package org.hamcrest.collection

Class IsArray<T>

java.lang.Object
org.hamcrest.BaseMatcher<T[]>
org.hamcrest.TypeSafeMatcher<T[]>
org.hamcrest.collection.IsArray<T>
Type Parameters:
T - the array element type
All Implemented Interfaces:
Matcher<T[]>, SelfDescribing
public class IsArray<T> extends TypeSafeMatcher<T[]>
Matcher for array whose elements satisfy a sequence of matchers. The array size must equal the number of element matchers.

  • Constructor Details

    • IsArray

      public IsArray(Matcher<? super T>[] elementMatchers)
      Constructor, best called from array(Matcher[]).
      Parameters:
      elementMatchers - matchers for expected values

  • Method Details

    • matchesSafely

      public boolean matchesSafely(T[] array)
      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<T[]>
      Parameters:
      array - the type safe item to match against.
      Returns:
      boolean true/false depending if item matches matcher.

    • describeMismatchSafely

      public void describeMismatchSafely(T[] actual, 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<T[]>
      Parameters:
      actual - 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.

    • descriptionStart

      protected String descriptionStart()
      Returns the string that starts the description. Can be overridden in subclasses to customise how the matcher is described.
      Returns:
      The description prefix.

    • descriptionSeparator

      protected String descriptionSeparator()
      Returns the string that separates the elements in the description. Can be overridden in subclasses to customise how the matcher is described.
      Returns:
      The description separator.

    • descriptionEnd

      protected String descriptionEnd()
      Returns the string that ends the description. Can be overridden in subclasses to customise how the matcher is described.
      Returns:
      The description suffix.

    • array

      public static <T> IsArray<T> array(Matcher<? super T>... elementMatchers)
      Creates a matcher that matches arrays whose elements are satisfied by the specified matchers. Matches positively only if the number of matchers specified is equal to the length of the examined array and each matcher[i] is satisfied by array[i]. For example: 
      assertThat(new Integer[]{1,2,3}, is(array(equalTo(1), equalTo(2), equalTo(3))))
      Type Parameters:
      T - the matcher type.
      Parameters:
      elementMatchers - the matchers that the elements of examined arrays should satisfy
      Returns:
      The matcher.