Package org.instancio.internal.generator

Class InternalGeneratorHint

java.lang.Object

org.instancio.internal.generator.InternalGeneratorHint

All Implemented Interfaces:

Hint<InternalGeneratorHint>

@InternalApi
public final class InternalGeneratorHint
extends Object
implements Hint<InternalGeneratorHint>

Internal hint related to Generators.

This class is not part of the public API.

Since:

2.0.0

See Also:

• Hints
• Generator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InternalGeneratorHint.Builder

Method Summary

Modifier and Type	Method	Description
static InternalGeneratorHint.Builder	builder()
boolean	emitNull()	Indicates whether a null value was generated by emit().
boolean	excludeFromCallbacks()	A hint indicating whether the generated object should be excluded from onComplete callbacks.
boolean	isDelegating()	A hint indicating whether a generator delegates instantiation to another generator.
boolean	nullableResult()	Indicates whether the value to generate is nullable.
Class<?>	targetClass()	A hint indicating the type of object to generate.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.instancio.generator.Hint

type

Method Details

targetClass

public Class<?> targetClass()

A hint indicating the type of object to generate.

Some generators may request a specific type to generate. For example, collection generators may accept types via subtype() method.

Returns:

target class

Since:

2.0.0

isDelegating

public boolean isDelegating()

A hint indicating whether a generator delegates instantiation to another generator. This occurs when the generator does not have enough information to determine which type to instantiate.

Returns:

true a generator is delegating, false otherwise

Since:

2.0.0

excludeFromCallbacks

public boolean excludeFromCallbacks()

A hint indicating whether the generated object should be excluded from onComplete callbacks.

Returns:

true if callbacks should not be invoked on generated object

Since:

2.0.0

nullableResult

public boolean nullableResult()

Indicates whether the value to generate is nullable.

Returns:

true if null is allowed to be generated

Since:

2.0.0

emitNull

public boolean emitNull()

Indicates whether a null value was generated by emit(). This tells the engine to permit the null value to be added to a collection/map, which normally requires CollectionHint.nullableElements() (and similarly for MapHint) to be set.

Returns:

true if null was generated by emit()

Since:

2.12.0

toString

public String toString()

Overrides:

toString in class Object

builder

public static InternalGeneratorHint.Builder builder()