Package org.instancio.generator

Class Hints

java.lang.Object

org.instancio.generator.Hints

public final class Hints
extends Object

Hints are provided by Generator implementations to the engine to support more flexibility in how objects are populated.

Since:

2.0.0

See Also:

• AfterGenerate
• Generator
• Hint

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Hints.Builder	Builder for constructing Hints.

Method Summary

Modifier and Type	Method	Description
AfterGenerate	afterGenerate()	Returns the after generate action to be performed by the engine.
static Hints	afterGenerate(AfterGenerate afterGenerate)	Returns an instance of hints containing the specified AfterGenerate value.
static Hints.Builder	builder()	Returns an instance of the builder.
static Hints.Builder	builder(Hints copy)
<T extends Hint<T>> T	get(Class<T> hintType)	Returns a hint with the specified type.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

afterGenerate

public static Hints afterGenerate(AfterGenerate afterGenerate)

Returns an instance of hints containing the specified AfterGenerate value.

Parameters:

afterGenerate - the action to be performed after generate

Returns:

an instance containing a single hint AfterGenerate.POPULATE_NULLS

Since:

2.0.0

See Also:

• AfterGenerate

builder

public static Hints.Builder builder(Hints copy)

afterGenerate

public AfterGenerate afterGenerate()

Returns the after generate action to be performed by the engine.

Returns:

after generate action to perform

Since:

2.0.0

See Also:

• AfterGenerate

get

public <T extends Hint<T>> T get(Class<T> hintType)

Returns a hint with the specified type.

Type Parameters:

T - hint type

Parameters:

hintType - type of the hint

Returns:

hint with the specified type, or null if none found

Since:

2.0.0

builder

public static Hints.Builder builder()

Returns an instance of the builder.

Returns:

builder

toString

public String toString()

Overrides:

toString in class Object