com.atlassian.utt.matchers

Class OptionalMatchers

java.lang.Object

com.atlassian.utt.matchers.OptionalMatchers

public class OptionalMatchers
extends Object

Provides Matcher implementations for Jdk 8 optionals.

Example:

 
 assertThat(Optional.empty(), isEmpty());
 assertThat(Optional.of(1), isPresent());
 assertThat(Optional.of(1), hasValueThatIs(1));
 assertThat(Optional.of(1), hasValueThat(greaterThan(0)));
 
 

The failure messages have the form

 
 Expected: Optional that is empty
      but: Optional was present with value <1>
 Expected: Optional that is present
      but: Optional was empty
 Expected: Optional that is present and has value that is <1>
      but: Optional was empty
 Expected: Optional that is present and has value that is <1>
      but: was present but value was <2>
 Expected: Optional that is present and has value that a value greater than <2>
      but Optional was present but value <1> was less than <2>
 
 

Constructor Summary

Constructors

Constructor and Description
OptionalMatchers()

Method Summary

Modifier and Type	Method and Description
static <T> org.hamcrest.Matcher<Optional<T>>	hasValueThat(org.hamcrest.Matcher<? super T> valueMatcher) Match a non-empty Optional whose value matches a given matcher.
static <T> org.hamcrest.Matcher<Optional<T>>	hasValueThatIs(T value) Match a non-empty Optional whose value is equal to a given value.
static <T> org.hamcrest.Matcher<Optional<T>>	isEmpty() Match an Optional exactly when it is empty.
static <T> org.hamcrest.Matcher<Optional<T>>	isPresent() Match an Optional exactly when it is present.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalMatchers

public OptionalMatchers()

Method Detail

isEmpty

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

Match an Optional exactly when it is empty.

Returns:

a Matcher which matches an Optional if and only if Optional.isPresent() is false.

isPresent

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

Match an Optional exactly when it is present.

Returns:

a Matcher which matches an Optional if and only if Optional.isPresent() is true.

hasValueThatIs

public static <T> org.hamcrest.Matcher<Optional<T>> hasValueThatIs(T value)

Match a non-empty Optional whose value is equal to a given value.

Type Parameters:

T - the type of the value in the Optional.

Parameters:

value - the expected value contained in the Optional.

Returns:

a Matcher which matches an Optional if and only if Optional.isPresent() is true and Optional.get() returns a value which is the given value.

hasValueThat

public static <T> org.hamcrest.Matcher<Optional<T>> hasValueThat(org.hamcrest.Matcher<? super T> valueMatcher)

Match a non-empty Optional whose value matches a given matcher.

Type Parameters:

T - the type of the value in the Optional.

Parameters:

valueMatcher - the matcher for the expected value contained in the Optional.

Returns:

a Matcher which matches an Optional if and only if Optional.isPresent() is true and Optional.get() returns a value which valueMatcher matches.