Package org.instancio.generator.specs

Interface BigDecimalSpec

All Superinterfaces:

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

All Known Implementing Classes:

BigDecimalGenerator

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	range(BigDecimal min, BigDecimal max)	Specifies the range for the generated number.
BigDecimalSpec	scale(int scale)	Scale of the generated BigDecimal.

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Method Details

min

BigDecimalSpec min(BigDecimal min)

Description copied from interface: NumberGeneratorSpec

Specifies the lower bound.

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)

Description copied from interface: NumberGeneratorSpec

Specifies the upper bound.

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)

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

   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)
 

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.

Specified by:

scale in interface BigDecimalGeneratorSpec

Parameters:

scale - to set

Returns:

spec builder