SubstringMatcher (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.core
Class SubstringMatcher

    java.lang.Object
      org.hamcrest.BaseMatcher<T>
          org.hamcrest.TypeSafeMatcher<java.lang.String>
              org.hamcrest.core.SubstringMatcher

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

Direct Known Subclasses:
  StringContains, StringEndsWith, StringStartsWith

    public abstract class SubstringMatcher

extends TypeSafeMatcher<java.lang.String>

Field Summary
`protected java.lang.String` | `substring`

Constructor Summary
`protected` | `SubstringMatcher(java.lang.String substring)`

Method Summary
`void` | `describeMismatchSafely(java.lang.String item, Description mismatchDescription)` Subclasses should override this.
`void` | `describeTo(Description description)` Generates a description of the object.
`protected abstract boolean` | `evalSubstringOf(java.lang.String string)`
`boolean` | `matchesSafely(java.lang.String item)` Subclasses should implement this.
`protected abstract java.lang.String` | `relationship()`

Methods inherited from class org.hamcrest.TypeSafeMatcher
`describeMismatch, matches`

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`

Field Detail

### substring

    protected final java.lang.String substring

Constructor Detail

### SubstringMatcher

    protected SubstringMatcher(java.lang.String substring)

Method Detail

### matchesSafely

    public 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>`

### describeMismatchSafely

    public void describeMismatchSafely(java.lang.String item,
                                       Description mismatchDescription)

  Description copied from class: `TypeSafeMatcher`
  Subclasses should override this. The item will already have been checked for the specific type and will never be null.

  Overrides:
    `describeMismatchSafely` in class `TypeSafeMatcher<java.lang.String>`

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

### evalSubstringOf

    protected abstract boolean evalSubstringOf(java.lang.String string)

### relationship

    protected abstract java.lang.String relationship()

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