Package org.instancio.internal.generator.math

Class BigIntegerGenerator

java.lang.Object

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

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

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

org.instancio.internal.generator.math.BigIntegerGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<BigInteger>, Generator<BigInteger>, GeneratorSpec<BigInteger>, AsGeneratorSpec<BigInteger>, BigIntegerSpec, NullableGeneratorSpec<BigInteger>, NumberAsGeneratorSpec<BigInteger>, NumberGeneratorSpec<BigInteger>, NumberSpec<BigInteger>, ValueSpec<BigInteger>

public class BigIntegerGenerator
extends AbstractRandomComparableNumberGeneratorSpec<BigInteger>
implements BigIntegerSpec

Constructor Summary

Constructors

Constructor	Description
BigIntegerGenerator()
BigIntegerGenerator(GeneratorContext context)
BigIntegerGenerator(GeneratorContext context, BigInteger min, BigInteger max, boolean nullable)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
BigIntegerGenerator	max(BigInteger max)	Upper bound for the random number generator.
BigIntegerGenerator	min(BigInteger min)	Lower bound for the random number generator.
BigIntegerGenerator	nullable()	Indicates that null value can be generated.
BigIntegerGenerator	nullable(boolean isNullable)
BigIntegerGenerator	range(BigInteger min, BigInteger max)	Range for the random number generator
protected BigInteger	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

BigIntegerGenerator

public BigIntegerGenerator()

BigIntegerGenerator

public BigIntegerGenerator(GeneratorContext context)

BigIntegerGenerator

public BigIntegerGenerator(GeneratorContext context,
 BigInteger min,
 BigInteger 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<BigInteger>

Returns:

spec name if defined, or null otherwise

min

public BigIntegerGenerator min(BigInteger 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 BigIntegerSpec

Specified by:

min in interface NumberAsGeneratorSpec<BigInteger>

Specified by:

min in interface NumberGeneratorSpec<BigInteger>

Specified by:

min in interface NumberSpec<BigInteger>

Overrides:

min in class AbstractRandomComparableNumberGeneratorSpec<BigInteger>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

public BigIntegerGenerator max(BigInteger 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 BigIntegerSpec

Specified by:

max in interface NumberAsGeneratorSpec<BigInteger>

Specified by:

max in interface NumberGeneratorSpec<BigInteger>

Specified by:

max in interface NumberSpec<BigInteger>

Overrides:

max in class AbstractRandomComparableNumberGeneratorSpec<BigInteger>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

public BigIntegerGenerator range(BigInteger min,
 BigInteger max)

Description copied from interface: NumberGeneratorSpec

Range for the random number generator

Specified by:

range in interface BigIntegerSpec

Specified by:

range in interface NumberAsGeneratorSpec<BigInteger>

Specified by:

range in interface NumberGeneratorSpec<BigInteger>

Specified by:

range in interface NumberSpec<BigInteger>

Overrides:

range in class AbstractRandomComparableNumberGeneratorSpec<BigInteger>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

public BigIntegerGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface BigIntegerSpec

Specified by:

nullable in interface NullableGeneratorSpec<BigInteger>

Specified by:

nullable in interface NumberAsGeneratorSpec<BigInteger>

Specified by:

nullable in interface NumberGeneratorSpec<BigInteger>

Specified by:

nullable in interface NumberSpec<BigInteger>

Specified by:

nullable in interface ValueSpec<BigInteger>

Overrides:

nullable in class AbstractRandomNumberGeneratorSpec<BigInteger>

Returns:

spec builder

nullable

public BigIntegerGenerator nullable(boolean isNullable)

Overrides:

nullable in class AbstractRandomNumberGeneratorSpec<BigInteger>

tryGenerateNonNull

protected BigInteger 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<BigInteger>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null