Package org.instancio.generator.specs

Interface InstantSpec

All Superinterfaces:

GeneratorSpec<Instant>, NullableGeneratorSpec<Instant>, TemporalGeneratorSpec<Instant>, TemporalSpec<Instant>, TruncatableTemporalSpec<Instant>, ValueSpec<Instant>

public interface InstantSpec
extends TemporalSpec<Instant>, TruncatableTemporalSpec<Instant>

Spec for generating Instant values.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
InstantSpec	future()	Generate a value in the future.
InstantSpec	nullable()	Specifies that a null value can be generated
InstantSpec	past()	Generate a value in the past.
InstantSpec	range(Instant start, Instant end)	Generate a value within the given range.
InstantSpec	truncatedTo(TemporalUnit unit)	Truncates generated values to the specified unit.

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Method Details

past

InstantSpec past()

Generate a value in the past.

Specified by:

past in interface TemporalGeneratorSpec<Instant>

Specified by:

past in interface TemporalSpec<Instant>

Returns:

spec builder

future

InstantSpec future()

Generate a value in the future.

Specified by:

future in interface TemporalGeneratorSpec<Instant>

Specified by:

future in interface TemporalSpec<Instant>

Returns:

spec builder

range

InstantSpec range(Instant start,
 Instant end)

Generate a value within the given range.

Specified by:

range in interface TemporalGeneratorSpec<Instant>

Specified by:

range in interface TemporalSpec<Instant>

Parameters:

start - lower bound (inclusive)

end - upper bound (inclusive)

Returns:

spec builder

truncatedTo

InstantSpec truncatedTo(TemporalUnit unit)

Truncates generated values to the specified unit.

Specified by:

truncatedTo in interface TruncatableTemporalSpec<Instant>

Parameters:

unit - to truncate to

Returns:

spec builder

Since:

4.2.0

nullable

InstantSpec nullable()

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<Instant>

Specified by:

nullable in interface TemporalGeneratorSpec<Instant>

Specified by:

nullable in interface TemporalSpec<Instant>

Specified by:

nullable in interface ValueSpec<Instant>

Returns:

spec builder reference

Since:

2.7.0