Package org.instancio.internal.generator.lang

Class IntegerGenerator

java.lang.Object

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

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

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

org.instancio.internal.generator.lang.IntegerGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<Integer>, Generator<Integer>, GeneratorSpec<Integer>, IntegerSpec, NullableGeneratorSpec<Integer>, NumberAsStringGeneratorSpec<Integer>, NumberGeneratorSpec<Integer>, NumberSpec<Integer>, ValueSpec<Integer>

public class IntegerGenerator
extends AbstractRandomComparableNumberGeneratorSpec<Integer>
implements IntegerSpec

Constructor Summary

Constructors

Constructor	Description
IntegerGenerator()
IntegerGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
protected Integer	generateNonNullValue(Random random)
IntegerGenerator	max(Integer max)	Upper bound for the random number generator.
IntegerGenerator	min(Integer min)	Lower bound for the random number generator.
IntegerGenerator	nullable()	Indicates that null value can be generated.
IntegerGenerator	nullable(boolean isNullable)
IntegerGenerator	range(Integer min, Integer max)	Range for the random number generator

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

generate, getMax, getMin

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

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

asString, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

IntegerGenerator

public IntegerGenerator(GeneratorContext context)

IntegerGenerator

public IntegerGenerator()

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<Integer>

Returns:

spec name if defined, or null otherwise

min

public IntegerGenerator min(Integer 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 IntegerSpec

Specified by:

min in interface NumberAsStringGeneratorSpec<Integer>

Specified by:

min in interface NumberGeneratorSpec<Integer>

Specified by:

min in interface NumberSpec<Integer>

Overrides:

min in class AbstractRandomComparableNumberGeneratorSpec<Integer>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

public IntegerGenerator max(Integer 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 IntegerSpec

Specified by:

max in interface NumberAsStringGeneratorSpec<Integer>

Specified by:

max in interface NumberGeneratorSpec<Integer>

Specified by:

max in interface NumberSpec<Integer>

Overrides:

max in class AbstractRandomComparableNumberGeneratorSpec<Integer>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

public IntegerGenerator range(Integer min,
 Integer max)

Description copied from interface: NumberGeneratorSpec

Range for the random number generator

Specified by:

range in interface IntegerSpec

Specified by:

range in interface NumberAsStringGeneratorSpec<Integer>

Specified by:

range in interface NumberGeneratorSpec<Integer>

Specified by:

range in interface NumberSpec<Integer>

Overrides:

range in class AbstractRandomComparableNumberGeneratorSpec<Integer>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

public IntegerGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface IntegerSpec

Specified by:

nullable in interface NullableGeneratorSpec<Integer>

Specified by:

nullable in interface NumberAsStringGeneratorSpec<Integer>

Specified by:

nullable in interface NumberGeneratorSpec<Integer>

Specified by:

nullable in interface NumberSpec<Integer>

Overrides:

nullable in class AbstractRandomNumberGeneratorSpec<Integer>

Returns:

spec builder

nullable

public IntegerGenerator nullable(boolean isNullable)

Overrides:

nullable in class AbstractRandomNumberGeneratorSpec<Integer>

generateNonNullValue

protected Integer generateNonNullValue(Random random)

Specified by:

generateNonNullValue in class AbstractRandomNumberGeneratorSpec<Integer>