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.feed	Contains classes related to Feed.
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.

Packages with annotations of type ExperimentalApi

Package	Description
org.instancio.feed	Contains classes related to Feed.

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	FeedApi	Interface for configuring Feed instances.
interface	FilterPredicate<T>	A predicate for testing values using the BaseApi.filter(TargetSelector, FilterPredicate) method.
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	InstancioCartesianProductApi<T>	Provides an API for generating the Cartesian product.
interface	InstancioFeedApi<F extends Feed>	An API for customising the properties of a Feed.
interface	InstancioGenApi	A shorthand API for generating value types, such as strings, numbers, dates, etc.
interface	IntervalSupplier<T>	A supplier of start and end interval values.
interface	RandomFunction<T,R>	A function that accepts an argument and produces a randomised result.
interface	RandomUnaryOperator<T>	Represents a unary operator that produces a result of the same type as its operand.
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
R	RandomFunction.apply(T input, Random random)	Applies this function to the given input.
T	RandomUnaryOperator.apply(T input, Random random)	Applies this operator to the given operand, using the provided Random instance.
BaseApi<T>	BaseApi.applyFeed(TargetSelector selector, Feed feed)	Applies the provided feed to the specified selector.
BaseApi<T>	BaseApi.applyFeed(TargetSelector selector, FeedProvider provider)	Creates a feed and applies it to the specified selector.
InstancioApi<T>	InstancioApi.applyFeed(TargetSelector selector, Feed feed)	Applies the provided feed to the specified selector.
InstancioApi<T>	InstancioApi.applyFeed(TargetSelector selector, FeedProvider provider)	Creates a feed and applies it to the specified selector.
InstancioCartesianProductApi<T>	InstancioCartesianProductApi.applyFeed(TargetSelector selector, Feed feed)	Applies the provided feed to the specified selector.
InstancioCartesianProductApi<T>	InstancioCartesianProductApi.applyFeed(TargetSelector selector, FeedProvider provider)	Creates a feed and applies it to the specified selector.
default <R> R	InstancioApi.as(Function<T,R> function)	A convenience method for mapping the result (as returned by the InstancioApi.create() method) to another object using a function.
InstancioApi<T>	InstancioApi.assign(Assignment... assignments)	Generates values based on given assignments.
InstancioCartesianProductApi<T>	InstancioCartesianProductApi.assign(Assignment... assignments)	Generates values based on given assignments.
ScopeableSelector	DepthPredicateSelector.atDepth(Predicate<Integer> predicate)	Restricts this selector's targets to a depth that satisfies the given predicate.
GroupableSelector	DepthSelector.atDepth(int depth)	Restricts this selector's targets to the specified depth.
List<T>	InstancioCartesianProductApi.create()	Returns he Cartesian product generated from values specified via the InstancioCartesianProductApi.with(TargetSelector, Object[]) method as a list.
F	InstancioFeedApi.create()	Creates an instance of the feed.
static <T> T	Instancio.createBlank(Class<T> type)	Creates a blank object of the specified class.
static <F extends Feed> F	Instancio.createFeed(Class<F> type)	Creates a feed of the specified type.
FeedApi	FeedApi.dataAccess(FeedDataAccess feedDataAccess)	Specifies the data access mode for the feed (sequential or random).
Supplier<T>	IntervalSupplier.end()	Returns a supplier that produces interval end value.
<V> BaseApi<T>	BaseApi.filter(TargetSelector selector, FilterPredicate<V> predicate)	Filters generated values using given predicate.
<V> InstancioApi<T>	InstancioApi.filter(TargetSelector selector, FilterPredicate<V> predicate)	Filters generated values using given predicate.
<V> InstancioCartesianProductApi<T>	InstancioCartesianProductApi.filter(TargetSelector selector, FilterPredicate<V> predicate)	Filters generated values using given predicate.
FeedApi	FeedApi.formatOptions(FormatOptionsProvider provider)	Specifies the data format options of a Feed, for example:
InstancioFeedApi<F>	InstancioFeedApi.formatOptions(FormatOptionsProvider provider)	Specifies the data format options of a Feed, for example:
FeedApi	FeedApi.formatType(FeedFormatType feedFormatType)	Specifies the data format type for the feed, such as CSV (by default) or JSON, for example:
InstancioFeedApi<F>	InstancioFeedApi.formatType(FeedFormatType feedFormatType)	Specifies the data format type for the feed, such as CSV (by default) or JSON, for example:
static InstancioGenApi	Instancio.gen()	A shorthand API for generating simple value types, such as strings, numbers, dates, etc.
<V> InstancioApi<T>	InstancioApi.generate(TargetSelector selector, GeneratorSpec<V> spec)	Customises values using arbitrary generator specs.
<V> InstancioCartesianProductApi<T>	InstancioCartesianProductApi.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 <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.
static <T> InstancioClassApi<T>	Instancio.ofBlank(Class<T> type)	Builder version of the Instancio.createBlank(Class) method that allows customisation of generated values.
static <T> InstancioCartesianProductApi<T>	Instancio.ofCartesianProduct(Class<T> type)	Generates the Cartesian product based on the values specified via the with() method.
static <T> InstancioCartesianProductApi<T>	Instancio.ofCartesianProduct(Model<T> model)	Generates the Cartesian product based on the values specified via the with() method.
static <T> InstancioCartesianProductApi<T>	Instancio.ofCartesianProduct(TypeTokenSupplier<T> typeToken)	Generates the Cartesian product based on the values specified via the with() method.
static <F extends Feed> InstancioFeedApi<F>	Instancio.ofFeed(Class<F> type)	Builder version of Instancio.createFeed(Class) that allows customising the feed's properties.
FeedApi	FeedApi.onDataEnd(FeedDataEndAction feedDataEndAction)	Specifies the action to take when the end of the data feed is reached.
static Scope	Select.scope(PredicateSelector selector)	Creates a scope from the given predicate selector.
BaseApi<T>	BaseApi.setBlank(TargetSelector selector)	Specifies that a blank object should be generated for the selected target.
InstancioApi<T>	InstancioApi.setBlank(TargetSelector selector)	Specifies that a blank object should be generated for the selected target.
InstancioCartesianProductApi<T>	InstancioCartesianProductApi.setBlank(TargetSelector selector)	Specifies that a blank object should be generated for the selected target.
<V> BaseApi<T>	BaseApi.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> InstancioCartesianProductApi<T>	InstancioCartesianProductApi.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.
Supplier<T>	IntervalSupplier.start()	Returns a supplier that produces interval start value.
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> InstancioCartesianProductApi<T>	InstancioCartesianProductApi.with(TargetSelector selector, V... values)	Sets a range of values for generating the Cartesian product.
InstancioFeedApi<F>	InstancioFeedApi.withDataSource(DataSourceProvider provider)	Specifies the data source for a Feed, for example:
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.
<V> InstancioFeedApi<F>	InstancioFeedApi.withSetting(SettingKey<V> key, V value)	Overrides the setting for the given key with the specified value.
<V> InstancioGenApi	InstancioGenApi.withSetting(SettingKey<V> key, V value)	Overrides the setting for the given key with the specified value.
InstancioFeedApi<F>	InstancioFeedApi.withSettings(Settings settings)	Merges the specified Settings with the current settings, allowing for the addition and update of settings.
InstancioGenApi	InstancioGenApi.withSettings(Settings settings)	Merges the specified Settings with the current settings, allowing for the addition and update of settings.
FeedApi	FeedApi.withTagKey(String tagKey)	Specifies the tag key for filtering records in the data feed.
InstancioFeedApi<F>	InstancioFeedApi.withTagKey(String tagKey)	Specifies the tag key for filtering records in the data feed.
FeedApi	FeedApi.withTagValue(String tagValue)	Specifies the tag value of the records to fetch.
InstancioFeedApi<F>	InstancioFeedApi.withTagValue(String tagValue)	Specifies the tag value of the records to fetch.
BaseApi<T>	BaseApi.withUnique(TargetSelector selector)	Specifies that the given selector's target(s) should have unique values.
InstancioApi<T>	InstancioApi.withUnique(TargetSelector selector)	Specifies that the given selector's target(s) should have unique values.
InstancioCartesianProductApi<T>	InstancioCartesianProductApi.withUnique(TargetSelector selector)	Specifies that the given selector's target(s) should have unique values.

