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.generator	Contains classes related to generators.
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	Assign	A collection of static factory methods for creating assignments.
interface	Assignment	An assignment that can be passed to the InstancioApi.assign(Assignment...) method.
interface	CartesianProductApi<T>	Provides an API for generating the Cartesian product.
final class	Gen	Class for generating simple value types, such as strings, numbers, dates, and so on.
interface	GivenOrigin	Represents an origin selector of a conditional assignment.
interface	GivenOriginDestination	Represents an origin and a destination of a conditional assigment.
interface	GivenOriginDestinationAction	Defines optional methods that can be chained to Assign.given(TargetSelector) builder expression.
interface	GivenOriginPredicate	Defines methods one of which follow the Assign.given(TargetSelector) builder expressions to create an assignment.
interface	GivenOriginPredicateAction	Defines optional methods that can be chained to Assign.given(TargetSelector, TargetSelector) builder expression.
interface	ValueOf	Value of a target selector of an assignment.
interface	ValueOfOriginDestination	An assigment containing origin and destination selectors.
interface	ValueOfOriginDestinationPredicate	An assigment containing origin and destination selectors, and a predicate that the origin value must satisfy for the assignment to be applied.
final class	When	Provides convenience methods for creating Predicates.

Methods in org.instancio with annotations of type ExperimentalApi

Modifier and Type	Method	Description
CartesianProductApi<T>	CartesianProductApi.assign(Assignment... assignments)	Generates values based on given assignments.
InstancioApi<T>	InstancioApi.assign(Assignment... assignments)	Generates values based on given assignments.
ScopeableSelector	DepthPredicateSelector.atDepth(Predicate<Integer> predicate)	Restricts this selector's target(s) to a depth that satisfies the given predicate.
GroupableSelector	DepthSelector.atDepth(int depth)	Restricts this selector's target(s) to the specified depth.
<V> CartesianProductApi<T>	CartesianProductApi.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises values using arbitrary generator specs.
<V> InstancioApi<T>	InstancioApi.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises values using arbitrary generator specs.
static <T> GivenOrigin	Assign.given(Class<T> origin)	Creates a conditional assignment for a given origin type.
static <T, R> GivenOrigin	Assign.given(GetMethodSelector<T,R> origin)	Creates a conditional assignment for a given origin method reference and one or more destination selectors.
static GivenOrigin	Assign.given(TargetSelector origin)	Creates a conditional for a given origin and one or more destination selectors.
static GivenOriginDestination	Assign.given(TargetSelector origin, TargetSelector destination)	Creates a conditional assigment for a given pair of origin and destination selectors.
static NumericSequenceSpec<Integer>	Gen.intSeq()	Generates Integer sequences.
static <T> Predicate<T>	When.is(T value)	A predicate that returns true if values are equal using Objects.equals(Object, Object).
static <T> Predicate<T>	When.isIn(T... values)	A predicate that checks whether a value is equal to any element in the values array using Objects.equals(Object, Object).
static <T> Predicate<T>	When.isNot(T value)	A predicate that returns true if values are not equal using Objects.equals(Object, Object).
static <T> Predicate<T>	When.isNotNull()	A predicate that checks if a value is not null.
static <T> Predicate<T>	When.isNull()	A predicate that checks if a value is null.
List<T>	CartesianProductApi.list()	Returns he Cartesian product generated from values specified via the CartesianProductApi.with(TargetSelector, Object[]) method as a list.
static NumericSequenceSpec<Long>	Gen.longSeq()	Generates Long sequences.
static <T> CartesianProductApi<T>	Instancio.ofCartesianProduct(Class<T> type)	Generates the Cartesian product based on the values specified via the with() method.
static <T> CartesianProductApi<T>	Instancio.ofCartesianProduct(Model<T> model)	Generates the Cartesian product based on the values specified via the with() method.
static <T> CartesianProductApi<T>	Instancio.ofCartesianProduct(TypeTokenSupplier<T> typeToken)	Generates the Cartesian product based on the values specified via the with() method.
static Scope	Select.scope(PredicateSelector selector)	Creates a scope from the given predicate selector.
<V> CartesianProductApi<T>	CartesianProductApi.setModel(TargetSelector selector, Model<V> model)	Applies given model to the specified selector.
<V> InstancioApi<T>	InstancioApi.setModel(TargetSelector selector, Model<V> model)	Applies given model to the specified selector.
<V> InstancioOperations<T>	InstancioOperations.setModel(TargetSelector selector, Model<V> model)	Applies given model to the specified selector.
static Selector	Select.setter(Class<?> declaringClass, String methodName)	Selects a setter method by name in the specified class.
static Selector	Select.setter(Class<?> declaringClass, String methodName, Class<?> parameterType)	Selects a setter method by name and parameter type in the specified class.
static Selector	Select.setter(String methodName)	Selects a setter by name declared in the class being created.
static <T, U> Selector	Select.setter(SetMethodSelector<T,U> methodReference)	Selects a setter method based on the given method reference.
Scope	FieldSelectorBuilder.toScope()	Scope representation of a selector.
Scope	PredicateSelector.toScope()	Scope representation of a selector.
Scope	TypeSelectorBuilder.toScope()	Scope representation of a selector.
static <T> ValueOf	Assign.valueOf(Class<T> target)	Creates an assignment for a given target type.
static <T, R> ValueOf	Assign.valueOf(GetMethodSelector<T,R> target)	Creates an assignment for a given target method reference.
static ValueOf	Assign.valueOf(TargetSelector target)	Creates an assignment builder with a given target selector.
InstancioApi<T>	InstancioApi.verbose()	Outputs debug information to System.out.
<V> CartesianProductApi<T>	CartesianProductApi.with(TargetSelector selector, V... values)	Sets a range of values for generating the Cartesian product.
GroupableSelector	FieldSelectorBuilder.within(Scope... scopes)	Specifies the scope for this selector in order to narrow down its target.
GroupableSelector	PredicateSelector.within(Scope... scopes)	Specifies the scope for this selector in order to narrow down its target.
GroupableSelector	TypeSelectorBuilder.within(Scope... scopes)	Specifies the scope for this selector in order to narrow down its target.

