Package org.instancio.internal.generator.time

Class YearGenerator

java.lang.Object

org.instancio.internal.generator.AbstractGenerator<T>

org.instancio.internal.generator.time.YearGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<Year>, Generator<Year>, GeneratorSpec<Year>, AsGeneratorSpec<Year>, NullableGeneratorSpec<Year>, TemporalAaStringGeneratorSpec<Year>, TemporalGeneratorSpec<Year>, TemporalSpec<Year>, YearSpec, ValueSpec<Year>

public class YearGenerator
extends AbstractGenerator<T>
implements YearSpec

Field Summary

Fields

Modifier and Type	Field	Description
protected Year	max
protected Year	min

Constructor Summary

Constructors

Constructor	Description
YearGenerator()
YearGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
YearGenerator	future()	Generate a value in the future.
YearGenerator	nullable()	Indicates that null value can be generated.
YearGenerator	past()	Generate a value in the past.
YearGenerator	range(Year start, Year end)	Generate a value within the given range.
protected Year	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.

Methods inherited from class org.instancio.internal.generator.AbstractGenerator

generate, getContext, hints, isNullable, nullable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

asString

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Field Details

min

protected Year min

max

protected Year max

Constructor Details

YearGenerator

public YearGenerator()

YearGenerator

public YearGenerator(GeneratorContext context)

Method Details

apiMethod

public String apiMethod()

Description copied from class: AbstractGenerator

Returns the public API method name of the generator spec. The returned name is used for reporting validation errors.

Specified by:

apiMethod in class AbstractGenerator<Year>

Returns:

spec name if defined, or null otherwise

past

public YearGenerator past()

Description copied from interface: TemporalGeneratorSpec

Generate a value in the past.

Specified by:

past in interface TemporalAaStringGeneratorSpec<Year>

Specified by:

past in interface TemporalGeneratorSpec<Year>

Specified by:

past in interface TemporalSpec<Year>

Specified by:

past in interface YearSpec

Returns:

spec builder

future

public YearGenerator future()

Description copied from interface: TemporalGeneratorSpec

Generate a value in the future.

Specified by:

future in interface TemporalAaStringGeneratorSpec<Year>

Specified by:

future in interface TemporalGeneratorSpec<Year>

Specified by:

future in interface TemporalSpec<Year>

Specified by:

future in interface YearSpec

Returns:

spec builder

range

public YearGenerator range(Year start,
 Year end)

Description copied from interface: TemporalGeneratorSpec

Generate a value within the given range.

Specified by:

range in interface TemporalAaStringGeneratorSpec<Year>

Specified by:

range in interface TemporalGeneratorSpec<Year>

Specified by:

range in interface TemporalSpec<Year>

Specified by:

range in interface YearSpec

Parameters:

start - lower bound (inclusive)

end - upper bound (inclusive)

Returns:

spec builder

nullable

public YearGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that 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>

Specified by:

nullable in interface YearSpec

Overrides:

nullable in class AbstractGenerator<Year>

Returns:

spec builder

tryGenerateNonNull

protected Year tryGenerateNonNull(Random random)

Description copied from class: AbstractGenerator

Makes the best effort to return a non-null value. However, in certain cases this method will produce a null.

Specified by:

tryGenerateNonNull in class AbstractGenerator<Year>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null