net.jqwik.api.arbitraries

Interface BigDecimalArbitrary

All Superinterfaces:

Arbitrary<java.math.BigDecimal>, NumericalArbitrary<java.math.BigDecimal,BigDecimalArbitrary>

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

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) border of generated numbers.
BigDecimalArbitrary	between(java.math.BigDecimal min, boolean minIncluded, java.math.BigDecimal max, boolean maxIncluded) Set the allowed lower min (included) and upper max (included) border of generated numbers.
BigDecimalArbitrary	greaterOrEqual(java.math.BigDecimal min) Set the allowed lower min (included) border of generated numbers.
BigDecimalArbitrary	greaterThan(java.math.BigDecimal min) Set the allowed lower min (excluded) border of generated numbers.
BigDecimalArbitrary	lessOrEqual(java.math.BigDecimal max) Set the allowed upper max (included) bounder of generated numbers.
BigDecimalArbitrary	lessThan(java.math.BigDecimal max) Set the allowed upper max (excluded) border 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.arbitraries.NumericalArbitrary

withDistribution

Methods inherited from interface net.jqwik.api.Arbitrary

allValues, array, asGeneric, collect, edgeCases, exhaustive, exhaustive, filter, fixGenSize, flatMap, forEachValue, generator, ignoreException, injectDuplicates, injectNull, isUnique, iterator, list, map, optional, sample, sampleStream, set, stream, tuple1, tuple2, tuple3, tuple4, unique

Method Detail

between

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

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

Parameters:

min - The lower border of possible values

max - The upper border of possible values

between

@API(status=MAINTAINED,
     since="1.2.7")
BigDecimalArbitrary between(java.math.BigDecimal min,
                                                                        boolean minIncluded,
                                                                        java.math.BigDecimal max,
                                                                        boolean maxIncluded)

Set the allowed lower min (included) and upper max (included) border of generated numbers. Specify if borders should be included in allowed values or not.

Parameters:

min - The lower border of possible values

minIncluded - Should the lower border be included

max - The upper border of possible values

maxIncluded - Should the upper border be included

greaterOrEqual

BigDecimalArbitrary greaterOrEqual(java.math.BigDecimal min)

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

Parameters:

min - The lower border of possible values

greaterThan

@API(status=MAINTAINED,
     since="1.2.7")
BigDecimalArbitrary greaterThan(java.math.BigDecimal min)

Set the allowed lower min (excluded) border of generated numbers.

Parameters:

min - The lower border of possible values

lessOrEqual

BigDecimalArbitrary lessOrEqual(java.math.BigDecimal max)

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

Parameters:

max - The upper border of possible values

lessThan

@API(status=MAINTAINED,
     since="1.2.7")
BigDecimalArbitrary lessThan(java.math.BigDecimal max)

Set the allowed upper max (excluded) border of generated numbers.

Parameters:

max - The upper border of possible values

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.

Parameters:

target - The value which is considered to be the most simple value for shrinking