Uses of ExperimentalApi in org.instancio.feed

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

Modifier and Type	Interface	Description
interface	DataSource	A data source for specs defined by a Feed.
interface	DataSourceProvider	Provides a DataSource using the specified DataSourceProvider.DataSourceFactory.
static interface	DataSourceProvider.DataSourceFactory	Creates DataSource objects from various underlying sources.
interface	Feed	This interface provides support for using data from external sources (such as CSV or JSON files) and enables the following use cases: Generating values using methods defined by a feed. Populating values via the generate() method. Mapping feed data to an object using applyFeed(). Using a feed instance as a parameterized test argument.
static @interface	Feed.DataAccess	Specifies the data access strategy to be used by a feed.
static @interface	Feed.FormatType	Annotation for specifying the data format type for a feed.
static @interface	Feed.Source	An annotation for specifying data for a Feed.
static @interface	Feed.TagKey	Annotation for specifying a property to use as a tag key in a data feed.
interface	FeedProvider	Provider interface for building Feed instances.
static interface	FeedProvider.FeedBuilderFactory	Factory for building instances of a Feed.
interface	FeedSpec<T>	The return type for spec methods declared by a Feed.
(package private) interface	FeedSpecAccessors	Defines built-in accessors for a Feed.
interface	FeedSpecAnnotations	Defines annotations that can be used with FeedSpec methods.
static @interface	FeedSpecAnnotations.DataSpec	Allows mapping a property name from an external data source to a spec method in a Feed.
static @interface	FeedSpecAnnotations.FunctionSpec	A spec that is derived from one or more other specs.
static @interface	FeedSpecAnnotations.GeneratedSpec	A feed spec that is generated by a Generator.
static @interface	FeedSpecAnnotations.NullableSpec	Specifies that the annotated spec method can generate null values.
static @interface	FeedSpecAnnotations.TemplateSpec	A template spec is for producing string values based on a string template with inputs provided by other specs.
static @interface	FeedSpecAnnotations.WithPostProcessor	This annotation allows specifying one or more PostProcessor classes for processing values returned by the annotated spec method.
static @interface	FeedSpecAnnotations.WithStringMapper	Annotation to specify a custom Function to be used for converting string values to a specified type.
interface	FormatOptionsProvider	Provides a FormatOptionsProvider.FormatOptions using the specified FormatOptionsProvider.FormatOptionsFactory.
static interface	FormatOptionsProvider.FormatOptions	Marker interface for supported data formats.
static interface	FormatOptionsProvider.FormatOptions.CsvFormatOptions	Interface for configuring CSV data format options.
static interface	FormatOptionsProvider.FormatOptionsFactory	Creates FormatOptionsProvider.FormatOptions objects for supported data format types.
interface	FunctionProvider	A marker interface for classes that provide a method for handling FeedSpecAnnotations.FunctionSpec.
interface	PostProcessor<T>	An interface for applying additional processing to data returned by a spec method of a Feed.

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

