Package org.instancio.generator.specs

Interface BigDecimalGeneratorSpec

All Superinterfaces:

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

All Known Subinterfaces:

BigDecimalAsGeneratorSpec, BigDecimalSpec

All Known Implementing Classes:

BigDecimalGenerator

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

Method Details

min

BigDecimalGeneratorSpec min(BigDecimal min)

Description copied from interface: NumberGeneratorSpec

Specifies the lower bound.

Specified by:

min in interface NumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

BigDecimalGeneratorSpec max(BigDecimal max)

Description copied from interface: NumberGeneratorSpec

Specifies the upper bound.

Specified by:

max in interface NumberGeneratorSpec<BigDecimal>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

BigDecimalGeneratorSpec 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 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.

Parameters:

scale - to set

Returns:

spec builder

Since:

1.5.4