Package org.instancio.generator.math

Class BigDecimalGenerator

java.lang.Object

org.instancio.generator.AbstractGenerator<T>

org.instancio.generator.lang.AbstractRandomNumberGeneratorSpec<T>

org.instancio.generator.lang.AbstractRandomComparableNumberGeneratorSpec<BigDecimal>

org.instancio.generator.math.BigDecimalGenerator

All Implemented Interfaces:

Generator<BigDecimal>, GeneratorSpec<BigDecimal>, BigDecimalGeneratorSpec, NumberGeneratorSpec<BigDecimal>

public class BigDecimalGenerator
extends AbstractRandomComparableNumberGeneratorSpec<BigDecimal>
implements BigDecimalGeneratorSpec

Field Summary

Fields inherited from class org.instancio.generator.lang.AbstractRandomNumberGeneratorSpec

max, min, nullable

Constructor Summary

Constructors

Constructor	Description
BigDecimalGenerator(GeneratorContext context)
BigDecimalGenerator(GeneratorContext context, BigDecimal min, BigDecimal max, boolean nullable)

Method Summary

Modifier and Type	Method	Description
protected BigDecimal	generateNonNullValue(Random random)
BigDecimalGeneratorSpec	max(BigDecimal max)	Upper bound for the random number generator.
BigDecimalGeneratorSpec	min(BigDecimal min)	Lower bound for the random number generator.
BigDecimalGeneratorSpec	nullable()	Specifies the generated value can be null.
BigDecimalGeneratorSpec	range(BigDecimal min, BigDecimal max)	Range for the random number generator
BigDecimalGeneratorSpec	scale(int scale)	Scale of the generated BigDecimal.

Methods inherited from class org.instancio.generator.lang.AbstractRandomNumberGeneratorSpec

generate, getHints, getMax, getMin

Methods inherited from class org.instancio.generator.AbstractGenerator

getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.instancio.Generator

apiMethodName, isDelegating, setDelegate, supports, targetClass

Constructor Details

BigDecimalGenerator

public BigDecimalGenerator(GeneratorContext context)

BigDecimalGenerator

public BigDecimalGenerator(GeneratorContext context,
 BigDecimal min,
 BigDecimal max,
 boolean nullable)

Method Details

scale

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

min

public BigDecimalGeneratorSpec min(BigDecimal min)

Description copied from class: AbstractRandomComparableNumberGeneratorSpec

Lower bound for the random number generator.

If the specified min value is greater than or equal to the current max value, the max value will be updated to a value higher than the given min.

Specified by:

min in interface BigDecimalGeneratorSpec

Specified by:

min in interface NumberGeneratorSpec<BigDecimal>

Overrides:

min in class AbstractRandomComparableNumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

public BigDecimalGeneratorSpec max(BigDecimal max)

Description copied from class: AbstractRandomComparableNumberGeneratorSpec

Upper bound for the random number generator.

If the specified max value is less than or equal to the current min value, the min value will be updated to a value lower than the given max.

Specified by:

max in interface BigDecimalGeneratorSpec

Specified by:

max in interface NumberGeneratorSpec<BigDecimal>

Overrides:

max in class AbstractRandomComparableNumberGeneratorSpec<BigDecimal>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

public BigDecimalGeneratorSpec range(BigDecimal min,
 BigDecimal max)

Description copied from interface: NumberGeneratorSpec

Range for the random number generator

Specified by:

range in interface BigDecimalGeneratorSpec

Specified by:

range in interface NumberGeneratorSpec<BigDecimal>

Overrides:

range in class AbstractRandomComparableNumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

public BigDecimalGeneratorSpec nullable()

Description copied from interface: NumberGeneratorSpec

Specifies the generated value can be null.

Specified by:

nullable in interface BigDecimalGeneratorSpec

Specified by:

nullable in interface NumberGeneratorSpec<BigDecimal>

Overrides:

nullable in class AbstractRandomNumberGeneratorSpec<BigDecimal>

Returns:

spec builder

generateNonNullValue

protected BigDecimal generateNonNullValue(Random random)

Specified by:

generateNonNullValue in class AbstractRandomNumberGeneratorSpec<BigDecimal>