com.atlassian.utt.matchers

Class NamedFunction<A,B>

java.lang.Object

com.atlassian.utt.matchers.NamedFunction<A,B>

All Implemented Interfaces:

Function<A,B>

public class NamedFunction<A,B>
extends Object
implements com.google.common.base.Function<A,B>, Function<A,B>

Decorates a Function with a descriptive name, and allows you to compose it with a Matcher.

Example:

     
     NamedFunction<Dog, Color> dogColor = namedFunction("color", new Function<Dog, Color>() {
         public Color apply(Dog input) {
             return input.getColor();
         }
     });
     

     assertThat(myDog, dogColor.is(equalTo(Color.BLACK)));
 

Since:

0.0.4

Method Summary

Modifier and Type	Method and Description
B	apply(A input) Delegates the input to the wrapped function.
String	getName() Returns the descriptive name of this function.
org.hamcrest.Matcher<A>	is(B value) Shortcut for is(equalTo(value)).
org.hamcrest.Matcher<A>	is(org.hamcrest.Matcher<? super B> matcher) Returns a Matcher that passes its target through the wrapped function and then delegates to another matcher.
static <A,B> NamedFunction<A,B>	namedFunction(String name, Function<A,B> function)
static <A,B> NamedFunction<A,B>	namedFunction(String name, com.google.common.base.Function<A,B> function)
Function<B,org.hamcrest.Matcher<? super A>>	valueToEqualMatcher() Provides a function that produces an is(equalTo(value)) matcher derived from the wrapped function, for any given value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

namedFunction

public static <A,B> NamedFunction<A,B> namedFunction(String name,
                                                     Function<A,B> function)

namedFunction

public static <A,B> NamedFunction<A,B> namedFunction(String name,
                                                     com.google.common.base.Function<A,B> function)

apply

public B apply(A input)

Delegates the input to the wrapped function.

Specified by:

apply in interface Function<A,B>

getName

public String getName()

Returns the descriptive name of this function.

is

public org.hamcrest.Matcher<A> is(org.hamcrest.Matcher<? super B> matcher)

Returns a Matcher that passes its target through the wrapped function and then delegates to another matcher. The name of this function will be used as the description.

is

public org.hamcrest.Matcher<A> is(B value)

Shortcut for is(equalTo(value)).

valueToEqualMatcher

public Function<B,org.hamcrest.Matcher<? super A>> valueToEqualMatcher()

Provides a function that produces an is(equalTo(value)) matcher derived from the wrapped function, for any given value. If you have a list of Ts and a NamedFunction<T, U> F}, you can use transform(list, F.valueToEqualMatcher()) to produce { F.is(value1), F.is(value2), ... }.