MatchesPattern (Hamcrest 3.0 API)

org.hamcrest.text

## Class MatchesPattern

- java.lang.Object
- - org.hamcrest.BaseMatcher<T>
  - - org.hamcrest.TypeSafeMatcher<java.lang.String>
    - - org.hamcrest.text.MatchesPattern

- All Implemented Interfaces:
    Matcher<java.lang.String>, SelfDescribing

      public class MatchesPattern
      extends TypeSafeMatcher<java.lang.String>

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `MatchesPattern(java.util.regex.Pattern pattern)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `describeTo(Description description)` Generates a description of the object.
    `static Matcher<java.lang.String>` | `matchesPattern(java.util.regex.Pattern pattern)` Creates a matcher of `String` that matches when the examined string exactly matches the given `Pattern`.
    `static Matcher<java.lang.String>` | `matchesPattern(java.lang.String regex)` Creates a matcher of `String` that matches when the examined string exactly matches the given regular expression, treated as a `Pattern`.
    `protected boolean` | `matchesSafely(java.lang.String item)` Subclasses should implement this.

    - ### Methods inherited from class org.hamcrest.TypeSafeMatcher

      `describeMismatch, describeMismatchSafely, matches`

    - ### Methods inherited from class org.hamcrest.BaseMatcher

      `_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### MatchesPattern

          public MatchesPattern(java.util.regex.Pattern pattern)

  - ### Method Detail

    - #### matchesSafely

          protected boolean matchesSafely(java.lang.String item)

      Description copied from class: `TypeSafeMatcher`
      Subclasses should implement this. The item will already have been checked for the specific type and will never be null.
      Specified by:
        `matchesSafely` in class `TypeSafeMatcher<java.lang.String>`
      Parameters:
        `item` - the type safe item to match against.
      Returns:
        boolean true/false depending if item matches matcher.

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

    - #### matchesPattern

          public static Matcher<java.lang.String> matchesPattern(java.util.regex.Pattern pattern)

      Creates a matcher of `String` that matches when the examined string exactly matches the given `Pattern`.
      Parameters:
        `pattern` - the text pattern to match.
      Returns:
        The matcher.

    - #### matchesPattern

          public static Matcher<java.lang.String> matchesPattern(java.lang.String regex)

      Creates a matcher of `String` that matches when the examined string exactly matches the given regular expression, treated as a `Pattern`.
      Parameters:
        `regex` - the regex to match.
      Returns:
        The matcher.