Package org.instancio.internal.generator.array

Class OneOfArrayGenerator<T>

java.lang.Object

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

org.instancio.internal.generator.array.OneOfArrayGenerator<T>

All Implemented Interfaces:

Generator<T>, GeneratorSpec<T>, NullableGeneratorSpec<T>, OneOfArrayGeneratorSpec<T>, OneOfArraySpec<T>, ValueSpec<T>

public class OneOfArrayGenerator<T>
extends AbstractGenerator<T>
implements OneOfArraySpec<T>

Constructor Summary

Constructors

Constructor	Description
OneOfArrayGenerator()
OneOfArrayGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
Hints	hints()	Hints provided by the generator to the engine.
OneOfArrayGenerator<T>	nullable()	Indicates that null value can be generated.
OneOfArrayGenerator<T>	oneOf(T... values)	Selects a random value from the given choices.
protected 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, 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.OneOfArraySpec

toModel

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

Constructor Details

OneOfArrayGenerator

public OneOfArrayGenerator()

OneOfArrayGenerator

public OneOfArrayGenerator(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 OneOfArrayGenerator<T> oneOf(T... values)

Description copied from interface: OneOfArrayGeneratorSpec

Selects a random value from the given choices.

Specified by:

oneOf in interface OneOfArrayGeneratorSpec<T>

Specified by:

oneOf in interface OneOfArraySpec<T>

Parameters:

values - from which a random value will be selected

Returns:

completed spec with no further methods

nullable

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

protected 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

hints

public Hints hints()

Description copied from interface: Generator

Hints provided by the generator to the engine.

The most important hint for custom generators is AfterGenerate. This hint indicates whether the object created by this generator:

• should be populated (for example, if it has null fields)
• can be modified using selectors

For example, setting the hint to AfterGenerate.POPULATE_NULLS will cause Instancio to populate null fields on the object returned by this generator:

   @Override
   public Hints hints() {
       return Hints.afterGenerate(AfterGenerate.POPULATE_NULLS);
   }
 

If the action is not specified, default behaviour will be based on the AfterGenerate value configured in the Settings using the key Keys.AFTER_GENERATE_HINT.

In addition, the following hints can be provided for populating data structures:

• ArrayHint
• CollectionHint
• MapHint

Specified by:

hints in interface Generator<T>

Overrides:

hints in class AbstractGenerator<T>

Returns:

hints from this generator to the engine

See Also:

• Hint
• Hints
• AfterGenerate