Combinators (documentation 1.1.1 API)

java.lang.Object
- net.jqwik.api.Combinators

@API(status=MAINTAINED,
     since="1.0")
public class Combinators
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Combinators.BuilderCombinator<B>`
`static class`	`Combinators.CombinableBuilder<B,T>`
`static class`	`Combinators.Combinator2<T1,T2>`
`static class`	`Combinators.Combinator3<T1,T2,T3>`
`static class`	`Combinators.Combinator4<T1,T2,T3,T4>`
`static class`	`Combinators.Combinator5<T1,T2,T3,T4,T5>`
`static class`	`Combinators.Combinator6<T1,T2,T3,T4,T5,T6>`
`static class`	`Combinators.Combinator7<T1,T2,T3,T4,T5,T6,T7>`
`static class`	`Combinators.Combinator8<T1,T2,T3,T4,T5,T6,T7,T8>`
`static class`	`Combinators.CombinatorsFacade`
`static interface`	`Combinators.F2<T1,T2,R>`
`static interface`	`Combinators.F3<T1,T2,T3,R>`
`static interface`	`Combinators.F4<T1,T2,T3,T4,R>`
`static interface`	`Combinators.F5<T1,T2,T3,T4,T5,R>`
`static interface`	`Combinators.F6<T1,T2,T3,T4,T5,T6,R>`
`static interface`	`Combinators.F7<T1,T2,T3,T4,T5,T6,T7,R>`
`static interface`	`Combinators.F8<T1,T2,T3,T4,T5,T6,T7,T8,R>`
`static class`	`Combinators.ListCombinator<T>`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T1,T2> Combinators.Combinator2<T1,T2>`	`combine(Arbitrary<T1> a1, Arbitrary<T2> a2)` Combine 2 arbitraries into one.
`static <T1,T2,T3> Combinators.Combinator3<T1,T2,T3>`	`combine(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3)` Combine 3 arbitraries into one.
`static <T1,T2,T3,T4> Combinators.Combinator4<T1,T2,T3,T4>`	`combine(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4)` Combine 4 arbitraries into one.
`static <T1,T2,T3,T4,T5> Combinators.Combinator5<T1,T2,T3,T4,T5>`	`combine(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5)` Combine 5 arbitraries into one.
`static <T1,T2,T3,T4,T5,T6> Combinators.Combinator6<T1,T2,T3,T4,T5,T6>`	`combine(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6)` Combine 6 arbitraries into one.
`static <T1,T2,T3,T4,T5,T6,T7> Combinators.Combinator7<T1,T2,T3,T4,T5,T6,T7>`	`combine(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6, Arbitrary<T7> a7)` Combine 7 arbitraries into one.
`static <T1,T2,T3,T4,T5,T6,T7,T8> Combinators.Combinator8<T1,T2,T3,T4,T5,T6,T7,T8>`	`combine(Arbitrary<T1> a1, Arbitrary<T2> a2, Arbitrary<T3> a3, Arbitrary<T4> a4, Arbitrary<T5> a5, Arbitrary<T6> a6, Arbitrary<T7> a7, Arbitrary<T8> a8)` Combine 8 arbitraries into one.
`static <T> Combinators.ListCombinator<T>`	`combine(java.util.List<Arbitrary<T>> listOfArbitraries)` Combine a list of arbitraries into one.
`static <B> Combinators.BuilderCombinator<B>`	`withBuilder(Arbitrary<B> builderArbitrary)` Combine Arbitraries by means of a builder.
`static <B> Combinators.BuilderCombinator<B>`	`withBuilder(java.util.function.Supplier<B> builderSupplier)` Combine Arbitraries by means of a builder.

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

Method Detail

combine

public static <T1,T2> Combinators.Combinator2<T1,T2> combine(Arbitrary<T1> a1,
                                                             Arbitrary<T2> a2)

Combine 2 arbitraries into one.

Returns:: Combinator2 instance which can be evaluated using Combinators.Combinator2.as(net.jqwik.api.Combinators.F2<T1, T2, R>)

combine

public static <T1,T2,T3> Combinators.Combinator3<T1,T2,T3> combine(Arbitrary<T1> a1,
                                                                   Arbitrary<T2> a2,
                                                                   Arbitrary<T3> a3)

Combine 3 arbitraries into one.

Returns:: Combinator3 instance which can be evaluated using Combinators.Combinator3.as(net.jqwik.api.Combinators.F3<T1, T2, T3, R>)

combine

