Package org.instancio.generator.specs

Interface InstantGeneratorSpec

All Superinterfaces:

AsGeneratorSpec<Instant>, GeneratorSpec<Instant>, NullableGeneratorSpec<Instant>, TemporalGeneratorSpec<Instant>, TruncatableTemporalGeneratorSpec<Instant>

All Known Subinterfaces:

InstantSpec

public interface InstantGeneratorSpec
extends TemporalGeneratorSpec<Instant>, TruncatableTemporalGeneratorSpec<Instant>

Generator spec for Instant.

Since:

4.2.0

Method Summary

Modifier and Type	Method	Description
InstantGeneratorSpec	future()	Generate a value in the future.
InstantGeneratorSpec	max(Instant max)	Specifies the upper bound.
InstantGeneratorSpec	min(Instant min)	Specifies the lower bound.
InstantGeneratorSpec	nullable()	Indicates that null value can be generated.
InstantGeneratorSpec	past()	Generate a value in the past.
InstantGeneratorSpec	range(Instant min, Instant max)	Generate a value within the given range.
InstantGeneratorSpec	truncatedTo(TemporalUnit unit)	Truncates generated values to the specified unit.

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

as, asString

Method Details

past

@NonDeterministic
InstantGeneratorSpec past()

Generate a value in the past.

Specified by:

past in interface TemporalGeneratorSpec<Instant>

Returns:

spec builder

future

@NonDeterministic
InstantGeneratorSpec future()

Generate a value in the future.

Specified by:

future in interface TemporalGeneratorSpec<Instant>

Returns:

spec builder

min

InstantGeneratorSpec min(Instant min)

Specifies the lower bound.

Specified by:

min in interface TemporalGeneratorSpec<Instant>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

max

InstantGeneratorSpec max(Instant max)

Specifies the upper bound.

Specified by:

max in interface TemporalGeneratorSpec<Instant>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

range

InstantGeneratorSpec range(Instant min,
 Instant max)

Generate a value within the given range.

Specified by:

range in interface TemporalGeneratorSpec<Instant>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

See Also:

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

truncatedTo

InstantGeneratorSpec truncatedTo(TemporalUnit unit)

Truncates generated values to the specified unit.

Specified by:

truncatedTo in interface TruncatableTemporalGeneratorSpec<Instant>

Parameters:

unit - to truncate to

Returns:

spec builder

nullable

InstantGeneratorSpec nullable()

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<Instant>

Specified by:

nullable in interface TemporalGeneratorSpec<Instant>

Returns:

spec builder