Package org.instancio.internal.generator.time

Class DurationGenerator

java.lang.Object

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

org.instancio.internal.generator.time.DurationGenerator

All Implemented Interfaces:

Generator<Duration>, GeneratorSpec<Duration>, DurationGeneratorSpec, DurationSpec, NullableGeneratorSpec<Duration>, ValueSpec<Duration>

public class DurationGenerator
extends AbstractGenerator<Duration>
implements DurationSpec

Constructor Summary

Constructors

Constructor	Description
DurationGenerator()
DurationGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
DurationGenerator	allowZero()	Allow a Duration of length zero to be generated.
String	apiMethod()	Returns the public API method name of the generator spec.
DurationGenerator	max(long amount, TemporalUnit unit)	Generate a Duration less than or equal to the specified amount.
DurationGenerator	min(long amount, TemporalUnit unit)	Generate a Duration greater than or equal to the specified amount.
DurationGenerator	nullable()	Indicates that null value can be generated.
DurationGenerator	of(long minAmount, long maxAmount, TemporalUnit unit)	Generate a Duration in the given range, measured in specified units.
protected Duration	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.ValueSpec

get, list, map, stream, toModel

Constructor Details

DurationGenerator

public DurationGenerator()

DurationGenerator

public DurationGenerator(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<Duration>

Returns:

spec name if defined, or null otherwise

min

public DurationGenerator min(long amount,
 TemporalUnit unit)

Description copied from interface: DurationGeneratorSpec

Generate a Duration greater than or equal to the specified amount.

Specified by:

min in interface DurationGeneratorSpec

Specified by:

min in interface DurationSpec

Parameters:

amount - minimum duration amount (inclusive)

unit - unit the amount is measured in

Returns:

spec builder

max

public DurationGenerator max(long amount,
 TemporalUnit unit)

Description copied from interface: DurationGeneratorSpec

Generate a Duration less than or equal to the specified amount.

Specified by:

max in interface DurationGeneratorSpec

Specified by:

max in interface DurationSpec

Parameters:

amount - maximum duration amount (inclusive)

unit - unit the amount is measured in

Returns:

spec builder

of

public DurationGenerator of(long minAmount,
 long maxAmount,
 TemporalUnit unit)

Description copied from interface: DurationGeneratorSpec

Generate a Duration in the given range, measured in specified units.

Specified by:

of in interface DurationGeneratorSpec

Specified by:

of in interface DurationSpec

Parameters:

minAmount - minimum duration amount (inclusive)

maxAmount - maximum duration amount (inclusive)

unit - unit the amount is measured in

Returns:

spec builder

allowZero

public DurationGenerator allowZero()

Description copied from interface: DurationGeneratorSpec

Allow a Duration of length zero to be generated.

Specified by:

allowZero in interface DurationGeneratorSpec

Specified by:

allowZero in interface DurationSpec

Returns:

spec builder

nullable

public DurationGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<Duration>

Specified by:

nullable in interface ValueSpec<Duration>

Overrides:

nullable in class AbstractGenerator<Duration>

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null