Package org.instancio.internal.generator.misc

Class EmitGenerator<T>

java.lang.Object

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

org.instancio.internal.generator.misc.EmitGenerator<T>

All Implemented Interfaces:

Generator<T>, GeneratorSpec<T>, EmitGeneratorSpec<T>, NullableGeneratorSpec<T>

public class EmitGenerator<T>
extends AbstractGenerator<T>
implements EmitGeneratorSpec<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EmitGenerator.WhenEmptyAction

Constructor Summary

Constructors

Constructor	Description
EmitGenerator(GeneratorContext context)

Method Summary

Modifier and Type	Method	Description
String	apiMethod()	Returns the public API method name of the generator spec.
Collection<T>	getItems()
EmitGenerator.WhenEmptyAction	getWhenEmptyAction()
boolean	hasMore()
Hints	hints()	Hints provided by the generator to the engine.
EmitGenerator<T>	ignoreUnused()	Specifies that if any of the provided items were not emitted, they should be ignored (the default is to throw an exception).
boolean	isIgnoreUnused()
EmitGenerator<T>	item(T item, int n)	Emit given item n number of times.
EmitGeneratorSpec<T>	items(Iterable<? extends T> items)	Emit given items.
EmitGenerator<T>	items(T... items)	Emit given items.
EmitGenerator<T>	shuffle()	Specifies that items should be emitted in random order.
protected T	tryGenerateNonNull(Random random)	Makes the best effort to return a non-null value.
EmitGenerator<T>	whenEmptyEmitNull()	Specifies that null should be generated if an insufficient number of items were provided.
EmitGenerator<T>	whenEmptyEmitRandom()	Specifies that a random value should be generated if an insufficient number of items were provided.
EmitGenerator<T>	whenEmptyThrowException()	Specifies that an exception should be raised if an insufficient number of items were provided.

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

Methods inherited from interface org.instancio.generator.Generator

init

Constructor Details

EmitGenerator

public EmitGenerator(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

items

public EmitGenerator<T> items(T... items)

Description copied from interface: EmitGeneratorSpec

Emit given items.

This method can be invoked multiple times to add more items to emit.

Specified by:

items in interface EmitGeneratorSpec<T>

Parameters:

items - to emit, null array is not allowed, but the array itself may contain null elements unless the target is a Map key

Returns:

spec builder

See Also:

• EmitGeneratorSpec.items(Iterable)
• EmitGeneratorSpec.item(Object, int)

items

public EmitGeneratorSpec<T> items(Iterable<? extends T> items)

Description copied from interface: EmitGeneratorSpec

Emit given items.

This method can be invoked multiple times to add more items to emit.

Specified by:

items in interface EmitGeneratorSpec<T>

Parameters:

items - to emit, null iterable is not allowed, but the iterable itself may contain null elements unless the target is a Map key

Returns:

spec builder

See Also:

• EmitGeneratorSpec.items(Object[])
• EmitGeneratorSpec.item(Object, int)

item

public EmitGenerator<T> item(T item,
 int n)

Description copied from interface: EmitGeneratorSpec

Emit given item n number of times.

This method can be invoked multiple times and combined with EmitGeneratorSpec.items(Object[]).

Specified by:

item in interface EmitGeneratorSpec<T>

Parameters:

item - to emit, null allowed unless the target is a Map key

n - number of times the item should be emitted; must not be negative

Returns:

spec builder

See Also:

• EmitGeneratorSpec.items(Object[])
• EmitGeneratorSpec.items(Iterable)

shuffle

public EmitGenerator<T> shuffle()

Description copied from interface: EmitGeneratorSpec

Specifies that items should be emitted in random order.

Specified by:

shuffle in interface EmitGeneratorSpec<T>

Returns:

spec builder

ignoreUnused

public EmitGenerator<T> ignoreUnused()

Description copied from interface: EmitGeneratorSpec

Specifies that if any of the provided items were not emitted, they should be ignored (the default is to throw an exception).

Specified by:

ignoreUnused in interface EmitGeneratorSpec<T>

Returns:

spec builder

whenEmptyEmitNull

public EmitGenerator<T> whenEmptyEmitNull()

Description copied from interface: EmitGeneratorSpec

Specifies that null should be generated if an insufficient number of items were provided.

Specified by:

whenEmptyEmitNull in interface EmitGeneratorSpec<T>

Returns:

spec builder

whenEmptyEmitRandom

public EmitGenerator<T> whenEmptyEmitRandom()

Description copied from interface: EmitGeneratorSpec

Specifies that a random value should be generated if an insufficient number of items were provided.

Specified by:

whenEmptyEmitRandom in interface EmitGeneratorSpec<T>

Returns:

spec builder

whenEmptyThrowException

public EmitGenerator<T> whenEmptyThrowException()

Description copied from interface: EmitGeneratorSpec

Specifies that an exception should be raised if an insufficient number of items were provided.

Specified by:

whenEmptyThrowException in interface EmitGeneratorSpec<T>

Returns:

spec builder

getWhenEmptyAction

public EmitGenerator.WhenEmptyAction getWhenEmptyAction()

hasMore

public boolean hasMore()

getItems

public Collection<T> getItems()

isIgnoreUnused

public boolean isIgnoreUnused()

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