Package org.instancio.internal.generator.time

Class MonthDayGenerator

java.lang.Object

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

org.instancio.internal.generator.time.MonthDayGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<MonthDay>, Generator<MonthDay>, GeneratorSpec<MonthDay>, AsGeneratorSpec<MonthDay>, MonthDayGeneratorSpec, NullableGeneratorSpec<MonthDay>

public class MonthDayGenerator
extends AbstractGenerator<MonthDay>
implements MonthDayGeneratorSpec

Constructor Summary

Constructors

Constructor	Description
MonthDayGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
MonthDayGeneratorSpec	max(MonthDay max)	Generate a MonthDay value on or before the specified day.
MonthDayGeneratorSpec	min(MonthDay min)	Generate a MonthDay value on or after the specified day.
MonthDayGeneratorSpec	range(MonthDay min, MonthDay max)	Generate a MonthDay value between the given range.
protected MonthDay	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, 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

Constructor Details

MonthDayGenerator

public MonthDayGenerator(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<MonthDay>

Returns:

spec name if defined, or null otherwise

min

public MonthDayGeneratorSpec min(MonthDay min)

Description copied from interface: MonthDayGeneratorSpec

Generate a MonthDay value on or after the specified day.

Specified by:

min in interface MonthDayGeneratorSpec

Parameters:

min - lower bound

Returns:

spec builder

max

public MonthDayGeneratorSpec max(MonthDay max)

Description copied from interface: MonthDayGeneratorSpec

Generate a MonthDay value on or before the specified day.

Specified by:

max in interface MonthDayGeneratorSpec

Parameters:

max - upper bound

Returns:

spec builder

range

public MonthDayGeneratorSpec range(MonthDay min,
 MonthDay max)

Description copied from interface: MonthDayGeneratorSpec

Generate a MonthDay value between the given range.

Specified by:

range in interface MonthDayGeneratorSpec

Parameters:

min - lower bound (inclusive)

max - upper bound (inclusive)

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null