Package net.jqwik.api.arbitraries

Interface ListArbitrary<T>

All Superinterfaces:

Arbitrary<java.util.List<T>>, SizableArbitrary<java.util.List<T>>, StreamableArbitrary<T,java.util.List<T>>

@API(status=MAINTAINED,
     since="1.3.2")
public interface ListArbitrary<T>
extends StreamableArbitrary<T,java.util.List<T>>

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

Nested Class Summary

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

Arbitrary.ArbitraryFacade

Method Summary

Modifier and Type	Method	Description
<U> Arbitrary<java.util.List<U>>	flatMapEach(java.util.function.BiFunction<java.util.List<T>,T,Arbitrary<U>> flatMapper)	Flat-map over each element of the generated streamable giving access to the all elements when streaming.
<U> Arbitrary<java.util.List<U>>	mapEach(java.util.function.BiFunction<java.util.List<T>,T,U> mapper)	Map over each element of the generated streamable giving access to the all elements when streaming.
ListArbitrary<T>	ofMaxSize(int maxSize)	Set upper size boundary maxSize (included).
ListArbitrary<T>	ofMinSize(int minSize)	Set lower size boundary minSize (included).
default ListArbitrary<T>	ofSize(int size)	Fix the size to size.
ListArbitrary<T>	uniqueElements()	Add the constraint that elements of the generated list must be unique, i.e. no two elements must return true when being compared using Object.equals(Object).
ListArbitrary<T>	uniqueElements(java.util.function.Function<T,java.lang.Object> by)	Add the constraint that elements of the generated list must be unique relating to an element's "feature" being extracted using the by function.

Methods inherited from interface net.jqwik.api.Arbitrary

allValues, array, asGeneric, collect, dontShrink, edgeCases, edgeCases, edgeCases, exhaustive, exhaustive, filter, fixGenSize, flatMap, forEachValue, generator, generator, generatorWithEmbeddedEdgeCases, ignoreException, injectDuplicates, injectNull, iterator, list, map, 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 ListArbitrary<T> ofSize(int size)

Fix the size to size.

Specified by:

ofSize in interface SizableArbitrary<T>

Specified by:

ofSize in interface StreamableArbitrary<T,java.util.List<T>>

Parameters:

size - The size of the generated list

Returns:

new arbitrary instance

ofMinSize

ListArbitrary<T> ofMinSize(int minSize)

Set lower size boundary minSize (included).

Specified by:

ofMinSize in interface SizableArbitrary<T>

Specified by:

ofMinSize in interface StreamableArbitrary<T,java.util.List<T>>

Parameters:

minSize - The minimum size of the generated list

Returns:

new arbitrary instance

ofMaxSize

ListArbitrary<T> ofMaxSize(int maxSize)

Set upper size boundary maxSize (included).

Specified by:

ofMaxSize in interface SizableArbitrary<T>

Specified by:

ofMaxSize in interface StreamableArbitrary<T,java.util.List<T>>

Parameters:

maxSize - The maximum size of the generated list

Returns:

new arbitrary instance

mapEach

@API(status=MAINTAINED,
     since="1.4.0")
<U> Arbitrary<java.util.List<U>> mapEach(java.util.function.BiFunction<java.util.List<T>,T,U> mapper)

Map over each element of the generated streamable giving access to the all elements when streaming.

Type Parameters:

U - The target type of a list to generate

Parameters:

mapper - Mapper function to element type U

Returns:

arbitrary of a list of Us

flatMapEach

@API(status=MAINTAINED,
     since="1.4.0")
<U> Arbitrary<java.util.List<U>> flatMapEach(java.util.function.BiFunction<java.util.List<T>,T,Arbitrary<U>> flatMapper)

Flat-map over each element of the generated streamable giving access to the all elements when streaming.

Type Parameters:

U - The target type of a list to generate

Parameters:

flatMapper - Mapper function to arbitrary of element type U

Returns:

arbitrary of a list of Us

uniqueElements

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

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

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