Package org.instancio.generator.specs

Interface IntegerSpec

All Superinterfaces:

GeneratorSpec<Integer>, NullableGeneratorSpec<Integer>, NumberGeneratorSpec<Integer>, NumberSpec<Integer>, ValueSpec<Integer>

public interface IntegerSpec
extends NumberSpec<Integer>

Spec for generating Integer values.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
IntegerSpec	max(Integer max)	Specifies the upper bound.
IntegerSpec	min(Integer min)	Specifies the lower bound.
IntegerSpec	nullable()	Specifies that a null value can be generated
IntegerSpec	range(Integer min, Integer max)	Specifies the range for generated numbers.

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Method Details

min

IntegerSpec min(Integer min)

Description copied from interface: NumberGeneratorSpec

Specifies the lower bound.

Specified by:

min in interface NumberGeneratorSpec<Integer>

Specified by:

min in interface NumberSpec<Integer>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

IntegerSpec max(Integer max)

Description copied from interface: NumberGeneratorSpec

Specifies the upper bound.

Specified by:

max in interface NumberGeneratorSpec<Integer>

Specified by:

max in interface NumberSpec<Integer>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

IntegerSpec range(Integer min,
 Integer max)

Description copied from interface: NumberGeneratorSpec

Specifies the range for generated numbers.

The following examples use int, however the same principle applies to all numeric types, including BigInteger and BigDecimal.

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

Specified by:

range in interface NumberSpec<Integer>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

IntegerSpec nullable()

Description copied from interface: ValueSpec

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<Integer>

Specified by:

nullable in interface NumberGeneratorSpec<Integer>

Specified by:

nullable in interface NumberSpec<Integer>

Specified by:

nullable in interface ValueSpec<Integer>

Returns:

spec builder reference