Package org.instancio.internal.generator.math

Class BigDecimalGenerator

java.lang.Object

org.instancio.internal.generator.AbstractGenerator<T>

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

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

org.instancio.internal.generator.math.BigDecimalGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<BigDecimal>, Generator<BigDecimal>, GeneratorSpec<BigDecimal>, AsGeneratorSpec<BigDecimal>, BigDecimalAsGeneratorSpec, BigDecimalGeneratorSpec, BigDecimalSpec, NullableGeneratorSpec<BigDecimal>, NumberAsGeneratorSpec<BigDecimal>, NumberGeneratorSpec<BigDecimal>, ValueSpec<BigDecimal>

public class BigDecimalGenerator
extends AbstractRandomComparableNumberGeneratorSpec<BigDecimal>
implements BigDecimalSpec, BigDecimalAsGeneratorSpec

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
BigDecimalGenerator	max(BigDecimal max)	Upper bound for the random number generator.
BigDecimalGenerator	min(BigDecimal min)	Lower bound for the random number generator.
BigDecimalGenerator	nullable()	Indicates that null value can be generated.
BigDecimalGenerator	nullable(boolean isNullable)
BigDecimalGenerator	range(BigDecimal min, BigDecimal max)	Range for the random number generator
BigDecimalGenerator	scale(int scale)	Scale of the generated BigDecimal.
protected BigDecimal	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.

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

getMax, getMin

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

generate, getContext, hints, isNullable

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.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

BigDecimalGenerator

public BigDecimalGenerator()

BigDecimalGenerator

public BigDecimalGenerator(GeneratorContext context)

BigDecimalGenerator

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

Method Details

apiMethod

public String apiMethod()

Description copied from class: AbstractGenerator

Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.

Specified by:

apiMethod in class AbstractGenerator<BigDecimal>

Returns:

spec name if defined, or null otherwise

scale

public BigDecimalGenerator scale(int scale)

Description copied from interface: BigDecimalGeneratorSpec

Scale of the generated BigDecimal.

Specified by:

scale in interface BigDecimalAsGeneratorSpec

Specified by:

scale in interface BigDecimalGeneratorSpec

Specified by:

scale in interface BigDecimalSpec

Parameters:

scale - to set

Returns:

spec builder

min

public BigDecimalGenerator 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 BigDecimalAsGeneratorSpec

Specified by:

min in interface BigDecimalGeneratorSpec

Specified by:

min in interface BigDecimalSpec

Specified by:

min in interface NumberAsGeneratorSpec<BigDecimal>

Specified by:

min in interface NumberGeneratorSpec<BigDecimal>

Overrides:

min in class AbstractRandomComparableNumberGeneratorSpec<BigDecimal>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

public BigDecimalGenerator 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 BigDecimalAsGeneratorSpec

Specified by:

max in interface BigDecimalGeneratorSpec

Specified by:

max in interface BigDecimalSpec

Specified by:

max in interface NumberAsGeneratorSpec<BigDecimal>

Specified by:

max in interface NumberGeneratorSpec<BigDecimal>

Overrides:

max in class AbstractRandomComparableNumberGeneratorSpec<BigDecimal>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

public BigDecimalGenerator range(BigDecimal min,
 BigDecimal max)

Description copied from interface: NumberGeneratorSpec

Range for the random number generator

Specified by:

range in interface BigDecimalAsGeneratorSpec

Specified by:

range in interface BigDecimalGeneratorSpec

Specified by:

range in interface BigDecimalSpec

Specified by:

range in interface NumberAsGeneratorSpec<BigDecimal>

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 BigDecimalGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface BigDecimalAsGeneratorSpec

Specified by:

nullable in interface BigDecimalGeneratorSpec

Specified by:

nullable in interface BigDecimalSpec

Specified by:

nullable in interface NullableGeneratorSpec<BigDecimal>

Specified by:

nullable in interface NumberAsGeneratorSpec<BigDecimal>

Specified by:

nullable in interface NumberGeneratorSpec<BigDecimal>

Specified by:

nullable in interface ValueSpec<BigDecimal>

Overrides:

nullable in class AbstractRandomNumberGeneratorSpec<BigDecimal>

Returns:

spec builder

nullable

public BigDecimalGenerator nullable(boolean isNullable)

Overrides:

nullable in class AbstractRandomNumberGeneratorSpec<BigDecimal>

tryGenerateNonNull

protected BigDecimal tryGenerateNonNull(Random random)

Description copied from class: AbstractGenerator

Makes the best effort to return a non-null value. However, in certain cases this method will produce a null.

Specified by:

tryGenerateNonNull in class AbstractGenerator<BigDecimal>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null