Uses of ExperimentalApi in org.instancio.generator

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

Modifier and Type	Method	Description
default void	Generator.init(GeneratorContext context)	An optional method for generators that need to initialise state before generating values.

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.
interface	NumericSequenceAsGeneratorSpec<T extends Number & Comparable<T>>	A spec for generating numeric sequences that supports AsGeneratorSpec.
interface	NumericSequenceGeneratorSpec<T extends Number & Comparable<T>>	A spec for generating numeric sequences.
interface	NumericSequenceSpec<T extends Number & Comparable<T>>	Spec for generating numeric sequences.

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.
BigDecimalAsGeneratorSpec	BigDecimalAsGeneratorSpec.precision(int precision)	Precision of the generated BigDecimal.
BigDecimalGeneratorSpec	BigDecimalGeneratorSpec.precision(int precision)	Precision of the generated BigDecimal.
BigDecimalSpec	BigDecimalSpec.precision(int precision)	Precision of the generated BigDecimal.

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.
NumericSequenceAsGeneratorSpec<Integer>	Generators.intSeq()	An Integer sequence generator.
NumericSequenceAsGeneratorSpec<Long>	Generators.longSeq()	A Long sequence generator.

Uses of ExperimentalApi in org.instancio.settings

Classes in org.instancio.settings 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	BeanValidationTarget	A setting that specifies whether Bean Validation annotations are declared on fields or getters.
final class	MethodModifier	A class containing modifier constants.
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.
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 whether to assign values 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<BeanValidationTarget>	Keys.BEAN_VALIDATION_TARGET	Specifies whether Bean Validation annotations are declared on fields or getters; default is BeanValidationTarget.FIELD; property name bean.validation.target.
static final SettingKey<Integer>	Keys.BIG_DECIMAL_SCALE	Specifies the scale for generating BigDecimal; default is 2; property name bigdecimal.scale.
static final SettingKey<Boolean>	Keys.FAIL_ON_ERROR	Specifies whether internal exceptions should be propagated up; default is false; property name fail.on.error.
static final SettingKey<Boolean>	Keys.JPA_ENABLED	Specifies whether values should be generated based on JPA annotations, such as @Column.length; default is false; property name jpa.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<OnSetMethodUnmatched>	Keys.ON_SET_METHOD_UNMATCHED	Specifies what should happen if a setter without a matching field is encountered; default is OnSetMethodUnmatched.IGNORE; property name on.set.method.unmatched.
static final SettingKey<Boolean>	Keys.SET_BACK_REFERENCES	Specifies whether back references should be set for cyclic classes; default is false (cycles are terminated with null); property name set.back.references.
static final SettingKey<Integer>	Keys.SETTER_EXCLUDE_MODIFIER	Specifies modifier exclusions for setter-methods; default is 0 (no exclusions); property name setter.exclude.modifier.
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
static interface	InstancioServiceProvider.AnnotationProcessor	Allows customising generated values based on annotations.
static @interface	InstancioServiceProvider.AnnotationProcessor.AnnotationHandler	Denotes a method for handling annotations.
static interface	InstancioServiceProvider.SetterMethodResolver	Resolves setter method based on a given node when Keys.ASSIGNMENT_TYPE is set to AssignmentType.METHOD.
interface	ServiceProviderContext	Provides additional information to InstancioServiceProvider.

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

Modifier and Type	Method	Description
default InstancioServiceProvider.AnnotationProcessor	InstancioServiceProvider.getAnnotationProcessor()	Returns an AnnotationProcessor implementation.
Method	InstancioServiceProvider.SetterMethodResolver.getSetter(Node node)	Returns the setter method for the given node.
default InstancioServiceProvider.SetterMethodResolver	InstancioServiceProvider.getSetterMethodResolver()	Returns a SetterMethodResolver implementation.
default void	InstancioServiceProvider.init(ServiceProviderContext context)	An optional method that can be used by implementations that require access to the context information.