Package org.instancio.generator.specs

Interface NumericSequenceGeneratorSpec<T extends Number & Comparable<T>>

Type Parameters:

T - the number type

All Superinterfaces:

GeneratorSpec<T>, NullableGeneratorSpec<T>

All Known Subinterfaces:

NumericSequenceAsGeneratorSpec<T>, NumericSequenceSpec<T>

@ExperimentalApi
public interface NumericSequenceGeneratorSpec<T extends Number & Comparable<T>>
extends NullableGeneratorSpec<T>

A spec for generating numeric sequences.

Since:

2.13.0

Method Summary

Modifier and Type	Method	Description
NumericSequenceGeneratorSpec<T>	next(UnaryOperator<T> next)	Specifies the function for calculating the next sequence value.
NumericSequenceGeneratorSpec<T>	nullable()	Indicates that null value can be generated.
NumericSequenceGeneratorSpec<T>	start(T start)	Specifies the starting value of the sequence.

Method Details

start

NumericSequenceGeneratorSpec<T> start(T start)

Specifies the starting value of the sequence. The default is 1.

Parameters:

start - the initial value of the sequence

Returns:

spec builder

Since:

2.13.0

next

NumericSequenceGeneratorSpec<T> next(UnaryOperator<T> next)

Specifies the function for calculating the next sequence value. If unspecified, the default is to increment the sequence by 1.

Parameters:

next - a function for calculating the next value

Returns:

spec builder

Since:

2.13.0

nullable

NumericSequenceGeneratorSpec<T> nullable()

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<T extends Number & Comparable<T>>

Returns:

spec builder

Since:

2.13.0