Modifier and Type	Method	Description
FormatOptionsProvider.FormatOptions.CsvFormatOptions	FormatOptionsProvider.FormatOptions.CsvFormatOptions.commentPrefix(String commentPrefix)	Sets the comment prefix (lines starting with this prefix will be treated as comments); default value is "#".
default FormatOptionsProvider.FormatOptions.CsvFormatOptions	FormatOptionsProvider.FormatOptionsFactory.csv()	Allows specifying configuration options for parsing CSV files.
FormatOptionsProvider.FormatOptions.CsvFormatOptions	FormatOptionsProvider.FormatOptions.CsvFormatOptions.delimiter(char delimiter)	Sets the delimiter character; default value is ','.
DataSource	DataSourceProvider.get(DataSourceProvider.DataSourceFactory factory)	Gets a DataSource from the given factory.
FeedApi	FeedProvider.get(FeedProvider.FeedBuilderFactory feed)	Configures a Feed instance using the specified builder.
FormatOptionsProvider.FormatOptions	FormatOptionsProvider.get(FormatOptionsProvider.FormatOptionsFactory factory)	Configures format options using the given factory.
InputStream	DataSource.getInputStream()	Returns an input stream containing the data for a Feed.
default String	DataSource.getName()	Returns the name of this data source, if applicable (for example, file name).
default <F extends Feed> FeedApi	FeedProvider.FeedBuilderFactory.of(Class<F> feedClass)	Creates a feed instance of the specified feed class.
default DataSource	DataSourceProvider.DataSourceFactory.ofFile(Path path)	Creates a data source for the given path.
default FeedApi	FeedProvider.FeedBuilderFactory.ofFile(Path path)	Creates a feed instance for the specified file path.
default DataSource	DataSourceProvider.DataSourceFactory.ofInputStream(InputStream inputStream)	Creates a data source for the given inputStream.
default FeedApi	FeedProvider.FeedBuilderFactory.ofInputStream(InputStream inputStream)	Creates a feed instance for the specified input stream.
default DataSource	DataSourceProvider.DataSourceFactory.ofResource(String name)	Creates a data source for the given resource name.
default FeedApi	FeedProvider.FeedBuilderFactory.ofResource(String name)	Creates a feed instance for the specified classpath resource.
default DataSource	DataSourceProvider.DataSourceFactory.ofString(String data)	Creates a data source from the given data string.
default FeedApi	FeedProvider.FeedBuilderFactory.ofString(String data)	Creates a feed instance with the given data.
T	PostProcessor.process(T input, Random random)	Processes the given input value.
FormatOptionsProvider.FormatOptions.CsvFormatOptions	FormatOptionsProvider.FormatOptions.CsvFormatOptions.trim(FeedDataTrim feedDataTrim)	Specifies whether values should be trimmed of whitespace.

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	IntervalSpec<T>	Spec for generating intervals of various types, such as numeric and temporal values.
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.
interface	ShuffleSpec<T>	Spec for shuffling elements in a random order, providing the results as a Collection.

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.
IntervalSpec<T>	IntervalSpec.nextEnd(RandomUnaryOperator<T> nextEndFn)	Specifies the function for calculating the end value of the interval based on the start value of the current interval.
IntervalSpec<T>	IntervalSpec.nextStart(RandomUnaryOperator<T> nextStartFn)	Specifies the function for calculating the start value of the next interval based on the end value of the current interval.
StringGeneratorSpec	StringGeneratorSpec.numericSequence()	Generates a string sequence that starts from "1" and increments by one.
BigDecimalGeneratorSpec	BigDecimalGeneratorSpec.precision(int precision)	Precision of the generated BigDecimal.
BigDecimalSpec	BigDecimalSpec.precision(int precision)	Precision of the generated BigDecimal.
ShuffleSpec<T>	ShuffleSpec.shuffle(Collection<T> collection)	Creates a copy of the specified collection and shuffles its elements.
ShuffleSpec<T>	ShuffleSpec.shuffle(T... array)	Creates a copy of the specified array and shuffles its elements.
StringGeneratorSpec	StringGeneratorSpec.unicode(Character.UnicodeBlock... blocks)	Generates a Unicode string that consists of random code points excluding the following character types: Character.PRIVATE_USE Character.SURROGATE Character.UNASSIGNED
StringSpec	StringSpec.unicode(Character.UnicodeBlock... blocks)	Generates a Unicode string that consists of random code points excluding the following character types: Character.PRIVATE_USE Character.SURROGATE Character.UNASSIGNED

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 to a selector's target.
<T> IntervalSpec<T>	ValueSpecs.intervalStarting(T startingValue)	A spec for generating intervals of various types, such as numeric and temporal values.
<T> ShuffleSpec<T>	ValueSpecs.shuffle(Collection<T> collection)	Creates a copy of the specified collection and shuffles its elements.
<T> ShuffleSpec<T>	ValueSpecs.shuffle(T... array)	Creates a copy of the specified array and shuffles its elements.

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.
enum	FeedDataAccess	Specifies how Feed data is accessed.
enum	FeedDataEndAction	This setting is only applicable if Keys.FEED_DATA_ACCESS is set to FeedDataAccess.SEQUENTIAL.
enum	FeedDataTrim	Enumeration representing the options for trimming data in a feed.
enum	FeedFormatType	Enumeration of data format types supported by the Feed.Source annotation.
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.
enum	StringCase	A setting that specifies the case of generated strings.
enum	StringType	A setting that specifies the type of String to generate.

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<FeedDataAccess>	Keys.FEED_DATA_ACCESS	Specifies whether Feed data is retrieved sequentially or randomly; default is FeedDataAccess.SEQUENTIAL; property name feed.data.access.
static final SettingKey<FeedDataEndAction>	Keys.FEED_DATA_END_ACTION	Specifies the behaviour when Feed end of data has been reached (only applicable if Keys.FEED_DATA_ACCESS is set to FeedDataAccess.SEQUENTIAL); default is FeedDataEndAction.FAIL; property name feed.data.end.action.
static final SettingKey<FeedDataTrim>	Keys.FEED_DATA_TRIM	Specifies the trimming mode for feed data; default is FeedDataTrim.UNQUOTED; property name feed.data.trim.
static final SettingKey<FeedFormatType>	Keys.FEED_FORMAT_TYPE	Specifies the feed format type; default is FeedFormatType.CSV; property name feed.format.type.
static final SettingKey<String>	Keys.FEED_TAG_KEY	Specifies the tag key for a Feed; default is null; property name feed.tag.key.
static final SettingKey<String>	Keys.FEED_TAG_VALUE	Specifies the default tag value for a Feed; default is null (includes all tags); property name feed.tag.value.
static final SettingKey<Integer>	Keys.INSTANCIO_SOURCE_SAMPLES	Specifies the number of samples for the @InstancioSource annotation from the instancio-junit module; default is 100; property name instancio.source.samples.
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<Integer>	Keys.MAX_GENERATION_ATTEMPTS	The maximum number of attempts to generate an object for a given node; default is 1000; property name max.generation.attempts.
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.
static final SettingKey<StringCase>	Keys.STRING_CASE	Specifies the case of generated strings; default is StringCase.UPPER; property name string.case.
static final SettingKey<StringType>	Keys.STRING_TYPE	Specifies the String type to generate; default is StringType.ALPHABETIC; property name string.type.

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.