Package org.instancio.internal.generator.lang

Class BooleanGenerator

java.lang.Object

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

org.instancio.internal.generator.lang.BooleanGenerator

All Implemented Interfaces:

AsStringGeneratorSpec<Boolean>, Generator<Boolean>, GeneratorSpec<Boolean>, AsGeneratorSpec<Boolean>, BooleanAsGeneratorSpec, BooleanGeneratorSpec, BooleanSpec, NullableGeneratorSpec<Boolean>, ValueSpec<Boolean>

public class BooleanGenerator
extends AbstractGenerator<Boolean>
implements BooleanSpec, BooleanAsGeneratorSpec

Constructor Summary

Constructors

Constructor	Description
BooleanGenerator()
BooleanGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
BooleanGenerator	nullable()	Indicates that null value can be generated.
BooleanGenerator	probability(double probability)	Specifies the probability of generating true.
protected Boolean	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.ValueSpec

get, list, map, stream, toModel

Constructor Details

BooleanGenerator

public BooleanGenerator()

BooleanGenerator

public BooleanGenerator(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<Boolean>

Returns:

spec name if defined, or null otherwise

probability

public BooleanGenerator probability(double probability)

Description copied from interface: BooleanSpec

Specifies the probability of generating true.

Specified by:

probability in interface BooleanAsGeneratorSpec

Specified by:

probability in interface BooleanGeneratorSpec

Specified by:

probability in interface BooleanSpec

Parameters:

probability - of generating true between 0 and 1 inclusive

Returns:

spec builder

nullable

public BooleanGenerator nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface BooleanAsGeneratorSpec

Specified by:

nullable in interface BooleanGeneratorSpec

Specified by:

nullable in interface BooleanSpec

Specified by:

nullable in interface NullableGeneratorSpec<Boolean>

Specified by:

nullable in interface ValueSpec<Boolean>

Overrides:

nullable in class AbstractGenerator<Boolean>

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null