Combinators.Combinator2 (documentation 1.7.1 API)

Enclosing class:: Combinators

public static interface Combinators.Combinator2<T1,T2>

Combinator for two values.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`<R> Arbitrary<R>`	`as(Combinators.F2<T1,T2,@NotNull R> combinator)`	Combine two values.
`Combinators.Combinator2<T1,T2>`	`filter(Combinators.F2<T1,T2,java.lang.Boolean> filter)`	Filter two values to only let them pass if the predicate is true.
`default <R> Arbitrary<R>`	`flatAs(Combinators.F2<T1,T2,Arbitrary<@NotNull R>> flatCombinator)`	Combine two values to create a new arbitrary.

- Method Detail
  - as
```
<R> Arbitrary<R> as(Combinators.F2<T1,T2,@NotNull R> combinator)
```
    Combine two values.
    
    Type Parameters:
    
    R - return type
    
    Parameters:
    
    combinator - function
    
    Returns:
    
    arbitrary instance
  - filter
```
@API(status=EXPERIMENTAL,
     since="1.7.1")
Combinators.Combinator2<T1,T2> filter(Combinators.F2<T1,T2,java.lang.Boolean> filter)
```
    Filter two values to only let them pass if the predicate is true.
    
    Parameters:
    
    filter - function
    
    Returns:
    
    combinator instance
  - flatAs
```
default <R> Arbitrary<R> flatAs(Combinators.F2<T1,T2,Arbitrary<@NotNull R>> flatCombinator)
```
    Combine two values to create a new arbitrary.
    
    Type Parameters:
    
    R - return type of arbitrary
    
    Parameters:
    
    flatCombinator - function
    
    Returns:
    
    arbitrary instance