Package org.instancio.generator

Class GeneratorContext

java.lang.Object

org.instancio.generator.GeneratorContext

public final class GeneratorContext
extends Object

Provides additional information, such as settings and a random instance to generators that require it.

Since:

1.0.3

See Also:

• Generator

Constructor Summary

Constructors

Constructor	Description
GeneratorContext(Settings settings, Random random)

Method Summary

Modifier and Type	Method	Description
Settings	getSettings()	Returns a read-only instance of the settings used by Instancio.
Random	random()	Returns the random instance used by Instancio to generate data.

Methods inherited from class java.lang.Object

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

Constructor Details

GeneratorContext

public GeneratorContext(Settings settings,
 Random random)

Method Details

getSettings

public Settings getSettings()

Returns a read-only instance of the settings used by Instancio.

The returned settings includes overrides specified using

• InstancioApi.withSettings(Settings)
• @WithSettings annotation used with InstancioExtension for JUnit 5

Returns:

the settings

Since:

1.0.3

random

public Random random()

Returns the random instance used by Instancio to generate data.

Using this instance ensures that data will be reproducible.

Returns:

the random instance

Since:

1.0.3