org.helenus.hamcrest

Class Matchers

java.lang.Object

org.helenus.hamcrest.Matchers

public class Matchers
extends Object

The Matchers class provides a factory for matchers.

Since:

1.0

Version:

1 - Jul 2, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Constructor Summary

Constructors

Constructor and Description
Matchers()

Method Summary

Modifier and Type	Method and Description
static <T,S> org.hamcrest.Matcher<T>	closeTo(java.util.function.Function<T,S> function, String describer, T operand, double epsilon) Applies a function to the matched object and the provided one in order to retrieve values to check if they are the same with a tolerable error as determined by calling the Objects.deepEquals(java.lang.Object, java.lang.Object, double) method.
static <T,S> org.hamcrest.Matcher<T>	equalTo(java.util.function.Function<T,S> function, String describer, T operand) Applies a function to the matched object and the provided one in order to retrieve values to check if they are the same as determined by calling the Objects.deepEquals(java.lang.Object, java.lang.Object) method.
static <T,S> org.hamcrest.Matcher<T>	fieldEqualTo(String field, org.hamcrest.Matcher<S> matcher) Retrieves a field from the matched object and starts matching this new object with the specified matcher.
static <E> org.hamcrest.Matcher<Optional<E>>	hasValue(E value) Creates a matcher for Optionals matching examined optionals whose value is equal to the provided one.
static <E> org.hamcrest.Matcher<Optional<E>>	hasValue(org.hamcrest.Matcher<? super E> matcher) Creates a matcher for Optionals matching examined optionals whose value matches the provided matcher.
static <E> org.hamcrest.Matcher<Optional<E>>	isEmpty() Creates a matcher for Optionals matching examined optionals whose value is not present.
static <E> org.hamcrest.Matcher<Optional<E>>	isPresent() Creates a matcher for Optionals matching examined optionals whose value is present.
static <T,S> org.hamcrest.Matcher<T>	that(java.util.function.Function<T,S> function, String describer, org.hamcrest.Matcher<S> matcher) Applies a function to the matched object in order to retrieve another and starts matching this new object with the specified matcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

Matchers

public Matchers()

Method Detail

that

public static <T,S> org.hamcrest.Matcher<T> that(java.util.function.Function<T,S> function,
                                                 String describer,
                                                 org.hamcrest.Matcher<S> matcher)

Applies a function to the matched object in order to retrieve another and starts matching this new object with the specified matcher.

Parameters:

function - the function to apply to the object currently being matched in order to retrieve another

describer - a describer string for the function

matcher - the matcher to use for the retrieved object from the function

Returns:

the corresponding matcher

equalTo

public static <T,S> org.hamcrest.Matcher<T> equalTo(java.util.function.Function<T,S> function,
                                                    String describer,
                                                    T operand)

Applies a function to the matched object and the provided one in order to retrieve values to check if they are the same as determined by calling the Objects.deepEquals(java.lang.Object, java.lang.Object) method.

Parameters:

function - the function to apply to the object currently being matched and to the specified operand in order to retrieve values to be compared

describer - a describer string for the function

operand - the object to retrieve a value using the specified function to compare with

Returns:

the corresponding matcher

closeTo

public static <T,S> org.hamcrest.Matcher<T> closeTo(java.util.function.Function<T,S> function,
                                                    String describer,
                                                    T operand,
                                                    double epsilon)

Applies a function to the matched object and the provided one in order to retrieve values to check if they are the same with a tolerable error as determined by calling the Objects.deepEquals(java.lang.Object, java.lang.Object, double) method.

Parameters:

function - the function to apply to the object currently being matched and to the specified operand in order to retrieve values to be compared

describer - a describer string for the function

operand - the object to retrieve a value using the specified function to compare with

epsilon - the tolerable error

Returns:

the corresponding matcher

fieldEqualTo

public static <T,S> org.hamcrest.Matcher<T> fieldEqualTo(String field,
                                                         org.hamcrest.Matcher<S> matcher)

Retrieves a field from the matched object and starts matching this new object with the specified matcher.

Parameters:

field - the name of the field to retrieve from the object currently being matched

matcher - the matcher to use for the retrieved object from the field

Returns:

the corresponding matcher

isPresent

public static <E> org.hamcrest.Matcher<Optional<E>> isPresent()

Creates a matcher for Optionals matching examined optionals whose value is present.

Type Parameters:

E - the type of the value

Returns:

a corresponding matcher

isEmpty

public static <E> org.hamcrest.Matcher<Optional<E>> isEmpty()

Creates a matcher for Optionals matching examined optionals whose value is not present.

Type Parameters:

E - the type of the value

Returns:

a corresponding matcher

hasValue

public static <E> org.hamcrest.Matcher<Optional<E>> hasValue(E value)

Creates a matcher for Optionals matching examined optionals whose value is equal to the provided one.

Type Parameters:

E - the type of the value

Parameters:

value - the object to compare the optional's value with

Returns:

a corresponding matcher

hasValue

public static <E> org.hamcrest.Matcher<Optional<E>> hasValue(org.hamcrest.Matcher<? super E> matcher)

Creates a matcher for Optionals matching examined optionals whose value matches the provided matcher.

Type Parameters:

E - the type of the value

Parameters:

matcher - a matcher for the optional's value to match against

Returns:

a corresponding matcher