Package org.instancio.internal.generator.time

Class InstantGenerator

java.lang.Object

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

org.instancio.internal.generator.time.InstantGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<Instant>, Generator<Instant>, GeneratorSpec<Instant>, AsGeneratorSpec<Instant>, InstantSpec, NullableGeneratorSpec<Instant>, TemporalAaStringGeneratorSpec<Instant>, TemporalGeneratorSpec<Instant>, TemporalSpec<Instant>, ValueSpec<Instant>

public class InstantGenerator
extends AbstractGenerator<T>
implements InstantSpec

Field Summary

Fields

Modifier and Type	Field	Description
protected Instant	max
protected Instant	min

Constructor Summary

Constructors

Constructor	Description
InstantGenerator()
InstantGenerator(GeneratorContext context)

Method Summary

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

max

protected Instant max

Constructor Details

InstantGenerator

public InstantGenerator()

InstantGenerator

public InstantGenerator(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<Instant>

Returns:

spec name if defined, or null otherwise

past

public InstantGenerator past()

Description copied from interface: TemporalGeneratorSpec

Generate a value in the past.

Specified by:

past in interface InstantSpec

Specified by:

past in interface TemporalAaStringGeneratorSpec<Instant>

Specified by:

past in interface TemporalGeneratorSpec<Instant>

Specified by:

past in interface TemporalSpec<Instant>

Returns:

spec builder

future

public InstantGenerator future()

Description copied from interface: TemporalGeneratorSpec

Generate a value in the future.

Specified by:

future in interface InstantSpec

Specified by:

future in interface TemporalAaStringGeneratorSpec<Instant>

Specified by:

future in interface TemporalGeneratorSpec<Instant>

Specified by:

future in interface TemporalSpec<Instant>

Returns:

spec builder

range

public InstantGenerator range(Instant start,
 Instant end)

Description copied from interface: TemporalGeneratorSpec

Generate a value within the given range.

Specified by:

range in interface InstantSpec

Specified by:

range in interface TemporalAaStringGeneratorSpec<Instant>

Specified by:

range in interface TemporalGeneratorSpec<Instant>

Specified by:

range in interface TemporalSpec<Instant>

Parameters:

start - lower bound (inclusive)

end - upper bound (inclusive)

Returns:

spec builder

nullable

public InstantGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface InstantSpec

Specified by:

nullable in interface NullableGeneratorSpec<Instant>

Specified by:

nullable in interface TemporalGeneratorSpec<Instant>

Specified by:

nullable in interface TemporalSpec<Instant>

Specified by:

nullable in interface ValueSpec<Instant>

Overrides:

nullable in class AbstractGenerator<Instant>

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null