Package org.instancio.internal.generator.lang

Class AbstractRandomNumberGeneratorSpec<T extends Number>

java.lang.Object

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

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

All Implemented Interfaces:

AsStringGeneratorSpec<T>, Generator<T>, GeneratorSpec<T>, AsGeneratorSpec<T>, NullableGeneratorSpec<T>, NumberAsGeneratorSpec<T>, NumberGeneratorSpec<T>

Direct Known Subclasses:

AbstractRandomComparableNumberGeneratorSpec, AtomicIntegerGenerator, AtomicLongGenerator

public abstract class AbstractRandomNumberGeneratorSpec<T extends Number>
extends AbstractGenerator<T>
implements NumberAsGeneratorSpec<T>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRandomNumberGeneratorSpec(GeneratorContext context, T min, T max, boolean nullable)

Method Summary

Modifier and Type	Method	Description
T	generate(Random random)	Base implementation that handles nullable values.
protected final T	getMax()
protected final T	getMin()
NumberAsGeneratorSpec<T>	max(T max)	Specifies the upper bound.
NumberAsGeneratorSpec<T>	min(T min)	Specifies the lower bound.
NumberAsGeneratorSpec<T>	nullable()	Indicates that null value can be generated.
NumberAsGeneratorSpec<T>	nullable(boolean isNullable)
NumberAsGeneratorSpec<T>	range(T min, T max)	Specifies the range for the generated number.

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

apiMethod, getContext, hints, isNullable, tryGenerateNonNull

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

Constructor Details

AbstractRandomNumberGeneratorSpec

protected AbstractRandomNumberGeneratorSpec(GeneratorContext context,
 T min,
 T max,
 boolean nullable)

Method Details

getMin

protected final T getMin()

getMax

protected final T getMax()

min

public NumberAsGeneratorSpec<T> min(T min)

Description copied from interface: NumberGeneratorSpec

Specifies the lower bound.

Specified by:

min in interface NumberAsGeneratorSpec<T extends Number>

Specified by:

min in interface NumberGeneratorSpec<T extends Number>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

public NumberAsGeneratorSpec<T> max(T max)

Description copied from interface: NumberGeneratorSpec

Specifies the upper bound.

Specified by:

max in interface NumberAsGeneratorSpec<T extends Number>

Specified by:

max in interface NumberGeneratorSpec<T extends Number>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

nullable

public NumberAsGeneratorSpec<T> nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<T extends Number>

Specified by:

nullable in interface NumberAsGeneratorSpec<T extends Number>

Specified by:

nullable in interface NumberGeneratorSpec<T extends Number>

Overrides:

nullable in class AbstractGenerator<T extends Number>

Returns:

spec builder

nullable

public NumberAsGeneratorSpec<T> nullable(boolean isNullable)

Overrides:

nullable in class AbstractGenerator<T extends Number>

range

public NumberAsGeneratorSpec<T> range(T min,
 T 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 NumberAsGeneratorSpec<T extends Number>

Specified by:

range in interface NumberGeneratorSpec<T extends Number>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

generate

public T generate(Random random)

Description copied from class: AbstractGenerator

Base implementation that handles nullable values.

Specified by:

generate in interface Generator<T extends Number>

Overrides:

generate in class AbstractGenerator<T extends Number>

Parameters:

random - generating random the value

Returns:

generated value, either a null or non-null