org.hobsoft.hamcrest.compose

Class ComposeMatchers

java.lang.Object

org.hobsoft.hamcrest.compose.ComposeMatchers

public final class ComposeMatchers
extends Object

Factory for Hamcrest Compose matchers.

Method Summary

Modifier and Type	Method and Description
static <T> ConjunctionMatcher<T>	compose(Iterable<org.hamcrest.Matcher<? super T>> matchers) Returns a matcher that logically ANDs the specified matchers with any number of further matchers.
static <T> ConjunctionMatcher<T>	compose(org.hamcrest.Matcher<? super T>... matchers) Returns a matcher that logically ANDs the specified matchers with any number of further matchers.
static <T> ConjunctionMatcher<T>	compose(String compositeDescription, Iterable<org.hamcrest.Matcher<? super T>> matchers) Returns a matcher that logically ANDs the specified matchers with any number of further matchers.
static <T> ConjunctionMatcher<T>	compose(String compositeDescription, org.hamcrest.Matcher<? super T>... matchers) Returns a matcher that logically ANDs the specified matchers with any number of further matchers.
static <T,U> org.hamcrest.Matcher<T>	hasFeature(Function<T,U> featureFunction, org.hamcrest.Matcher<? super U> featureMatcher) Returns a matcher that matches the specified feature of an object.
static <T,U> org.hamcrest.Matcher<T>	hasFeature(String featureName, Function<T,U> featureFunction, org.hamcrest.Matcher<? super U> featureMatcher) Returns a matcher that matches the specified feature of an object.
static <T,U> org.hamcrest.Matcher<T>	hasFeature(String featureDescription, String featureName, Function<T,U> featureFunction, org.hamcrest.Matcher<? super U> featureMatcher) Returns a matcher that matches the specified feature of an object.
static <T,U> org.hamcrest.Matcher<T>	hasFeatureValue(Function<T,U> featureFunction, U featureValue) Returns a matcher that matches the specified feature value of an object.
static <T,U> org.hamcrest.Matcher<T>	hasFeatureValue(String featureName, Function<T,U> featureFunction, U featureValue) Returns a matcher that matches the specified feature value of an object.
static <T,U> org.hamcrest.Matcher<T>	hasFeatureValue(String featureDescription, String featureName, Function<T,U> featureFunction, U featureValue) Returns a matcher that matches the specified feature value of an object.

Methods inherited from class java.lang.Object

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

Method Detail

compose

@SafeVarargs
public static <T> ConjunctionMatcher<T> compose(org.hamcrest.Matcher<? super T>... matchers)

Returns a matcher that logically ANDs the specified matchers with any number of further matchers.

For example:

 assertThat("ham", compose(startsWith("h")).and(containsString("a")).and(endsWith("m")));
 

See ConjunctionMatcher as to how this matcher differs from allOf and both.

Type Parameters:

T - the type of the object to be matched

Parameters:

matchers - the initial matchers to compose

Returns:

a matcher that can compose itself with further matchers

See Also:

ConjunctionMatcher

compose

@SafeVarargs
public static <T> ConjunctionMatcher<T> compose(String compositeDescription,
                                                             org.hamcrest.Matcher<? super T>... matchers)

Returns a matcher that logically ANDs the specified matchers with any number of further matchers.

For example:

 assertThat("ham", compose("a word with", startsWith("h")).and(containsString("a")).and(endsWith("m")));
 

See ConjunctionMatcher as to how this matcher differs from allOf and both.

Type Parameters:

T - the type of the object to be matched

Parameters:

compositeDescription - a description of this composite used by describeTo

matchers - the initial matchers to compose

Returns:

a matcher that can compose itself with further matchers

See Also:

ConjunctionMatcher

compose

public static <T> ConjunctionMatcher<T> compose(Iterable<org.hamcrest.Matcher<? super T>> matchers)

Returns a matcher that logically ANDs the specified matchers with any number of further matchers.

For example:

 assertThat("ham", compose(asList(startsWith("h"), containsString("a"))).and(endsWith("m")));
 

See ConjunctionMatcher as to how this matcher differs from allOf and both.

Type Parameters:

T - the type of the object to be matched

Parameters:

matchers - the initial matchers to compose

Returns:

a matcher that can compose itself with further matchers

See Also:

ConjunctionMatcher

compose

public static <T> ConjunctionMatcher<T> compose(String compositeDescription,
                                                Iterable<org.hamcrest.Matcher<? super T>> matchers)

Returns a matcher that logically ANDs the specified matchers with any number of further matchers.

