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>, NullableGeneratorSpec<Period>, PeriodGeneratorSpec, PeriodSpec, ValueSpec<Period>

public class PeriodGenerator
extends AbstractGenerator<Period>
implements PeriodSpec

Constructor Summary

Constructors

Constructor	Description
PeriodGenerator()
PeriodGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
PeriodGenerator	days(int min, int max)	Generate number of Period days in the given range.
PeriodGenerator	months(int min, int max)	Generate number of Period months in the given range.
PeriodGenerator	nullable()	Indicates that null value can be generated.
protected Period	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
PeriodGenerator	years(int min, int max)	Generate number of Period years in the given range.

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

init

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Constructor Details

PeriodGenerator

public PeriodGenerator()

PeriodGenerator

public PeriodGenerator(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<Period>

Returns:

spec name if defined, or null otherwise

days

public PeriodGenerator 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

Specified by:

days in interface PeriodSpec

Parameters:

min - minimum number of days (inclusive)

max - maximum number of days (inclusive)

Returns:

spec builder

months

public PeriodGenerator 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

Specified by:

months in interface PeriodSpec

Parameters:

min - minimum number of months (inclusive)

max - maximum number of months (inclusive)

Returns:

spec builder

years

public PeriodGenerator 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

Specified by:

years in interface PeriodSpec

Parameters:

min - minimum number of years (inclusive)

max - maximum number of years (inclusive)

Returns:

spec builder

nullable

public PeriodGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<Period>

Specified by:

nullable in interface ValueSpec<Period>

Overrides:

nullable in class AbstractGenerator<Period>

Returns:

spec builder

tryGenerateNonNull

protected Period 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<Period>

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null