Package org.instancio.generator.specs

Interface InstantSpec

All Superinterfaces:

AsGeneratorSpec<Instant>, GeneratorSpec<Instant>, InstantGeneratorSpec, NullableGeneratorSpec<Instant>, Supplier<Instant>, TemporalGeneratorSpec<Instant>, TemporalSpec<Instant>, TruncatableTemporalGeneratorSpec<Instant>, ValueSpec<Instant>

public interface InstantSpec
extends TemporalSpec<Instant>, InstantGeneratorSpec, TruncatableTemporalGeneratorSpec<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	max(Instant max)	Specifies the upper bound.
InstantSpec	min(Instant min)	Specifies the lower bound.
InstantSpec	nullable()	Specifies that a null value can be generated
InstantSpec	past()	Generate a value in the past.
InstantSpec	range(Instant min, Instant max)	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.specs.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

Method Details

past

@NonDeterministic
InstantSpec past()

Generate a value in the past.

Specified by:

past in interface InstantGeneratorSpec

Specified by:

past in interface TemporalGeneratorSpec<Instant>

Specified by:

past in interface TemporalSpec<Instant>

Returns:

spec builder

future

@NonDeterministic
InstantSpec future()

Generate a value in the future.

Specified by:

future in interface InstantGeneratorSpec

Specified by:

future in interface TemporalGeneratorSpec<Instant>

Specified by:

future in interface TemporalSpec<Instant>

Returns:

spec builder

min

InstantSpec min(Instant min)

Specifies the lower bound.

Specified by:

min in interface InstantGeneratorSpec

Specified by:

min in interface TemporalGeneratorSpec<Instant>

Specified by:

min in interface TemporalSpec<Instant>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

max

InstantSpec max(Instant max)

Specifies the upper bound.

Specified by:

max in interface InstantGeneratorSpec

Specified by:

max in interface TemporalGeneratorSpec<Instant>

Specified by:

max in interface TemporalSpec<Instant>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

range

InstantSpec range(Instant min,
 Instant max)

Generate a value within the given range.

Specified by:

range in interface InstantGeneratorSpec

Specified by:

range in interface TemporalGeneratorSpec<Instant>

Specified by:

range in interface TemporalSpec<Instant>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

See Also:

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

truncatedTo

InstantSpec truncatedTo(TemporalUnit unit)

Truncates generated values to the specified unit.

Specified by:

truncatedTo in interface InstantGeneratorSpec

Specified by:

truncatedTo in interface TruncatableTemporalGeneratorSpec<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 InstantGeneratorSpec

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