Uses of Interface org.instancio.settings.SettingKey (Instancio Core 5.0.2 API)

Packages that use SettingKey

Package

Description

org.instancio

Instancio public-facing APIs; for usage examples see Instancio.

org.instancio.settings

Provides classes for overriding settings at runtime.

Uses of SettingKey in org.instancio

Methods in org.instancio with parameters of type SettingKey

Modifier and Type

Method

Description

<V> InstancioApi<T>

InstancioApi.withSetting(SettingKey<V> key, V value)

Overrides the setting for the given key with the specified value.

<V> InstancioCartesianProductApi<T>

InstancioCartesianProductApi.withSetting(SettingKey<V> key, V value)

Overrides the setting for the given key with the specified value.

<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.

<V> SettingsApi

SettingsApi.withSetting(SettingKey<V> key, V value)

Overrides the setting for the given key with the specified value.
Uses of SettingKey in org.instancio.settings

Fields in org.instancio.settings declared as SettingKey

Modifier and Type

Field

Description

static final SettingKey<AfterGenerate>

Keys.AFTER_GENERATE_HINT

Specifies the default value of the AfterGenerate hint supplied from custom generators to the engine; default is AfterGenerate.POPULATE_NULLS_AND_DEFAULT_PRIMITIVES; property name hint.after.generate.

static final SettingKey<Boolean>

Keys.ARRAY_ELEMENTS_NULLABLE

Specifies whether a null can be generated for array elements; default is false; property name array.elements.nullable.

static final SettingKey<Integer>

Keys.ARRAY_MAX_LENGTH

Specifies maximum length for arrays; default is 6; property name array.max.length.

static final SettingKey<Integer>

Keys.ARRAY_MIN_LENGTH

Specifies minimum length for arrays; default is 2; property name array.min.length.

static final SettingKey<Boolean>

Keys.ARRAY_NULLABLE

Specifies whether a null can be generated for arrays; default is false; property name array.nullable.

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.BOOLEAN_NULLABLE

Specifies whether a null can be generated for Boolean type; default is false; property name boolean.nullable.

static final SettingKey<Byte>

Keys.BYTE_MAX

Specifies maximum value for bytes; default is 127; property name byte.max.

static final SettingKey<Byte>

Keys.BYTE_MIN

Specifies minimum value for bytes; default is 1; property name byte.min.

static final SettingKey<Boolean>

Keys.BYTE_NULLABLE

Specifies whether a null can be generated for Byte type; default is false; property name byte.nullable.

static final SettingKey<Boolean>

Keys.CHARACTER_NULLABLE

Specifies whether a null can be generated for Character type; default is false; property name character.nullable.

static final SettingKey<Boolean>

Keys.COLLECTION_ELEMENTS_NULLABLE

Specifies whether a null can be generated for collection elements; default is false; property name collection.elements.nullable.

static final SettingKey<Integer>

Keys.COLLECTION_MAX_SIZE

Specifies maximum size for collections; default is 6; property name collection.max.size.

static final SettingKey<Integer>

Keys.COLLECTION_MIN_SIZE

Specifies minimum size for collections; default is 2; property name collection.min.size.

static final SettingKey<Boolean>

Keys.COLLECTION_NULLABLE

Specifies whether a null can be generated for collections; default is false; property name collection.nullable.

static final SettingKey<Double>

Keys.DOUBLE_MAX

Specifies maximum value for doubles; default is 10000; property name double.max.

static final SettingKey<Double>

Keys.DOUBLE_MIN

Specifies minimum value for doubles; default is 1; property name double.min.

static final SettingKey<Boolean>

Keys.DOUBLE_NULLABLE

Specifies whether a null can be generated for Double type; default is false; property name double.nullable.

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<Float>

Keys.FLOAT_MAX

Specifies maximum value for floats; default is 10000; property name float.max.

static final SettingKey<Float>

Keys.FLOAT_MIN

Specifies minimum value for floats; default is 1; property name float.min.

static final SettingKey<Boolean>

Keys.FLOAT_NULLABLE

Specifies whether a null can be generated for Float type; default is false; property name float.nullable.

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<Integer>

Keys.INTEGER_MAX

Specifies maximum value for integers; default is 10000; property name integer.max.

static final SettingKey<Integer>

