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>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the public API method name of the generator spec.hints()
Hints provided by the generator to the engine.nullable()
Indicates thatnull
value can be generated.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
-
Constructor Details
-
OneOfArrayGenerator
public OneOfArrayGenerator() -
OneOfArrayGenerator
-
-
Method Details
-
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 classAbstractGenerator<T>
- Returns:
- spec name if defined, or
null
otherwise
-
oneOf
Description copied from interface:OneOfArrayGeneratorSpec
Selects a random value from the given choices.- Specified by:
oneOf
in interfaceOneOfArrayGeneratorSpec<T>
- Specified by:
oneOf
in interfaceOneOfArraySpec<T>
- Parameters:
values
- from which a random value will be selected- Returns:
- completed spec with no further methods
-
nullable
Description copied from interface:NullableGeneratorSpec
Indicates thatnull
value can be generated.- Specified by:
nullable
in interfaceNullableGeneratorSpec<T>
- Specified by:
nullable
in interfaceValueSpec<T>
- Overrides:
nullable
in classAbstractGenerator<T>
- Returns:
- spec builder
-
tryGenerateNonNull
Description copied from class:AbstractGenerator
Makes the best effort to return a non-null value. However, in certain cases this method will produce anull
.- Specified by:
tryGenerateNonNull
in classAbstractGenerator<T>
- Parameters:
random
- for generating the value- Returns:
- generated value, either a null or non-null
-
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 populatenull
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 theSettings
using the keyKeys.AFTER_GENERATE_HINT
.In addition, the following hints can be provided for populating data structures:
- should be populated (for example, if it has
-