FunctionWithDescription (QA JGiven Commons 1.0.5-SNAPSHOT API)

java.lang.Object
- dev.aherscu.qa.jgiven.commons.utils.FunctionWithDescription<T,R>

Type Parameters:

T - the type of input

R - the type of output

All Implemented Interfaces:

DescriptionFormatter.HasDescription, Function<T,R>
```
public class FunctionWithDescription<T,R>
extends Object
implements DescriptionFormatter.HasDescription, Function<T,R>
```
Wraps a Function with a description.

Author:

Adrian Herscu

- Constructor Summary
  
  Constructors
  Constructor Description
  
  FunctionWithDescription(String description, Function<T,R> functor)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  R apply(T t)
  
  String description()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface java.util.function.Function
    andThen, compose

- Constructor Detail
  - FunctionWithDescription
```
public FunctionWithDescription(String description,
                               Function<T,R> functor)
```
    Parameters:
    
    description - the description
    
    functor - the wrapped UnaryOperator
- Method Detail
  - apply
```
public R apply(T t)
```
    Specified by:
    
    apply in interface Function<T,R>
  - description
```
public String description()
```
    Specified by:
    
    description in interface DescriptionFormatter.HasDescription
    
    Returns:
    
    the description text