Package net.jqwik.api.arbitraries

Interface IteratorArbitrary<T extends @Nullable Object>

All Superinterfaces:

Arbitrary<Iterator<T>>, SizableArbitrary<Iterator<T>>, StreamableArbitrary<T,Iterator<T>>

@API(status=MAINTAINED,
     since="1.3.2")
public interface IteratorArbitrary<T extends @Nullable Object>
extends Arbitrary<Iterator<T>>, StreamableArbitrary<T,Iterator<T>>

Fluent interface to add functionality to arbitraries that generate instances of type Iterator

Nested Class Summary

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

Arbitrary.ArbitraryFacade

Method Summary

Modifier and Type	Method	Description
IteratorArbitrary<T>	ofMaxSize(int maxSize)	Set upper size boundary maxSize (included).
IteratorArbitrary<T>	ofMinSize(int minSize)	Set lower size boundary minSize (included).
default IteratorArbitrary<T>	ofSize(int size)	Fix the size to size.
IteratorArbitrary<T>	uniqueElements()	Add the constraint that elements of the generated iterator must be unique, i.e. no two elements must return true when being compared using Object.equals(Object).
IteratorArbitrary<T>	uniqueElements(Function<? super T,?> by)	Add the constraint that elements of the generated iterator must be unique relating to an element's "feature" being extracted using the by function.
IteratorArbitrary<T>	withSizeDistribution(RandomDistribution uniform)	Set random distribution distribution of size of generated iterator.

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

Methods inherited from interface net.jqwik.api.arbitraries.StreamableArbitrary

reduce

Method Details

ofSize

default IteratorArbitrary<T> ofSize(int size)

Fix the size to size.

Specified by:

ofSize in interface SizableArbitrary<T extends @Nullable Object>

Specified by:

ofSize in interface StreamableArbitrary<T extends @Nullable Object,Iterator<T extends @Nullable Object>>

Parameters:

size - The size of the generated iterator

Returns:

new arbitrary instance

ofMinSize

IteratorArbitrary<T> ofMinSize(int minSize)

Set lower size boundary minSize (included).

Specified by:

ofMinSize in interface SizableArbitrary<T extends @Nullable Object>

Specified by:

ofMinSize in interface StreamableArbitrary<T extends @Nullable Object,Iterator<T extends @Nullable Object>>

Parameters:

minSize - The minimum size of the generated iterator

Returns:

new arbitrary instance

ofMaxSize

IteratorArbitrary<T> ofMaxSize(int maxSize)

Set upper size boundary maxSize (included).

Specified by:

ofMaxSize in interface SizableArbitrary<T extends @Nullable Object>

Specified by:

ofMaxSize in interface StreamableArbitrary<T extends @Nullable Object,Iterator<T extends @Nullable Object>>

Parameters:

maxSize - The maximum size of the generated iterator

Returns:

new arbitrary instance

withSizeDistribution

@API(status=EXPERIMENTAL,
     since="1.5.3")
IteratorArbitrary<T> withSizeDistribution(RandomDistribution uniform)

Set random distribution distribution of size of generated iterator. The distribution's center is the minimum size of the generated iterator.

Specified by:

withSizeDistribution in interface SizableArbitrary<T extends @Nullable Object>

Specified by:

withSizeDistribution in interface StreamableArbitrary<T extends @Nullable Object,Iterator<T extends @Nullable Object>>

uniqueElements

@API(status=MAINTAINED,
     since="1.4.0")
IteratorArbitrary<T> uniqueElements()

Add the constraint that elements of the generated iterator 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.

Specified by:

uniqueElements in interface StreamableArbitrary<T extends @Nullable Object,Iterator<T extends @Nullable Object>>

Returns:

new arbitrary instance

uniqueElements

@API(status=MAINTAINED,
     since="1.4.0")
IteratorArbitrary<T> uniqueElements(Function<? super T,?> by)

Add the constraint that elements of the generated iterator 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.

Specified by:

uniqueElements in interface StreamableArbitrary<T extends @Nullable Object,Iterator<T extends @Nullable Object>>

Returns:

new arbitrary instance