Package net.jqwik.api.arbitraries
Interface StreamArbitrary<T>
-
- All Superinterfaces:
Arbitrary<java.util.stream.Stream<T>>
,SizableArbitrary<java.util.stream.Stream<T>>
,StreamableArbitrary<T,java.util.stream.Stream<T>>
@API(status=MAINTAINED, since="1.3.2") public interface StreamArbitrary<T> extends Arbitrary<java.util.stream.Stream<T>>, StreamableArbitrary<T,java.util.stream.Stream<T>>
Fluent interface to add functionality to arbitraries that generate instances of type Stream
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.jqwik.api.Arbitrary
Arbitrary.ArbitraryFacade
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description StreamArbitrary<T>
ofMaxSize(int maxSize)
Set upper size boundarymaxSize
(included).StreamArbitrary<T>
ofMinSize(int minSize)
Set lower size boundaryminSize
(included).default StreamArbitrary<T>
ofSize(int size)
Fix the size tosize
.StreamArbitrary<T>
uniqueElements()
Add the constraint that elements of the generated stream must be unique, i.e. no two elements must return true when being compared using Object.equals(Object).StreamArbitrary<T>
uniqueElements(java.util.function.Function<T,java.lang.Object> by)
Add the constraint that elements of the generated stream must be unique relating to an element's "feature" being extracted using theby
function.StreamArbitrary<T>
withSizeDistribution(RandomDistribution uniform)
Set random distributiondistribution
of size of generated stream.-
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 StreamArbitrary<T> ofSize(int size)
Fix the size tosize
.- Specified by:
ofSize
in interfaceSizableArbitrary<T>
- Specified by:
ofSize
in interfaceStreamableArbitrary<T,java.util.stream.Stream<T>>
- Parameters:
size
- The size of the generated stream- Returns:
- new arbitrary instance
-
ofMinSize
StreamArbitrary<T> ofMinSize(int minSize)
Set lower size boundaryminSize
(included).- Specified by:
ofMinSize
in interfaceSizableArbitrary<T>
- Specified by:
ofMinSize
in interfaceStreamableArbitrary<T,java.util.stream.Stream<T>>
- Parameters:
minSize
- The minimum size of the generated stream- Returns:
- new arbitrary instance
-
ofMaxSize
StreamArbitrary<T> ofMaxSize(int maxSize)
Set upper size boundarymaxSize
(included).- Specified by:
ofMaxSize
in interfaceSizableArbitrary<T>
- Specified by:
ofMaxSize
in interfaceStreamableArbitrary<T,java.util.stream.Stream<T>>
- Parameters:
maxSize
- The maximum size of the generated stream- Returns:
- new arbitrary instance
-
withSizeDistribution
@API(status=EXPERIMENTAL, since="1.5.3") StreamArbitrary<T> withSizeDistribution(RandomDistribution uniform)
Set random distributiondistribution
of size of generated stream. The distribution's center is the minimum size of the generated stream.- Specified by:
withSizeDistribution
in interfaceSizableArbitrary<T>
- Specified by:
withSizeDistribution
in interfaceStreamableArbitrary<T,java.util.stream.Stream<T>>
-
uniqueElements
@API(status=MAINTAINED, since="1.4.0") StreamArbitrary<T> uniqueElements()
Add the constraint that elements of the generated stream 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") StreamArbitrary<T> uniqueElements(java.util.function.Function<T,java.lang.Object> by)
Add the constraint that elements of the generated stream must be unique relating to an element's "feature" being extracted using theby
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
-
-