Package org.instancio.generator.specs

Interface OffsetDateTimeSpec

All Superinterfaces:

AsGeneratorSpec<OffsetDateTime>, GeneratorSpec<OffsetDateTime>, NullableGeneratorSpec<OffsetDateTime>, OffsetDateTimeGeneratorSpec, Supplier<OffsetDateTime>, TemporalGeneratorSpec<OffsetDateTime>, TemporalSpec<OffsetDateTime>, TruncatableTemporalGeneratorSpec<OffsetDateTime>, ValueSpec<OffsetDateTime>

public interface OffsetDateTimeSpec
extends TemporalSpec<OffsetDateTime>, OffsetDateTimeGeneratorSpec, TruncatableTemporalGeneratorSpec<OffsetDateTime>

Spec for generating OffsetDateTime values.

Since:

2.6.0

Method Summary

Modifier and Type	Method	Description
OffsetDateTimeSpec	future()	Generate a value in the future.
OffsetDateTimeSpec	max(OffsetDateTime max)	Specifies the upper bound.
OffsetDateTimeSpec	min(OffsetDateTime min)	Specifies the lower bound.
OffsetDateTimeSpec	nullable()	Specifies that a null value can be generated
OffsetDateTimeSpec	past()	Generate a value in the past.
OffsetDateTimeSpec	range(OffsetDateTime min, OffsetDateTime max)	Generate a value within the given range.
OffsetDateTimeSpec	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
OffsetDateTimeSpec past()

Generate a value in the past.

Specified by:

past in interface OffsetDateTimeGeneratorSpec

Specified by:

past in interface TemporalGeneratorSpec<OffsetDateTime>

Specified by:

past in interface TemporalSpec<OffsetDateTime>

Returns:

spec builder

future

@NonDeterministic
OffsetDateTimeSpec future()

Generate a value in the future.

Specified by:

future in interface OffsetDateTimeGeneratorSpec

Specified by:

future in interface TemporalGeneratorSpec<OffsetDateTime>

Specified by:

future in interface TemporalSpec<OffsetDateTime>

Returns:

spec builder

min

OffsetDateTimeSpec min(OffsetDateTime min)

Specifies the lower bound.

Specified by:

min in interface OffsetDateTimeGeneratorSpec

Specified by:

min in interface TemporalGeneratorSpec<OffsetDateTime>

Specified by:

min in interface TemporalSpec<OffsetDateTime>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

max

OffsetDateTimeSpec max(OffsetDateTime max)

Specifies the upper bound.

Specified by:

max in interface OffsetDateTimeGeneratorSpec

Specified by:

max in interface TemporalGeneratorSpec<OffsetDateTime>

Specified by:

max in interface TemporalSpec<OffsetDateTime>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

range

OffsetDateTimeSpec range(OffsetDateTime min,
 OffsetDateTime max)

Generate a value within the given range.

Specified by:

range in interface OffsetDateTimeGeneratorSpec

Specified by:

range in interface TemporalGeneratorSpec<OffsetDateTime>

Specified by:

range in interface TemporalSpec<OffsetDateTime>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

See Also:

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

truncatedTo

OffsetDateTimeSpec truncatedTo(TemporalUnit unit)

Truncates generated values to the specified unit.

Specified by:

truncatedTo in interface OffsetDateTimeGeneratorSpec

Specified by:

truncatedTo in interface TruncatableTemporalGeneratorSpec<OffsetDateTime>

Parameters:

unit - to truncate to

Returns:

spec builder

Since:

4.2.0

nullable

OffsetDateTimeSpec nullable()

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<OffsetDateTime>

Specified by:

nullable in interface OffsetDateTimeGeneratorSpec

Specified by:

nullable in interface TemporalGeneratorSpec<OffsetDateTime>

Specified by:

nullable in interface TemporalSpec<OffsetDateTime>

Specified by:

nullable in interface ValueSpec<OffsetDateTime>

Returns:

spec builder reference

Since:

2.7.0