Package net.jqwik.api.arbitraries

Interface ArrayArbitrary<T,A>

All Superinterfaces:

Arbitrary<A>, SizableArbitrary<A>, StreamableArbitrary<T,A>

@API(status=MAINTAINED,
     since="1.4.0")
public interface ArrayArbitrary<T,A>
extends StreamableArbitrary<T,A>

Fluent interface to add functionality to arbitraries that generate instances of Arrays

Nested Class Summary

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

Arbitrary.ArbitraryFacade

Method Summary

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

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, injectDuplicates, injectNull, 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 Detail

ofSize

default ArrayArbitrary<T,A> ofSize(int size)

Fix the size to size.

Specified by:

ofSize in interface SizableArbitrary<T>

Specified by:

ofSize in interface StreamableArbitrary<T,A>

Parameters:

size - The size of the generated set

Returns:

new arbitrary instance

ofMinSize

ArrayArbitrary<T,A> ofMinSize(int minSize)

Set lower size boundary minSize (included).

Specified by:

ofMinSize in interface SizableArbitrary<T>

Specified by:

ofMinSize in interface StreamableArbitrary<T,A>

Parameters:

minSize - The minimum size of the generated set

Returns:

new arbitrary instance

ofMaxSize

ArrayArbitrary<T,A> ofMaxSize(int maxSize)

Set upper size boundary maxSize (included).

Specified by:

ofMaxSize in interface SizableArbitrary<T>

Specified by:

ofMaxSize in interface StreamableArbitrary<T,A>

Parameters:

maxSize - The maximum size of the generated set

Returns:

new arbitrary instance

withSizeDistribution

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

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

Specified by:

withSizeDistribution in interface SizableArbitrary<T>

Specified by:

withSizeDistribution in interface StreamableArbitrary<T,A>

uniqueElements

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

Add the constraint that elements of the generated array 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.4.0")
ArrayArbitrary<T,A> uniqueElements(java.util.function.Function<T,java.lang.Object> by)

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