Package org.instancio.internal.generator.lang

Class EnumGenerator<E extends Enum<E>>

java.lang.Object

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

org.instancio.internal.generator.lang.EnumGenerator<E>

All Implemented Interfaces:

AsStringGeneratorSpec<E>, Generator<E>, GeneratorSpec<E>, AsGeneratorSpec<E>, EnumAsGeneratorSpec<E>, EnumGeneratorSpec<E>, EnumSpec<E>, NullableGeneratorSpec<E>, ValueSpec<E>

public class EnumGenerator<E extends Enum<E>>
extends AbstractGenerator<E>
implements EnumSpec<E>, EnumAsGeneratorSpec<E>

Constructor Summary

Constructors

Constructor	Description
EnumGenerator(Class<E> enumClass)
EnumGenerator(GeneratorContext context, Class<E> enumClass)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
final EnumGenerator<E>	excluding(E... values)	Generate an enum while excluding the specified values.
Hints	hints()	Hints provided by the generator to the engine.
EnumGenerator<E>	nullable()	Indicates that null value can be generated.
protected E	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.AsGeneratorSpec

as, asString

Methods inherited from interface org.instancio.generator.AsStringGeneratorSpec

asString

Methods inherited from interface org.instancio.generator.specs.EnumSpec

toModel

Methods inherited from interface org.instancio.generator.Generator

init

Methods inherited from interface org.instancio.generator.ValueSpec

get, list, map, stream

Constructor Details

EnumGenerator

public EnumGenerator(Class<E> enumClass)

EnumGenerator

public EnumGenerator(GeneratorContext context,
 Class<E> enumClass)

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<E extends Enum<E>>

Returns:

spec name if defined, or null otherwise

excluding

@SafeVarargs
public final EnumGenerator<E> excluding(E... values)

Description copied from interface: EnumSpec

Generate an enum while excluding the specified values. The argument can be an empty array, but not null.

Specified by:

excluding in interface EnumAsGeneratorSpec<E extends Enum<E>>

Specified by:

excluding in interface EnumGeneratorSpec<E extends Enum<E>>

Specified by:

excluding in interface EnumSpec<E extends Enum<E>>

Parameters:

values - to exclude

Returns:

spec builder

nullable

public EnumGenerator<E> nullable()

Description copied from interface: NullableGeneratorSpec

Indicates that null value can be generated.

Specified by:

nullable in interface EnumAsGeneratorSpec<E extends Enum<E>>

Specified by:

nullable in interface EnumGeneratorSpec<E extends Enum<E>>

Specified by:

nullable in interface EnumSpec<E extends Enum<E>>

Specified by:

nullable in interface NullableGeneratorSpec<E extends Enum<E>>

Specified by:

nullable in interface ValueSpec<E extends Enum<E>>

Overrides:

nullable in class AbstractGenerator<E extends Enum<E>>

Returns:

spec builder

tryGenerateNonNull

protected E 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<E extends Enum<E>>

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<E extends Enum<E>>

Overrides:

hints in class AbstractGenerator<E extends Enum<E>>

Returns:

hints from this generator to the engine

See Also:

• Hint
• Hints
• AfterGenerate