Keys.INTEGER_MIN

Specifies minimum value for integers; default is 1; property name integer.min.

static final SettingKey<Boolean>

Keys.INTEGER_NULLABLE

Specifies whether a null can be generated for Integer type; default is false; property name integer.nullable.

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<Long>

Keys.LONG_MAX

Specifies maximum value for longs; default is 10000; property name long.max.

static final SettingKey<Long>

Keys.LONG_MIN

Specifies minimum value for longs; default is 1; property name long.min.

static final SettingKey<Boolean>

Keys.LONG_NULLABLE

Specifies whether a null can be generated for Long type; default is false; property name long.nullable.

static final SettingKey<Boolean>

Keys.MAP_KEYS_NULLABLE

Specifies whether a null can be generated for map keys; default is false; property name map.keys.nullable.

static final SettingKey<Integer>

Keys.MAP_MAX_SIZE

Specifies maximum size for maps; default is 6; property name map.max.size.

static final SettingKey<Integer>

Keys.MAP_MIN_SIZE

Specifies minimum size for maps; default is 2; property name map.min.size.

static final SettingKey<Boolean>

Keys.MAP_NULLABLE

Specifies whether a null can be generated for maps; default is false; property name map.nullable.

static final SettingKey<Boolean>

Keys.MAP_VALUES_NULLABLE

Specifies whether a null can be generated for map values; default is false; property name map.values.nullable.

static final SettingKey<Integer>

Keys.MAX_DEPTH

Specifies the maximum depth of the generated object tree; default is 8; property name max.depth.

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<Mode>

Keys.MODE

Specifies the mode: strict (unused selectors will trigger an exception) or lenient; default is Mode.STRICT; property name mode.

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.OVERWRITE_EXISTING_VALUES

Specifies whether initialised fields can be overwritten by the engine to random values; default is true; property name overwrite.existing.values.

static final SettingKey<Long>

Keys.SEED

Specifies the seed value; default is null; property name seed.

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<Short>

Keys.SHORT_MAX

Specifies maximum value for shorts; default is 10000; property name short.max.

static final SettingKey<Short>

Keys.SHORT_MIN

Specifies minimum value for shorts; default is 1; property name short.min.

static final SettingKey<Boolean>

Keys.SHORT_NULLABLE

Specifies whether a null can be generated for Short type; default is false; property name short.nullable.

static final SettingKey<Boolean>

Keys.STRING_ALLOW_EMPTY

Specifies whether an empty string can be generated; default is false; property name string.allow.empty.

static final SettingKey<StringCase>

Keys.STRING_CASE

Specifies the case of generated strings; default is StringCase.UPPER; property name string.case.

static final SettingKey<Boolean>

Keys.STRING_FIELD_PREFIX_ENABLED

Specifies whether generated Strings should be prefixed with field names; default is false; property name string.field.prefix.enabled.

static final SettingKey<Integer>

Keys.STRING_MAX_LENGTH

Specifies maximum length of strings; default is 10; property name string.max.length.

static final SettingKey<Integer>

Keys.STRING_MIN_LENGTH

Specifies minimum length of strings; default is 3; property name string.min.length.

static final SettingKey<Boolean>

Keys.STRING_NULLABLE

Specifies whether a null can be generated for String type; default is false; property name string.nullable.

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 that return SettingKey

Modifier and Type

Method

Description

SettingKey<T>

SettingKey.SettingKeyBuilder.create()

Returns the created setting key.

static <T> SettingKey<T>

Keys.get(@NotNull String key)

Returns a SettingKey instance with the given property key.

Methods in org.instancio.settings that return types with arguments of type SettingKey

Modifier and Type

Method

Description

static List<SettingKey<Object>>

Keys.all()

Returns all keys supported by Instancio.

Methods in org.instancio.settings with parameters of type SettingKey

Modifier and Type

Method

Description

<T> T

Settings.get(SettingKey<T> key)

Get setting value for given key.

<T> Settings

Settings.set(SettingKey<T> key, T value)

Set the setting with the given key to the specified value.

Uses of Interfaceorg.instancio.settings.SettingKey

Uses of SettingKey in org.instancio

Uses of SettingKey in org.instancio.settings

Uses of Interface
org.instancio.settings.SettingKey