Package net.jqwik.api.arbitraries

Interface StreamableArbitrary<T extends @Nullable Object,U>

All Superinterfaces:

Arbitrary<U>, SizableArbitrary<U>

All Known Subinterfaces:

ArrayArbitrary<T,A>, IteratorArbitrary<T>, ListArbitrary<T>, SetArbitrary<T>, StreamArbitrary<T>

@API(status=MAINTAINED,
     since="1.2.1")
public interface StreamableArbitrary<T extends @Nullable Object,U>
extends SizableArbitrary<U>

Fluent interface to add functionality to arbitraries whose generation artefacts can be streamed, e.g. List, Set, Stream and Arrays

Nested Class Summary

Nested classes/interfaces inherited from interface net.jqwik.api.Arbitrary

Arbitrary.ArbitraryFacade

Method Summary

Modifier and Type	Method	Description
StreamableArbitrary<T,U>	ofMaxSize(int maxSize)	Set upper size boundary maxSize (included).
StreamableArbitrary<T,U>	ofMinSize(int minSize)	Set lower size boundary minSize (included).
default StreamableArbitrary<T,U>	ofSize(int size)	Fix the size to size.
<R extends @Nullable Object> Arbitrary<R>	reduce(R initial, BiFunction<R,? super T,R> accumulator)	Given an initial argument use accumulator to produce the final result.
StreamableArbitrary<T,U>	uniqueElements()	Add the constraint that elements of the generated streamable must be unique, i.e. no two elements must return true when being compared using Object.equals(Object).
StreamableArbitrary<T,U>	uniqueElements(Function<? super T,?> by)	Add the constraint that elements of the generated streamable must be unique relating to an element's "feature" being extracted using the by function.
StreamableArbitrary<T,U>	withSizeDistribution(RandomDistribution distribution)	Set distribution distribution of size of generated arbitrary

Methods inherited from interface net.jqwik.api.Arbitrary

allValues, array, asGeneric, collect, dontShrink, edgeCases, edgeCases, edgeCases, exhaustive, exhaustive, filter, filter, fixGenSize, flatMap, forEachValue, generator, generator, generatorWithEmbeddedEdgeCases, ignoreException, ignoreException, ignoreExceptions, ignoreExceptions, injectDuplicates, injectNull, isGeneratorMemoizable, iterator, list, map, optional, optional, sample, sampleStream, set, stream, tuple1, tuple2, tuple3, tuple4, tuple5, withoutEdgeCases

Method Details

reduce

<R extends @Nullable Object> Arbitrary<R> reduce(R initial,
 BiFunction<R,? super T,R> accumulator)

Given an initial argument use accumulator to produce the final result.

Type Parameters:

R - The result type

Parameters:

initial - The initial argument. Also the result if streamable is empty

accumulator - The function used to reduce a streamable into a result one by one

Returns:

The result of accumulating all elements in streamable

ofSize

default StreamableArbitrary<T,U> ofSize(int size)

Fix the size to size.

Specified by:

ofSize in interface SizableArbitrary<T extends @Nullable Object>

ofMinSize

StreamableArbitrary<T,U> ofMinSize(int minSize)

Set lower size boundary minSize (included).

Specified by:

ofMinSize in interface SizableArbitrary<T extends @Nullable Object>

ofMaxSize

StreamableArbitrary<T,U> ofMaxSize(int maxSize)

Set upper size boundary maxSize (included).

Specified by:

ofMaxSize in interface SizableArbitrary<T extends @Nullable Object>

withSizeDistribution

@API(status=EXPERIMENTAL,
     since="1.5.3")
StreamableArbitrary<T,U> withSizeDistribution(RandomDistribution distribution)

Set distribution distribution of size of generated arbitrary

Specified by:

withSizeDistribution in interface SizableArbitrary<T extends @Nullable Object>

uniqueElements

@API(status=MAINTAINED,
     since="1.7.3")
StreamableArbitrary<T,U> uniqueElements()

Add the constraint that elements of the generated streamable must be unique, i.e. no two elements must return true when being compared using Object.equals(Object).

The constraint can be combined with other uniqueElements(Function) constraints.

Returns:

new arbitrary instance

uniqueElements

@API(status=MAINTAINED,
     since="1.7.3")
StreamableArbitrary<T,U> uniqueElements(Function<? super T,?> by)

Add the constraint that elements of the generated streamable must be unique relating to an element's "feature" being extracted using the by function. The extracted features are being compared using Object.equals(Object).

The constraint can be combined with other uniqueElements(Function) constraints.

Returns:

new arbitrary instance