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>, TemporalGeneratorSpec<Year>

public class YearGenerator
extends AbstractGenerator<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected Year	max
protected Year	min

Constructor Summary

Constructors

Constructor	Description
YearGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
final TemporalGeneratorSpec<Year>	future()	Generate a temporal value in the future.
Year	generate(Random random)	Returns a generated value.
final TemporalGeneratorSpec<Year>	past()	Generate a temporal value in the past.
TemporalGeneratorSpec<Year>	range(Year start, Year end)	Generate a temporal value between the given range.

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

getContext, hints

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.AsStringGeneratorSpec

asString, asString

Field Details

min

protected Year min

max

protected Year max

Constructor Details

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

generate

public Year generate(Random random)

Description copied from interface: Generator

Returns a generated value.

If this method produces random data, the data needs to be generated using the provided Random instance. This ensures generated values are reproducible for a given seed value.

Parameters:

random - provider for generating random values

Returns:

generated value or null if value is nullable, could not be generated, or generation is delegated to the engine

past

public final TemporalGeneratorSpec<Year> past()

Description copied from interface: TemporalGeneratorSpec

Generate a temporal value in the past.

Specified by:

past in interface TemporalGeneratorSpec<T extends Temporal>

Returns:

spec builder

future

public final TemporalGeneratorSpec<Year> future()

Description copied from interface: TemporalGeneratorSpec

Generate a temporal value in the future.

Specified by:

future in interface TemporalGeneratorSpec<T extends Temporal>

Returns:

spec builder

range

public TemporalGeneratorSpec<Year> range(Year start,
 Year end)

Description copied from interface: TemporalGeneratorSpec

Generate a temporal value between the given range.

Specified by:

range in interface TemporalGeneratorSpec<T extends Temporal>

Parameters:

start - start date (inclusive)

end - end date (inclusive)

Returns:

spec builder