com.shazam.shazamcrest.matcher

Interface CustomisableMatcher<T>

All Superinterfaces:

org.hamcrest.Matcher<T>, org.hamcrest.SelfDescribing

public interface CustomisableMatcher<T>
extends org.hamcrest.Matcher<T>

Matcher implementation where fields and object types can be skipped from the comparison, or matched with custom matchers.

Method Summary

Methods

Modifier and Type	Method and Description
CustomisableMatcher<T>	ignoring(Class<?> clazz) Specify the object type of the fields to be skipped from the matcher comparison.
CustomisableMatcher<T>	ignoring(org.hamcrest.Matcher<String> fieldNamePattern) Specify the pattern of field names to ignore.
CustomisableMatcher<T>	ignoring(String fieldPath) Specify the path of the field to be skipped from the matcher comparison.
<V> CustomisableMatcher<T>	with(String fieldPath, org.hamcrest.Matcher<V> matcher) Specify the path of the field to be matched with a specific matcher.

Methods inherited from interface org.hamcrest.Matcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, describeMismatch, matches

Methods inherited from interface org.hamcrest.SelfDescribing

describeTo

Method Detail

ignoring

CustomisableMatcher<T> ignoring(String fieldPath)

Specify the path of the field to be skipped from the matcher comparison. Example:

sameBeanAs(expected).ignoring("beanField.subBeanField")

Parameters:

fieldPath - the path of the field to be skipped from the comparison.

Returns:

the instance of the matcher

ignoring

CustomisableMatcher<T> ignoring(Class<?> clazz)

Specify the object type of the fields to be skipped from the matcher comparison. Example:

sameBeanAs(expected).ignoring(Bean.class)

Parameters:

clazz - the object type to be skipped from the comparison.

Returns:

the instance of the matcher

with

<V> CustomisableMatcher<T> with(String fieldPath,
                              org.hamcrest.Matcher<V> matcher)

Specify the path of the field to be matched with a specific matcher. Example:

sameBeanAs(expected).with("beanField.subBeanField", contains("element"))

Parameters:

fieldPath - the path of the field to be matched with the provided matcher.

matcher - the Hamcrest matcher used to match the specified field.

Returns:

the instance of the matcher

ignoring

CustomisableMatcher<T> ignoring(org.hamcrest.Matcher<String> fieldNamePattern)

Specify the pattern of field names to ignore. Any bean property with a name that matches the supplied pattern will be ignored. Example:

assertThat(myBean, sameBeanAs(myResultBean).ignoring(is("mutationdate")).ignoring(containsString("version")))

Parameters:

pattern - the Hamcrest matcher used to match field names.

Returns:

the instance of the matcher