Package org.hamcrest.collection

Class IsMapContaining<K,V>

java.lang.Object
org.hamcrest.BaseMatcher<Map<? extends K,? extends V>>
org.hamcrest.TypeSafeMatcher<Map<? extends K,? extends V>>
org.hamcrest.collection.IsMapContaining<K,V>
Type Parameters:
K - the type of the map keys
V - the type of the map values
All Implemented Interfaces:
Matcher<Map<? extends K,? extends V>>, SelfDescribing
public class IsMapContaining<K,V> extends TypeSafeMatcher<Map<? extends K,? extends V>>
Matches if map keys, values or entries match the value matchers.

  • Constructor Details

  • Method Details

    • matchesSafely

      public boolean matchesSafely(Map<? extends K,? extends V> map)
      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<Map<? extends K,? extends V>>
      Parameters:
      map - the type safe item to match against.
      Returns:
      boolean true/false depending if item matches matcher.

    • describeMismatchSafely

      public void describeMismatchSafely(Map<? extends K,? extends V> map, 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<Map<? extends K,? extends V>>
      Parameters:
      map - 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.

    • hasEntry

      public static <K, V> Matcher<Map<? extends K,? extends V>> hasEntry(Matcher<? super K> keyMatcher, Matcher<? super V> valueMatcher)
      Creates a matcher for Maps matching when the examined Map contains at least one entry whose key satisfies the specified keyMatcher and whose value satisfies the specified valueMatcher. For example: 
      assertThat(myMap, hasEntry(equalTo("bar"), equalTo("foo")))
      Type Parameters:
      K - the map key type.
      V - the map value type.
      Parameters:
      keyMatcher - the key matcher that, in combination with the valueMatcher, must be satisfied by at least one entry
      valueMatcher - the value matcher that, in combination with the keyMatcher, must be satisfied by at least one entry
      Returns:
      The matcher.

    • hasEntry

      public static <K, V> Matcher<Map<? extends K,? extends V>> hasEntry(K key, V value)
      Creates a matcher for Maps matching when the examined Map contains at least one entry whose key equals the specified key and whose value equals the specified value. For example: 
      assertThat(myMap, hasEntry("bar", "foo"))
      Type Parameters:
      K - the map key type.
      V - the map value type.
      Parameters:
      key - the key that, in combination with the value, must be describe at least one entry
      value - the value that, in combination with the key, must be describe at least one entry
      Returns:
      The matcher.

    • hasKey

      public static <K> Matcher<Map<? extends K,?>> hasKey(Matcher<? super K> keyMatcher)
      Creates a matcher for Maps matching when the examined Map contains at least one key that satisfies the specified matcher. For example: 
      assertThat(myMap, hasKey(equalTo("bar")))
      Type Parameters:
      K - the map key type.
      Parameters:
      keyMatcher - the matcher that must be satisfied by at least one key
      Returns:
      The matcher.

    • hasKey

      public static <K> Matcher<Map<? extends K,?>> hasKey(K key)
      Creates a matcher for Maps matching when the examined Map contains at least one key that is equal to the specified key. For example: 
      assertThat(myMap, hasKey("bar"))
      Type Parameters:
      K - the map key type.
      Parameters:
      key - the key that satisfying maps must contain
      Returns:
      The matcher.

    • hasValue

      public static <V> Matcher<Map<?,? extends V>> hasValue(Matcher<? super V> valueMatcher)
      Creates a matcher for Maps matching when the examined Map contains at least one value that satisfies the specified valueMatcher. For example: 
      assertThat(myMap, hasValue(equalTo("foo")))
      Type Parameters:
      V - the value type.
      Parameters:
      valueMatcher - the matcher that must be satisfied by at least one value
      Returns:
      The matcher.

    • hasValue

      public static <V> Matcher<Map<?,? extends V>> hasValue(V value)
      Creates a matcher for Maps matching when the examined Map contains at least one value that is equal to the specified value. For example: 
      assertThat(myMap, hasValue("foo"))
      Type Parameters:
      V - the value type.
      Parameters:
      value - the value that satisfying maps must contain
      Returns:
      The matcher.