Package org.instancio.internal.generator.util

Class OneOfCollectionGenerator<T>

java.lang.Object

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

org.instancio.internal.generator.util.OneOfCollectionGenerator<T>

All Implemented Interfaces:

Generator<T>, GeneratorSpec<T>, NullableGeneratorSpec<T>, OneOfCollectionGeneratorSpec<T>, OneOfCollectionSpec<T>, ValueSpec<T>

public class OneOfCollectionGenerator<T>
extends AbstractGenerator<T>
implements OneOfCollectionSpec<T>

Constructor Summary

Constructors

Constructor	Description
OneOfCollectionGenerator()
OneOfCollectionGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
OneOfCollectionGenerator<T>	nullable()	Indicates that null value can be generated.
OneOfCollectionGenerator<T>	oneOf(Collection<T> values)	Selects a random value from the given choices.
T	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.OneOfCollectionSpec

toModel

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

Constructor Details

OneOfCollectionGenerator

public OneOfCollectionGenerator()

OneOfCollectionGenerator

public OneOfCollectionGenerator(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<T>

Returns:

spec name if defined, or null otherwise

oneOf

public OneOfCollectionGenerator<T> oneOf(Collection<T> values)

Description copied from interface: OneOfCollectionGeneratorSpec

Selects a random value from the given choices.

Specified by:

oneOf in interface OneOfCollectionGeneratorSpec<T>

Specified by:

oneOf in interface OneOfCollectionSpec<T>

Parameters:

values - from which a random value will be selected

Returns:

completed spec with no further methods

nullable

public OneOfCollectionGenerator<T> nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface NullableGeneratorSpec<T>

Specified by:

nullable in interface ValueSpec<T>

Overrides:

nullable in class AbstractGenerator<T>

Returns:

spec builder

tryGenerateNonNull

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

Parameters:

random - for generating the value

Returns:

generated value, either a null or non-null