Package org.instancio.generator.specs

Interface TemporalSpec<T>

Type Parameters:

T - temporal type

All Superinterfaces:

AsGeneratorSpec<T>, GeneratorSpec<T>, NullableGeneratorSpec<T>, Supplier<T>, TemporalGeneratorSpec<T>, ValueSpec<T>

All Known Subinterfaces:

InstantSpec, LocalDateSpec, LocalDateTimeSpec, LocalTimeSpec, OffsetDateTimeSpec, OffsetTimeSpec, YearMonthSpec, YearSpec, ZonedDateTimeSpec

public interface TemporalSpec<T>
extends ValueSpec<T>, TemporalGeneratorSpec<T>

Spec for generating Temporal types.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
TemporalSpec<T>	future()	Generate a value in the future.
TemporalSpec<T>	max(T max)	Specifies the upper bound.
TemporalSpec<T>	min(T min)	Specifies the lower bound.
TemporalSpec<T>	nullable()	Specifies that a null value can be generated
TemporalSpec<T>	past()	Generate a value in the past.
TemporalSpec<T>	range(T min, T max)	Generate a value within the given range.

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

as, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

Method Details

past

@NonDeterministic
TemporalSpec<T> past()

Generate a value in the past.

Specified by:

past in interface TemporalGeneratorSpec<T>

Returns:

spec builder

future

@NonDeterministic
TemporalSpec<T> future()

Generate a value in the future.

Specified by:

future in interface TemporalGeneratorSpec<T>

Returns:

spec builder

min

TemporalSpec<T> min(T min)

Specifies the lower bound.

Specified by:

min in interface TemporalGeneratorSpec<T>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

max

TemporalSpec<T> max(T max)

Specifies the upper bound.

Specified by:

max in interface TemporalGeneratorSpec<T>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

range

TemporalSpec<T> range(T min,
 T max)

Generate a value within the given range.

Specified by:

range in interface TemporalGeneratorSpec<T>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

See Also:

• TemporalGeneratorSpec.min(Object)
• TemporalGeneratorSpec.max(Object)

nullable

TemporalSpec<T> nullable()

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<T>

Specified by:

nullable in interface TemporalGeneratorSpec<T>

Specified by:

nullable in interface ValueSpec<T>

Returns:

spec builder reference

Since:

2.7.0