io.bitzl.hamcrest.extra.matcher

Class HasPropertyPath<T>

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeDiagnosingMatcher<T>

io.bitzl.hamcrest.extra.matcher.HasPropertyPath<T>

Type Parameters:

T - A generic type to fit in the static typing with other matchers.

All Implemented Interfaces:

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

public class HasPropertyPath<T>
extends org.hamcrest.TypeSafeDiagnosingMatcher<T>

A matcher to match nested properties transitively.

Method Summary

Modifier and Type	Method and Description
void	describeTo(org.hamcrest.Description description) Describes the matcher.
static <T> org.hamcrest.Matcher<T>	hasPropertyPath(String propertyPath) Matches if the specified path to a property exist.
static <T> org.hamcrest.Matcher<T>	hasPropertyPath(String propertyPath, org.hamcrest.Matcher<?> valueMatcher) Matches if the specified path to a property exists and the value of the last path element is matched by valueMatcher.
protected boolean	matchesSafely(T t, org.hamcrest.Description description)

Methods inherited from class org.hamcrest.TypeSafeDiagnosingMatcher

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

Method Detail

hasPropertyPath

public static <T> org.hamcrest.Matcher<T> hasPropertyPath(String propertyPath)

Matches if the specified path to a property exist. The matcher hasPropertyPath("a.b.c") matches on object, if object has a property a which has a property b which then has a property c. It does not matter if property c has a value or not.

Type Parameters:

T - A generic type to fit in the static typing with other matchers.

Parameters:

propertyPath - The path to the desired property.

Returns:

A matcher for the desired property path.

hasPropertyPath

public static <T> org.hamcrest.Matcher<T> hasPropertyPath(String propertyPath,
                                                          org.hamcrest.Matcher<?> valueMatcher)

Matches if the specified path to a property exists and the value of the last path element is matched by valueMatcher. Example: The matcher hasPropertyPath("owner.pet.name", is("Pete") matches on object, if object has a property owner which has a property pet which then has a property name and name has the value "Pete".

Type Parameters:

T - A generic type to fit in the static typing with other matchers.

Parameters:

propertyPath - The path to the desired property.

valueMatcher - A matcher for the last element in the property path.

Returns:

A matcher for the desired property path.

matchesSafely

protected boolean matchesSafely(T t,
                                org.hamcrest.Description description)

Specified by:

matchesSafely in class org.hamcrest.TypeSafeDiagnosingMatcher<T>

describeTo

public void describeTo(org.hamcrest.Description description)

Describes the matcher.

Parameters:

description - The description object to append the matchers description.