Package org.instancio

Interface InstancioGenApi

All Superinterfaces:

CommonGeneratorSpecs, SettingsApi, ValueSpecs

@ExperimentalApi
public interface InstancioGenApi
extends SettingsApi, ValueSpecs

A shorthand API for generating value types, such as strings, numbers, dates, etc.

Since:

5.0.0

Method Summary

Modifier and Type	Method	Description
<V> InstancioGenApi	withSetting(SettingKey<V> key, V value)	Overrides the setting for the given key with the specified value.
InstancioGenApi	withSettings(Settings settings)	Merges the specified Settings with the current settings, allowing for the addition and update of settings.

Methods inherited from interface org.instancio.generators.ValueSpecs

booleans, bytes, chars, checksum, doubles, enumOf, finance, floats, hash, id, intervalStarting, ints, intSeq, io, longs, longSeq, math, net, nio, oneOf, oneOf, shorts, shuffle, shuffle, spatial, string, temporal, text, uuid

Method Details

withSettings

@ExperimentalApi
InstancioGenApi withSettings(Settings settings)

Merges the specified Settings with the current settings, allowing for the addition and update of settings.

Use this method to apply custom settings to override the default ones. The provided settings will be combined with the existing settings, updating any overlapping values and adding any new ones.

Specified by:

withSettings in interface SettingsApi

Parameters:

settings - the custom settings to merge with the current settings

Returns:

API builder reference

Since:

5.0.0

See Also:

• Keys
• SettingsApi.withSetting(SettingKey, Object)

withSetting

@ExperimentalApi
<V> InstancioGenApi withSetting(SettingKey<V> key,
 V value)

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

Specified by:

withSetting in interface SettingsApi

Type Parameters:

V - the setting value type

Parameters:

key - the setting key to override

value - the setting value

Returns:

API builder reference

Since:

5.0.0

See Also:

• Keys
• SettingsApi.withSettings(Settings)