StepWithDescription (QA JGiven Commons 1.0.5-SNAPSHOT API)

java.lang.Object
- dev.aherscu.qa.jgiven.commons.utils.StepWithDescription<SELF>

Type Parameters:

SELF - the type of step

All Implemented Interfaces:

DescriptionFormatter.HasDescription, Function<SELF,SELF>
```
public class StepWithDescription<SELF>
extends Object
implements DescriptionFormatter.HasDescription, Function<SELF,SELF>
```
Wraps a Function with a description.

Author:

Adrian Herscu

Constructor Summary

Constructors
Constructor	Description
`StepWithDescription(String description, Function<SELF,SELF> function)`
`StepWithDescription(Function<SELF,SELF> function)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

SELF apply(SELF self)

String description()

String toString()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
- Methods inherited from interface java.util.function.Function
  andThen, compose

- Constructor Detail
  - StepWithDescription
```
public StepWithDescription(String description,
                           Function<SELF,SELF> function)
```
    Parameters:
    
    description - the description
    
    function - the wrapped Function
  - StepWithDescription
```
public StepWithDescription(Function<SELF,SELF> function)
```
- Method Detail
  - apply
```
public SELF apply(SELF self)
```
    Specified by:
    
    apply in interface Function<SELF,SELF>
  - description
```
public String description()
```
    Specified by:
    
    description in interface DescriptionFormatter.HasDescription
    
    Returns:
    
    the description text
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object