SubstringMatcher (Hamcrest)

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

Fields
Modifier and Type Field Description

protected java.lang.String substring

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`substring`

Constructor Summary

Constructors
Modifier Constructor Description

protected SubstringMatcher(java.lang.String substring)

Constructors
Modifier	Constructor	Description
`protected`	`SubstringMatcher(java.lang.String substring)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`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.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

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

- 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()
```

Class SubstringMatcher

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.hamcrest.BaseMatcher

Methods inherited from class java.lang.Object

Methods inherited from class org.hamcrest.TypeSafeMatcher

Field Detail

substring

Constructor Detail

SubstringMatcher

Method Detail

matchesSafely

describeMismatchSafely

describeTo

evalSubstringOf

relationship