public static <T1,T2,T3,T4> Combinators.Combinator4<T1,T2,T3,T4> combine(Arbitrary<T1> a1,
                                                                         Arbitrary<T2> a2,
                                                                         Arbitrary<T3> a3,
                                                                         Arbitrary<T4> a4)

Combine 4 arbitraries into one.

Returns:: Combinator4 instance which can be evaluated using Combinators.Combinator4.as(net.jqwik.api.Combinators.F4<T1, T2, T3, T4, R>)

combine

public static <T1,T2,T3,T4,T5> Combinators.Combinator5<T1,T2,T3,T4,T5> combine(Arbitrary<T1> a1,
                                                                               Arbitrary<T2> a2,
                                                                               Arbitrary<T3> a3,
                                                                               Arbitrary<T4> a4,
                                                                               Arbitrary<T5> a5)

Combine 5 arbitraries into one.

Returns:: Combinator5 instance which can be evaluated using Combinators.Combinator5.as(net.jqwik.api.Combinators.F5<T1, T2, T3, T4, T5, R>)

combine

public static <T1,T2,T3,T4,T5,T6> Combinators.Combinator6<T1,T2,T3,T4,T5,T6> combine(Arbitrary<T1> a1,
                                                                                     Arbitrary<T2> a2,
                                                                                     Arbitrary<T3> a3,
                                                                                     Arbitrary<T4> a4,
                                                                                     Arbitrary<T5> a5,
                                                                                     Arbitrary<T6> a6)

Combine 6 arbitraries into one.

Returns:: Combinator6 instance which can be evaluated using Combinators.Combinator6.as(net.jqwik.api.Combinators.F6<T1, T2, T3, T4, T5, T6, R>)

combine

public static <T1,T2,T3,T4,T5,T6,T7> Combinators.Combinator7<T1,T2,T3,T4,T5,T6,T7> combine(Arbitrary<T1> a1,
                                                                                           Arbitrary<T2> a2,
                                                                                           Arbitrary<T3> a3,
                                                                                           Arbitrary<T4> a4,
                                                                                           Arbitrary<T5> a5,
                                                                                           Arbitrary<T6> a6,
                                                                                           Arbitrary<T7> a7)

Combine 7 arbitraries into one.

Returns:: Combinator7 instance which can be evaluated using Combinators.Combinator7.as(net.jqwik.api.Combinators.F7<T1, T2, T3, T4, T5, T6, T7, R>)

combine

public static <T1,T2,T3,T4,T5,T6,T7,T8> Combinators.Combinator8<T1,T2,T3,T4,T5,T6,T7,T8> combine(Arbitrary<T1> a1,
                                                                                                 Arbitrary<T2> a2,
                                                                                                 Arbitrary<T3> a3,
                                                                                                 Arbitrary<T4> a4,
                                                                                                 Arbitrary<T5> a5,
                                                                                                 Arbitrary<T6> a6,
                                                                                                 Arbitrary<T7> a7,
                                                                                                 Arbitrary<T8> a8)

Combine 8 arbitraries into one.

Returns:: Combinator8 instance which can be evaluated using Combinators.Combinator8.as(net.jqwik.api.Combinators.F8<T1, T2, T3, T4, T5, T6, T7, T8, R>)

combine
```
public static <T> Combinators.ListCombinator<T> combine(java.util.List<Arbitrary<T>> listOfArbitraries)
```
Combine a list of arbitraries into one.

Returns:

ListCombinator instance which can be evaluated using Combinators.ListCombinator.as(java.util.function.Function<java.util.List<T>, R>)

withBuilder
```
@API(status=EXPERIMENTAL,
 since="1.1.1")
public static  Combinators.BuilderCombinator withBuilder(java.util.function.Supplier builderSupplier)
```
Combine Arbitraries by means of a builder.

Parameters:

builderSupplier - The supplier will be called freshly for each value generation. For exhaustive generation all supplied objects are supposed to be identical.

Returns:

BuilderCombinator instance

withBuilder
```
@API(status=EXPERIMENTAL,
 since="1.1.1")
public static  Combinators.BuilderCombinator withBuilder(Arbitrary builderArbitrary)
```
Combine Arbitraries by means of a builder.

Parameters:

builderArbitrary - The arbitrary is used to generate a builder object as starting point for building on each value generation.

Returns:

BuilderCombinator instance

Class Combinators

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

combine

combine

combine

combine

combine

combine

combine

combine

withBuilder

withBuilder