Functions.FunctionWrapper (documentation 1.6.2 API)

java.lang.Object
- net.jqwik.api.Functions.FunctionWrapper

Enclosing class:: Functions

public static class Functions.FunctionWrapper
extends java.lang.Object

Wraps a function to be generated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`<F,R> FunctionArbitrary<F,R>`	`returning(Arbitrary<R> resultArbitrary)`	Create an arbitrary to create instances of functions represented by this wrapper.
`<F,R> FunctionArbitrary<F,R>`	`returns(Arbitrary<R> resultArbitrary)`	Deprecated. Use returning(Arbitrary) instead.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - returns
```
@API(status=DEPRECATED,
     since="1.6.0")
public <F,R> FunctionArbitrary<F,R> returns(Arbitrary<R> resultArbitrary)
```
    Deprecated.
    Use returning(Arbitrary) instead. Will be removed in 1.7.0.
  - returning
```
@API(status=MAINTAINED,
     since="1.6.0")
public <F,R> FunctionArbitrary<F,R> returning(Arbitrary<R> resultArbitrary)
```
    Create an arbitrary to create instances of functions represented by this wrapper. The generated functions are guaranteed to return the same result given the same input values. Shrinking will consider constant functions.
    
    Type Parameters:
    
    F - The exact functional type to generate
    
    R - The return type of the functional interface
    
    Parameters:
    
    resultArbitrary - The arbitrary used to generate return values
    
    Returns:
    
    a new arbitrary instance