Package org.instancio.generator.specs
Interface BigDecimalSpec
- All Superinterfaces:
BigDecimalGeneratorSpec
,GeneratorSpec<BigDecimal>
,NullableGeneratorSpec<BigDecimal>
,NumberGeneratorSpec<BigDecimal>
,ValueSpec<BigDecimal>
Spec for generating
BigDecimal
values.- Since:
- 2.6.0
-
Method Summary
Modifier and TypeMethodDescriptionmax
(BigDecimal max) Specifies the upper bound.min
(BigDecimal min) Specifies the lower bound.nullable()
Specifies that anull
value can be generatedrange
(BigDecimal min, BigDecimal max) Specifies the range for the generated number.scale
(int scale) Scale of the generatedBigDecimal
.
-
Method Details
-
min
Description copied from interface:NumberGeneratorSpec
Specifies the lower bound.- Specified by:
min
in interfaceBigDecimalGeneratorSpec
- Specified by:
min
in interfaceNumberGeneratorSpec<BigDecimal>
- Parameters:
min
- lower bound (inclusive)- Returns:
- spec builder
-
max
Description copied from interface:NumberGeneratorSpec
Specifies the upper bound.- Specified by:
max
in interfaceBigDecimalGeneratorSpec
- Specified by:
max
in interfaceNumberGeneratorSpec<BigDecimal>
- Parameters:
max
- upper bound (inclusive)- Returns:
- spec builder
-
range
Description copied from interface:NumberGeneratorSpec
Specifies the range for the generated number.This method can be invoked multiple times to specify several ranges, for example, the following will generate a random value within
[10-15]
or[20-25]
:
Note: this method has higher precedence thanints().range(10, 15).range(20, 25)
NumberGeneratorSpec.min(Number)
andNumberGeneratorSpec.max(Number)
. For example, the following will generate a number within[1, 5]
:ints().range(1, 5).min(95).max(99)
- Specified by:
range
in interfaceBigDecimalGeneratorSpec
- Specified by:
range
in interfaceNumberGeneratorSpec<BigDecimal>
- Parameters:
min
- lower bound (inclusive)max
- upper bound (inclusive)- Returns:
- spec builder
-
nullable
BigDecimalSpec nullable()Description copied from interface:ValueSpec
Specifies that anull
value can be generated- Specified by:
nullable
in interfaceBigDecimalGeneratorSpec
- Specified by:
nullable
in interfaceNullableGeneratorSpec<BigDecimal>
- Specified by:
nullable
in interfaceNumberGeneratorSpec<BigDecimal>
- Specified by:
nullable
in interfaceValueSpec<BigDecimal>
- Returns:
- spec builder reference
-
scale
Description copied from interface:BigDecimalGeneratorSpec
Scale of the generatedBigDecimal
.- Specified by:
scale
in interfaceBigDecimalGeneratorSpec
- Parameters:
scale
- to set- Returns:
- spec builder
-