Package net.jqwik.api.arbitraries
Interface BigDecimalArbitrary
- All Superinterfaces:
Arbitrary<BigDecimal>
,NumericalArbitrary<BigDecimal,
BigDecimalArbitrary>
@API(status=MAINTAINED,
since="1.0")
public interface BigDecimalArbitrary
extends NumericalArbitrary<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 TypeMethodDescriptionbetween
(BigDecimal min, boolean minIncluded, BigDecimal max, boolean maxIncluded) Set the allowed lowermin
(included) and uppermax
(included) border of generated numbers.default BigDecimalArbitrary
between
(BigDecimal min, BigDecimal max) Set the allowed lowermin
(included) and uppermax
(included) border of generated numbers.greaterOrEqual
(BigDecimal min) Set the allowed lowermin
(included) border of generated numbers.greaterThan
(BigDecimal min) Set the allowed lowermin
(excluded) border of generated numbers.lessOrEqual
(BigDecimal max) Set the allowed uppermax
(included) bounder of generated numbers.lessThan
(BigDecimal max) Set the allowed uppermax
(excluded) border of generated numbers.ofScale
(int scale) Set the scale (maximum number of decimal places) toscale
.shrinkTowards
(BigDecimal target) Set shrinking target totarget
which must be between the allowed bounds.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, ignoreException, ignoreExceptions, ignoreExceptions, injectDuplicates, injectNull, isGeneratorMemoizable, iterator, list, map, optional, optional, sample, sampleStream, set, stream, tuple1, tuple2, tuple3, tuple4, tuple5, withoutEdgeCases
Methods inherited from interface net.jqwik.api.arbitraries.NumericalArbitrary
withDistribution
-
Method Details
-
between
Set the allowed lowermin
(included) and uppermax
(included) border of generated numbers.- Parameters:
min
- The lower border of possible valuesmax
- The upper border of possible values- Returns:
- new instance of arbitrary
-
between
@API(status=MAINTAINED, since="1.2.7") BigDecimalArbitrary between(BigDecimal min, boolean minIncluded, BigDecimal max, boolean maxIncluded) Set the allowed lowermin
(included) and uppermax
(included) border of generated numbers. Specify if borders should be included in allowed values or not.- Parameters:
min
- The lower border of possible valuesminIncluded
- Should the lower border be includedmax
- The upper border of possible valuesmaxIncluded
- Should the upper border be included- Returns:
- new instance of arbitrary
-
greaterOrEqual
Set the allowed lowermin
(included) border of generated numbers.- Parameters:
min
- The lower border of possible values- Returns:
- new instance of arbitrary
-
greaterThan
Set the allowed lowermin
(excluded) border of generated numbers.- Parameters:
min
- The lower border of possible values- Returns:
- new instance of arbitrary
-
lessOrEqual
Set the allowed uppermax
(included) bounder of generated numbers.- Parameters:
max
- The upper border of possible values- Returns:
- new instance of arbitrary
-
lessThan
Set the allowed uppermax
(excluded) border of generated numbers.- Parameters:
max
- The upper border of possible values- Returns:
- new instance of arbitrary
-
ofScale
Set the scale (maximum number of decimal places) toscale
.- Parameters:
scale
- number of decimal places- Returns:
- new instance of arbitrary
-
shrinkTowards
Set shrinking target totarget
which must be between the allowed bounds.- Parameters:
target
- The value which is considered to be the most simple value for shrinking- Returns:
- new instance of arbitrary
-