Package org.instancio.internal.generator.time

Class PeriodGenerator

java.lang.Object

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

org.instancio.internal.generator.time.PeriodGenerator

All Implemented Interfaces:

Generator<Period>, GeneratorSpec<Period>, PeriodGeneratorSpec

public class PeriodGenerator
extends AbstractGenerator<Period>
implements PeriodGeneratorSpec

Constructor Summary

Constructors

Constructor	Description
PeriodGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
PeriodGeneratorSpec	days(int min, int max)	Generate number of Period days in the given range.
Period	generate(Random random)	Returns a generated value.
PeriodGeneratorSpec	months(int min, int max)	Generate number of Period months in the given range.
PeriodGeneratorSpec	years(int min, int max)	Generate number of Period years in 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

Constructor Details

PeriodGenerator

public PeriodGenerator(GeneratorContext context)

Method Details

days

public PeriodGeneratorSpec days(int min,
 int max)

Description copied from interface: PeriodGeneratorSpec

Generate number of Period days in the given range.

Specified by:

days in interface PeriodGeneratorSpec

Parameters:

min - minimum number of days (inclusive)

max - maximum number of days (inclusive)

Returns:

spec builder

months

public PeriodGeneratorSpec months(int min,
 int max)

Description copied from interface: PeriodGeneratorSpec

Generate number of Period months in the given range.

Specified by:

months in interface PeriodGeneratorSpec

Parameters:

min - minimum number of months (inclusive)

max - maximum number of months (inclusive)

Returns:

spec builder

years

public PeriodGeneratorSpec years(int min,
 int max)

Description copied from interface: PeriodGeneratorSpec

Generate number of Period years in the given range.

Specified by:

years in interface PeriodGeneratorSpec

Parameters:

min - minimum number of years (inclusive)

max - maximum number of years (inclusive)

Returns:

spec builder

generate

public Period 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.

Specified by:

generate in interface Generator<Period>

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