net.jqwik.api.arbitraries

Interface BigDecimalArbitrary

All Superinterfaces:

Arbitrary<java.math.BigDecimal>

@API(status=MAINTAINED,
     since="1.0")
public interface BigDecimalArbitrary
extends Arbitrary<java.math.BigDecimal>

Fluent interface to configure the generation of BigDecimal values.

Nested Class Summary

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

Arbitrary.ArbitraryFacade

Method Summary

Modifier and Type	Method and Description
default BigDecimalArbitrary	between(java.math.BigDecimal min, java.math.BigDecimal max) Set the allowed lower min (included) and upper max (included) bounder of generated numbers.
BigDecimalArbitrary	greaterOrEqual(java.math.BigDecimal min) Set the allowed lower min (included) bounder of generated numbers.
BigDecimalArbitrary	lessOrEqual(java.math.BigDecimal max) Set the allowed upper max (included) bounder of generated numbers.
BigDecimalArbitrary	ofScale(int scale) Set the scale (maximum number of decimal places) to scale.
BigDecimalArbitrary	shrinkTowards(java.math.BigDecimal target) Set shrinking target to target which must be between the allowed bounds.

Methods inherited from interface net.jqwik.api.Arbitrary

allValues, array, collect, exhaustive, exhaustive, filter, fixGenSize, flatMap, forEachValue, generator, injectNull, iterator, list, map, optional, sample, sampleStream, set, stream, unique, withSamples

Method Detail

between

default BigDecimalArbitrary between(java.math.BigDecimal min,
                                    java.math.BigDecimal max)

Set the allowed lower min (included) and upper max (included) bounder of generated numbers.

greaterOrEqual

BigDecimalArbitrary greaterOrEqual(java.math.BigDecimal min)

Set the allowed lower min (included) bounder of generated numbers.

lessOrEqual

BigDecimalArbitrary lessOrEqual(java.math.BigDecimal max)

Set the allowed upper max (included) bounder of generated numbers.

ofScale

BigDecimalArbitrary ofScale(int scale)

Set the scale (maximum number of decimal places) to scale.

shrinkTowards

@API(status=EXPERIMENTAL,
     since="1.1.5")
BigDecimalArbitrary shrinkTowards(java.math.BigDecimal target)

Set shrinking target to target which must be between the allowed bounds.