Package org.instancio.internal.generator.time

Class LocalDateGenerator

java.lang.Object

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

org.instancio.internal.generator.time.LocalDateGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<LocalDate>, Generator<LocalDate>, GeneratorSpec<LocalDate>, AsGeneratorSpec<LocalDate>, LocalDateSpec, NullableGeneratorSpec<LocalDate>, TemporalAaStringGeneratorSpec<LocalDate>, TemporalGeneratorSpec<LocalDate>, TemporalSpec<LocalDate>, ValueSpec<LocalDate>

public class LocalDateGenerator
extends AbstractGenerator<T>
implements LocalDateSpec

Field Summary

Fields

Modifier and Type	Field	Description
protected LocalDate	max
protected LocalDate	min

Constructor Summary

Constructors

Constructor	Description
LocalDateGenerator()
LocalDateGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
LocalDateGenerator	future()	Generate a value in the future.
LocalDateGenerator	nullable()	Indicates that null value can be generated.
LocalDateGenerator	past()	Generate a value in the past.
LocalDateGenerator	range(LocalDate start, LocalDate end)	Generate a value within the given range.
LocalDate	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

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

Methods inherited from interface org.instancio.generator.Generator

init

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream, toModel

Field Details

min

protected LocalDate min

max

protected LocalDate max

Constructor Details

LocalDateGenerator

public LocalDateGenerator()

LocalDateGenerator

public LocalDateGenerator(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<LocalDate>

Returns:

spec name if defined, or null otherwise

past

public LocalDateGenerator past()

Description copied from interface: TemporalGeneratorSpec

Generate a value in the past.

Specified by:

past in interface LocalDateSpec

Specified by:

past in interface TemporalAaStringGeneratorSpec<LocalDate>

Specified by:

past in interface TemporalGeneratorSpec<LocalDate>

Specified by:

past in interface TemporalSpec<LocalDate>

Returns:

spec builder

future

public LocalDateGenerator future()

Description copied from interface: TemporalGeneratorSpec

Generate a value in the future.

Specified by:

future in interface LocalDateSpec

Specified by:

future in interface TemporalAaStringGeneratorSpec<LocalDate>

Specified by:

future in interface TemporalGeneratorSpec<LocalDate>

Specified by:

future in interface TemporalSpec<LocalDate>

Returns:

spec builder

range

public LocalDateGenerator range(LocalDate start,
 LocalDate end)

Description copied from interface: TemporalGeneratorSpec

Generate a value within the given range.

Specified by:

range in interface LocalDateSpec

Specified by:

range in interface TemporalAaStringGeneratorSpec<LocalDate>

Specified by:

range in interface TemporalGeneratorSpec<LocalDate>

Specified by:

range in interface TemporalSpec<LocalDate>

Parameters:

start - lower bound (inclusive)

end - upper bound (inclusive)

Returns:

spec builder

nullable

public LocalDateGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface LocalDateSpec

Specified by:

nullable in interface NullableGeneratorSpec<LocalDate>

Specified by:

nullable in interface TemporalGeneratorSpec<LocalDate>

Specified by:

nullable in interface TemporalSpec<LocalDate>

Specified by:

nullable in interface ValueSpec<LocalDate>

Overrides:

nullable in class AbstractGenerator<LocalDate>

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null