Package org.instancio.generator.specs

Interface NumberAsGeneratorSpec<T extends Number>

All Superinterfaces:

AsGeneratorSpec<T>, GeneratorSpec<T>, NullableGeneratorSpec<T>, NumberGeneratorSpec<T>

public interface NumberAsGeneratorSpec<T extends Number>
extends NumberGeneratorSpec<T>, AsGeneratorSpec<T>

Generator spec for Number types that supports AsGeneratorSpec.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
NumberAsGeneratorSpec<T>	max(T max)	Specifies the upper bound.
NumberAsGeneratorSpec<T>	min(T min)	Specifies the lower bound.
NumberAsGeneratorSpec<T>	nullable()	Specifies that a null can be generated.
NumberAsGeneratorSpec<T>	range(T min, T max)	Specifies the range for generated numbers.

Methods inherited from interface org.instancio.generator.specs.AsGeneratorSpec

as, asString

Method Details

min

NumberAsGeneratorSpec<T> min(T min)

Description copied from interface: NumberGeneratorSpec

Specifies the lower bound.

Specified by:

min in interface NumberGeneratorSpec<T extends Number>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

max

NumberAsGeneratorSpec<T> max(T max)

Description copied from interface: NumberGeneratorSpec

Specifies the upper bound.

Specified by:

max in interface NumberGeneratorSpec<T extends Number>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

range

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

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

nullable

NumberAsGeneratorSpec<T> nullable()

Description copied from interface: NumberGeneratorSpec

Specifies that a null can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<T extends Number>

Specified by:

nullable in interface NumberGeneratorSpec<T extends Number>

Returns:

spec builder