Package org.instancio.internal.generator.util

Class EnumSetGenerator<E extends Enum<E>>

java.lang.Object

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

org.instancio.internal.generator.util.EnumSetGenerator<E>

All Implemented Interfaces:

Generator<EnumSet<E>>, GeneratorSpec<EnumSet<E>>, EnumSetGeneratorSpec<E>, NullableGeneratorSpec<EnumSet<E>>

public class EnumSetGenerator<E extends Enum<E>>
extends AbstractGenerator<EnumSet<E>>
implements EnumSetGeneratorSpec<E>

Constructor Summary

Constructors

Constructor	Description
EnumSetGenerator(GeneratorContext context)
EnumSetGenerator(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 EnumSetGeneratorSpec<E>	excluding(E... elements)	Specifies enum values to exclude from the generated EnumSet.
Hints	hints()	Hints provided by the generator to the engine.
EnumSetGeneratorSpec<E>	maxSize(int size)	Maximum size of EnumSet to generate.
EnumSetGeneratorSpec<E>	minSize(int size)	Minimum size of EnumSet to generate.
final EnumSetGeneratorSpec<E>	of(E... elements)	Specifies choices from which the EnumSet will be generated.
EnumSetGeneratorSpec<E>	size(int size)	Size of EnumSet to generate.
protected EnumSet<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, nullable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnumSetGenerator

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

EnumSetGenerator

public EnumSetGenerator(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<EnumSet<E extends Enum<E>>>

Returns:

spec name if defined, or null otherwise

size

public EnumSetGeneratorSpec<E> size(int size)

Description copied from interface: EnumSetGeneratorSpec

Size of EnumSet to generate.

Specified by:

size in interface EnumSetGeneratorSpec<E extends Enum<E>>

Parameters:

size - of EnumSet

Returns:

spec builder

minSize

public EnumSetGeneratorSpec<E> minSize(int size)

Description copied from interface: EnumSetGeneratorSpec

Minimum size of EnumSet to generate.

Specified by:

minSize in interface EnumSetGeneratorSpec<E extends Enum<E>>

Parameters:

size - minimum size (inclusive)

Returns:

spec builder

maxSize

public EnumSetGeneratorSpec<E> maxSize(int size)

Description copied from interface: EnumSetGeneratorSpec

Maximum size of EnumSet to generate.

Specified by:

maxSize in interface EnumSetGeneratorSpec<E extends Enum<E>>

Parameters:

size - maximum size (inclusive)

Returns:

spec builder

of

@SafeVarargs
public final EnumSetGeneratorSpec<E> of(E... elements)

Description copied from interface: EnumSetGeneratorSpec

Specifies choices from which the EnumSet will be generated.

Specified by:

of in interface EnumSetGeneratorSpec<E extends Enum<E>>

Parameters:

elements - from which the enum set will be generated

Returns:

spec builder

excluding

@SafeVarargs
public final EnumSetGeneratorSpec<E> excluding(E... elements)

Description copied from interface: EnumSetGeneratorSpec

Specifies enum values to exclude from the generated EnumSet.

Specified by:

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

Parameters:

elements - to excluding from the generated enum set

Returns:

spec builder

tryGenerateNonNull

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

Returns:

hints from this generator to the engine

See Also:

• Hint
• Hints
• AfterGenerate