Package org.instancio.generator.specs

Interface BigDecimalSpec

All Superinterfaces:

AsGeneratorSpec<BigDecimal>, BigDecimalGeneratorSpec, GeneratorSpec<BigDecimal>, NullableGeneratorSpec<BigDecimal>, NumberGeneratorSpec<BigDecimal>, Supplier<BigDecimal>, ValueSpec<BigDecimal>

public interface BigDecimalSpec
extends ValueSpec<BigDecimal>, BigDecimalGeneratorSpec

Spec for generating BigDecimal values.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
BigDecimalSpec	max(BigDecimal max)	Specifies the upper bound.
BigDecimalSpec	min(BigDecimal min)	Specifies the lower bound.
BigDecimalSpec	nullable()	Specifies that a null value can be generated
BigDecimalSpec	precision(int precision)	Precision of the generated BigDecimal.
BigDecimalSpec	range(BigDecimal min, BigDecimal max)	Specifies the range for generated numbers.
BigDecimalSpec	scale(int scale)	Scale of the generated BigDecimal.

Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

Method Details

min

BigDecimalSpec min(BigDecimal min)

Specifies the lower bound.

Note that this method is incompatible with BigDecimalGeneratorSpec.precision(int). For details, see BigDecimalGeneratorSpec.precision(int) javadoc.

Note that this method is incompatible with precision(int). For details, see precision(int) javadoc.

Specified by:

min in interface BigDecimalGeneratorSpec

Specified by:

min in interface NumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

BigDecimalSpec max(BigDecimal max)

Specifies the upper bound.

Note that this method is incompatible with BigDecimalGeneratorSpec.precision(int). For details, see BigDecimalGeneratorSpec.precision(int) javadoc.

Note that this method is incompatible with precision(int). For details, see precision(int) javadoc.

Specified by:

max in interface BigDecimalGeneratorSpec

Specified by:

max in interface NumberGeneratorSpec<BigDecimal>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

BigDecimalSpec range(BigDecimal min,
 BigDecimal max)

Specifies the range for generated numbers.

The following examples use int, however the same principle applies to all numeric types, including BigInteger and BigDecimal.

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]:

   ints().range(10, 15).range(20, 25)
 

Note: this method has higher precedence than NumberGeneratorSpec.min(Number) and NumberGeneratorSpec.max(Number). For example, the following will generate a number within [1, 5]:

   ints().range(1, 5).min(95).max(99)
 

Note that this method is incompatible with BigDecimalGeneratorSpec.precision(int). For details, see BigDecimalGeneratorSpec.precision(int) javadoc.

Note that this method is incompatible with precision(int). For details, see precision(int) javadoc.

Specified by:

range in interface BigDecimalGeneratorSpec

Specified by:

range in interface NumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

BigDecimalSpec nullable()

Description copied from interface: ValueSpec

Specifies that a null value can be generated

Specified by:

nullable in interface BigDecimalGeneratorSpec

Specified by:

nullable in interface NullableGeneratorSpec<BigDecimal>

Specified by:

nullable in interface NumberGeneratorSpec<BigDecimal>

Specified by:

nullable in interface ValueSpec<BigDecimal>

Returns:

spec builder reference

scale

BigDecimalSpec scale(int scale)

Description copied from interface: BigDecimalGeneratorSpec

Scale of the generated BigDecimal. Generated values will have given scale as returned by BigDecimal.scale().

If not specified, the default scale is 2.

Specified by:

scale in interface BigDecimalGeneratorSpec

Parameters:

scale - the scale of generated BigDecimal values

Returns:

spec builder

precision

@ExperimentalApi
BigDecimalSpec precision(int precision)

Precision of the generated BigDecimal. Generated values will have given precision as returned by BigDecimal.precision().

This method is incompatible with the following methods:

• BigDecimalGeneratorSpec.min(BigDecimal)
• BigDecimalGeneratorSpec.min(BigDecimal)
• BigDecimalGeneratorSpec.range(BigDecimal, BigDecimal)

If this method is combined with any of the above, the last method takes precedence.

 // Example 1: range() takes precedence as it is specified last
 BigDecimal result = Instancio.gen().math().bigDecimal()
     .precision(5)
     .range(BigDecimal.ZERO, BigDecimal.ONE)
     .get();

 // Sample output: 0.81

 // Example 2: precision() takes precedence as it is specified last
 BigDecimal result = Instancio.gen().math().bigDecimal()
     .range(BigDecimal.ZERO, BigDecimal.ONE)
     .precision(5)
     .get();

 // Sample output: 394.19
 

Specified by:

precision in interface BigDecimalGeneratorSpec

Parameters:

precision - the precision of generated BigDecimal values

Returns:

spec builder

Since:

3.3.0