For example:

 assertThat("ham", compose("a word with", asList(startsWith("h"), containsString("a"))).and(endsWith("m")));
 

See ConjunctionMatcher as to how this matcher differs from allOf and both.

Type Parameters:

T - the type of the object to be matched

Parameters:

compositeDescription - a description of this composite used by describeTo

matchers - the initial matchers to compose

Returns:

a matcher that can compose itself with further matchers

See Also:

ConjunctionMatcher

hasFeature

public static <T,U> org.hamcrest.Matcher<T> hasFeature(Function<T,U> featureFunction,
                                                       org.hamcrest.Matcher<? super U> featureMatcher)

Returns a matcher that matches the specified feature of an object.

For example:

 assertThat("ham", hasFeature(String::length, equalTo(3)));
 

Type Parameters:

T - the type of the object to be matched

U - the type of the feature to be matched

Parameters:

featureFunction - a function to extract the feature from the object. The string representation of this function is used as the feature name for describeTo and describeMismatch.

featureMatcher - the matcher to apply to the specified feature

Returns:

the feature matcher

hasFeature

public static <T,U> org.hamcrest.Matcher<T> hasFeature(String featureName,
                                                       Function<T,U> featureFunction,
                                                       org.hamcrest.Matcher<? super U> featureMatcher)

Returns a matcher that matches the specified feature of an object.

For example:

 assertThat("ham", hasFeature("string length", String::length, equalTo(3)));
 

Type Parameters:

T - the type of the object to be matched

U - the type of the feature to be matched

Parameters:

featureName - the name of this feature used by describeTo and describeMismatch

featureFunction - a function to extract the feature from the object

featureMatcher - the matcher to apply to the specified feature

Returns:

the feature matcher

hasFeature

public static <T,U> org.hamcrest.Matcher<T> hasFeature(String featureDescription,
                                                       String featureName,
                                                       Function<T,U> featureFunction,
                                                       org.hamcrest.Matcher<? super U> featureMatcher)

Returns a matcher that matches the specified feature of an object.

For example:

 assertThat("ham", hasFeature("a string with length", "string length", String::length, equalTo(3)));
 

Type Parameters:

T - the type of the object to be matched

U - the type of the feature to be matched

Parameters:

featureDescription - a description of this feature used by describeTo

featureName - the name of this feature used by describeMismatch

featureFunction - a function to extract the feature from the object

featureMatcher - the matcher to apply to the specified feature

Returns:

the feature matcher

hasFeatureValue

public static <T,U> org.hamcrest.Matcher<T> hasFeatureValue(Function<T,U> featureFunction,
                                                            U featureValue)

Returns a matcher that matches the specified feature value of an object.

For example:

 assertThat("ham", hasFeatureValue(String::length, 3));
 

This is equivalent to hasFeature(featureFunction, equalTo(featureValue)).

Type Parameters:

T - the type of the object to be matched

U - the type of the feature to be matched

Parameters:

featureFunction - a function to extract the feature from the object. The string representation of this function is used as the feature name for describeTo and describeMismatch.

featureValue - the feature value to match

Returns:

the feature matcher

hasFeatureValue

public static <T,U> org.hamcrest.Matcher<T> hasFeatureValue(String featureName,
                                                            Function<T,U> featureFunction,
                                                            U featureValue)

Returns a matcher that matches the specified feature value of an object.

For example:

 assertThat("ham", hasFeatureValue("string length", String::length, 3));
 

This is equivalent to hasFeature(featureName, featureFunction, equalTo(featureValue)).

Type Parameters:

T - the type of the object to be matched

U - the type of the feature to be matched

Parameters:

featureName - the name of this feature used by describeTo and describeMismatch

featureFunction - a function to extract the feature from the object

featureValue - the feature value to match

Returns:

the feature matcher

hasFeatureValue

public static <T,U> org.hamcrest.Matcher<T> hasFeatureValue(String featureDescription,
                                                            String featureName,
                                                            Function<T,U> featureFunction,
                                                            U featureValue)

Returns a matcher that matches the specified feature value of an object.

For example:

 assertThat("ham", hasFeatureValue("a string with length", "string length", String::length, 3));
 

This is equivalent to hasFeature(featureDescription, featureName, featureFunction, equalTo(featureValue)).

Type Parameters:

T - the type of the object to be matched

U - the type of the feature to be matched

Parameters:

featureDescription - a description of this feature used by describeTo

featureName - the name of this feature used by describeMismatch

featureFunction - a function to extract the feature from the object

featureValue - the feature value to match

Returns:

the feature matcher