Package org.instancio.generator.specs

Interface YearSpec

All Superinterfaces:

AsGeneratorSpec<Year>, GeneratorSpec<Year>, NullableGeneratorSpec<Year>, Supplier<Year>, TemporalGeneratorSpec<Year>, TemporalSpec<Year>, ValueSpec<Year>

public interface YearSpec
extends TemporalSpec<Year>

Spec for generating Year values.

Since:

2.6.0

Method Summary

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

Generate a value in the past.

Specified by:

past in interface TemporalGeneratorSpec<Year>

Specified by:

past in interface TemporalSpec<Year>

Returns:

spec builder

future

@NonDeterministic
YearSpec future()

Generate a value in the future.

Specified by:

future in interface TemporalGeneratorSpec<Year>

Specified by:

future in interface TemporalSpec<Year>

Returns:

spec builder

min

YearSpec min(Year min)

Specifies the lower bound.

Specified by:

min in interface TemporalGeneratorSpec<Year>

Specified by:

min in interface TemporalSpec<Year>

Parameters:

min - lower bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

max

YearSpec max(Year max)

Specifies the upper bound.

Specified by:

max in interface TemporalGeneratorSpec<Year>

Specified by:

max in interface TemporalSpec<Year>

Parameters:

max - upper bound (inclusive)

Returns:

spec builder

Since:

4.6.0

See Also:

• TemporalGeneratorSpec.range(Object, Object)

range

YearSpec range(Year min,
 Year max)

Generate a value within the given range.

Specified by:

range in interface TemporalGeneratorSpec<Year>

Specified by:

range in interface TemporalSpec<Year>

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

See Also:

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

nullable

YearSpec nullable()

Specifies that a null value can be generated

Specified by:

nullable in interface NullableGeneratorSpec<Year>

Specified by:

nullable in interface TemporalGeneratorSpec<Year>

Specified by:

nullable in interface TemporalSpec<Year>

Specified by:

nullable in interface ValueSpec<Year>

Returns:

spec builder reference

Since:

2.7.0