Uses of Interface
org.instancio.settings.SettingKey

Packages that use SettingKey

Package	Description
org.instancio.internal	Contains internal classes implementing the core functionality of Instancio.
org.instancio.internal.settings	Contains internal classes related to settings.
org.instancio.settings	Provides classes for overriding settings at runtime.

Uses of SettingKey in org.instancio.internal

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

Modifier and Type	Method	Description
static void	ApiValidator.validateKeyValue(@Nullable SettingKey<?> key, @Nullable Object value)

Uses of SettingKey in org.instancio.internal.settings

Classes in org.instancio.internal.settings that implement SettingKey

Modifier and Type	Class	Description
final class	InternalKey<T>

Methods in org.instancio.internal.settings that return SettingKey

Modifier and Type	Method	Description
SettingKey<T>	InternalKey.InternalKeyBuilder.create()

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

Modifier and Type	Method	Description
<T extends Number & Comparable<T>> void	RangeAdjuster.adjustRange(Settings settings, SettingKey<T> key, T otherValue)	Adjust given key based on otherValue.
<T extends Number & Comparable<T>> void	RangeAdjuster.ForMax.adjustRange(Settings settings, SettingKey<T> maxSetting, T newMin)
<T extends Number & Comparable<T>> void	RangeAdjuster.ForMin.adjustRange(Settings settings, SettingKey<T> minSetting, T newMax)
int	InternalKey.compareTo(SettingKey<T> o)
<T> T	InternalSettings.get(@NotNull SettingKey<T> key)
<T> InternalSettings	InternalSettings.set(@NotNull SettingKey<T> key, T 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 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<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<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.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<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<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<Boolean>	Keys.OVERWRITE_EXISTING_VALUES	Specifies whether initialised fields are allowed to be overwritten; 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<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<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.

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(@NotNull SettingKey<T> key)	Get setting value for given key.
<T> Settings	Settings.set(@NotNull SettingKey<T> key, T value)	Set the setting with the given key to the specified value.