Package org.instancio.generator.time

Class YearGenerator

java.lang.Object

org.instancio.generator.AbstractGenerator<T>

org.instancio.generator.time.YearGenerator

All Implemented Interfaces:

Generator<Year>, GeneratorSpec<Year>, TemporalGeneratorSpec<Year>

public class YearGenerator
extends AbstractGenerator<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected T	max
protected T	min

Fields inherited from interface org.instancio.generator.time.TemporalGeneratorSpec

DEFAULT_MAX, DEFAULT_MIN

Constructor Summary

Constructors

Constructor	Description
YearGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
TemporalGeneratorSpec<T>	future()	Generate a temporal value in the future.
Year	generate(RandomProvider random)	Returns a generated value.
TemporalGeneratorSpec<T>	past()	Generate a temporal value in the past.
TemporalGeneratorSpec<T>	range(T startInclusive, T endExclusive)	Generate a temporal value between the given range.

Methods inherited from class org.instancio.generator.AbstractGenerator

getContext

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

apiMethodName, getHints, isDelegating, setDelegate, supports, targetClass

Field Detail

min

protected T extends Temporal min

max

protected T extends Temporal max

Constructor Detail

YearGenerator

public YearGenerator(GeneratorContext context)

Method Detail

generate

public Year generate(RandomProvider random)

Description copied from interface: Generator

Returns a generated value.

If the generated value is random, it needs to be generated using the given RandomProvider instance. This ensures the data is generated with the same seed value and allows random data to be reproduced by specifying the seed value.

Parameters:

random - provider for random values

Returns:

generated value

past

public final TemporalGeneratorSpec<T> 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<T> 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<T> range(T startInclusive,
                                      T endExclusive)

Description copied from interface: TemporalGeneratorSpec

Generate a temporal value between the given range.

Specified by:

range in interface TemporalGeneratorSpec<T extends Temporal>

Parameters:

startInclusive - start date (inclusive)

endExclusive - end date (exclusive)

Returns:

spec builder