Package org.instancio.generator.specs

Interface BigDecimalGeneratorSpec

All Superinterfaces:

AsGeneratorSpec<BigDecimal>, GeneratorSpec<BigDecimal>, NullableGeneratorSpec<BigDecimal>, NumberGeneratorSpec<BigDecimal>

All Known Subinterfaces:

BigDecimalSpec

public interface BigDecimalGeneratorSpec
extends NumberGeneratorSpec<BigDecimal>

Generator spec for BigDecimal.

Since:

1.5.4

Method Summary

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

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

as, asString

Method Details

min

BigDecimalGeneratorSpec min(BigDecimal min)

Specifies the lower bound.

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

Specified by:

min in interface NumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

BigDecimalGeneratorSpec max(BigDecimal max)

Specifies the upper bound.

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

Specified by:

max in interface NumberGeneratorSpec<BigDecimal>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

BigDecimalGeneratorSpec 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 precision(int). For details, see precision(int) javadoc.

Specified by:

range in interface NumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

BigDecimalGeneratorSpec nullable()

Description copied from interface: NumberGeneratorSpec

Specifies that a null can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<BigDecimal>

Specified by:

nullable in interface NumberGeneratorSpec<BigDecimal>

Returns:

spec builder

scale

BigDecimalGeneratorSpec scale(int scale)

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

If not specified, the default scale is 2.

Parameters:

scale - the scale of generated BigDecimal values

Returns:

spec builder

Since:

1.5.4

precision

@ExperimentalApi
BigDecimalGeneratorSpec 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:

• min(BigDecimal)
• min(BigDecimal)
• 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
 

Parameters:

precision - the precision of generated BigDecimal values

Returns:

spec builder

Since:

3.3.0