Uses of Annotation Type
org.instancio.documentation.ExperimentalApi

Packages that use ExperimentalApi

Package	Description
org.instancio	Instancio public-facing APIs; for usage examples see Instancio.
org.instancio.assignment	Contains classes for configuring how generated values get assigned.
org.instancio.generator.specs	Defines generator specs.
org.instancio.generators	Defines classes that provide access to built-in generators.
org.instancio.settings	Provides classes for overriding settings at runtime.
org.instancio.spi	Defines Service Provider Interfaces for providing custom implementations.

Uses of ExperimentalApi in org.instancio

Classes in org.instancio with annotations of type ExperimentalApi

Modifier and Type	Class	Description
final class	Gen	Class for generating simple value types, such as strings, numbers, dates, and so on.
interface	GetMethodSelector<T,R>	A selector that matches a field using a getter method reference.

Methods in org.instancio with annotations of type ExperimentalApi

Modifier and Type	Method	Description
static <T, R> Selector	Select.field(GetMethodSelector<T,R> methodReference)	Selects a field based on the given method reference.
<V> InstancioApi<T>	InstancioApi.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises values using arbitrary generator specs.

Uses of ExperimentalApi in org.instancio.assignment

Classes in org.instancio.assignment with annotations of type ExperimentalApi

Modifier and Type	Class	Description
enum	AssignmentType	A setting that specifies whether objects should be populated via fields or methods.
enum	OnSetFieldError	A setting that specifies what should happen if an error occurs when setting a field's value.
enum	OnSetMethodError	A setting that specifies what should happen if an error occurs during a setter method invocation.
enum	SetterStyle	Specifies the style of setter to use when AssignmentType.METHOD is enabled.

Uses of ExperimentalApi in org.instancio.generator.specs

Classes in org.instancio.generator.specs with annotations of type ExperimentalApi

Modifier and Type	Interface	Description
interface	CsvGeneratorSpec	Generator spec for producing CSV.
interface	CsvSpec	Spec for generating CSV.
interface	EmitGeneratorSpec<T>	A generator spec that emits given items to a selector's target.

Methods in org.instancio.generator.specs with annotations of type ExperimentalApi

Modifier and Type	Method	Description
GeneratorSpec<T>	PathGeneratorSpec.createDirectory()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a directory in the file system.
GeneratorSpec<T>	PathGeneratorSpec.createFile()	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system.
GeneratorSpec<T>	PathGeneratorSpec.createFile(InputStream content)	Terminal method to indicate that the generated path, including parent directories (if any), should be created as a file in the file system and content provided by the input stream written to the file.

Uses of ExperimentalApi in org.instancio.generators

Methods in org.instancio.generators with annotations of type ExperimentalApi

Modifier and Type	Method	Description
CsvGeneratorSpec	TextGenerators.csv()	Generates CSV.
CsvSpec	TextSpecs.csv()	Generates CSV.
<T> EmitGeneratorSpec<T>	Generators.emit()	Emits provided items.

Uses of ExperimentalApi in org.instancio.settings

Classes in org.instancio.settings with annotations of type ExperimentalApi

Modifier and Type	Interface	Description
static interface	SettingKey.SettingKeyBuilder<T>	A builder for creating custom keys.

Fields in org.instancio.settings with annotations of type ExperimentalApi

Modifier and Type	Field	Description
static final SettingKey<AssignmentType>	Keys.ASSIGNMENT_TYPE	Specifies how to assign values via reflection, using fields or methods; default is AssignmentType.FIELD; property name assignment.type.
static final SettingKey<Boolean>	Keys.BEAN_VALIDATION_ENABLED	Specifies whether values should be generated based on Jakarta Bean Validation 3.0 annotations, if present; default is false; property name bean.validation.api.enabled.
static final SettingKey<OnSetFieldError>	Keys.ON_SET_FIELD_ERROR	Specifies what should happen if an error occurs setting a field's value; default is OnSetFieldError.IGNORE; property name on.set.field.error.
static final SettingKey<OnSetMethodError>	Keys.ON_SET_METHOD_ERROR	Specifies what should happen if an error occurs invoking a setter; default is OnSetMethodError.ASSIGN_FIELD; property name on.set.method.error.
static final SettingKey<OnSetMethodNotFound>	Keys.ON_SET_METHOD_NOT_FOUND	Specifies what should happen if a setter method for a field cannot be resolved; default is OnSetMethodNotFound.ASSIGN_FIELD; property name on.set.method.not.found.
static final SettingKey<SetterStyle>	Keys.SETTER_STYLE	Indicates the naming convention of setter methods to use; default is SetterStyle.SET; property name setter.style.

Methods in org.instancio.settings with annotations of type ExperimentalApi

Modifier and Type	Method	Description
static <T> SettingKey.SettingKeyBuilder<T>	Keys.ofType(Class<T> type)	A builder for creating custom setting keys.

Uses of ExperimentalApi in org.instancio.spi

Classes in org.instancio.spi with annotations of type ExperimentalApi

Modifier and Type	Interface	Description
interface	ServiceProviderContext	Provides additional information to InstancioServiceProvider.

Methods in org.instancio.spi with annotations of type ExperimentalApi

Modifier and Type	Method	Description
default void	InstancioServiceProvider.init(ServiceProviderContext context)	An optional method that can be used by implementations that require access to the context information.