Package org.instancio.settings
Class Settings
java.lang.Object
org.instancio.settings.Settings
Instancio settings API.
-
Method Summary
Modifier and TypeMethodDescriptionstatic Settings
create()
Create a new instance of empty settings.static Settings
defaults()
Create default settings.static Settings
Create settings from the given map.static Settings
Create settings from the given settings.<T> T
get
(SettingKey key) Get setting value for given key.Returns a read-only view of the subtype map.lock()
Locks these settings for further modifications, making this instance immutable.Map 'from' supertype to 'to' subtype.Creates a new instance of settings by merging given settings with these settings.set
(SettingKey key, Object value) Set setting with given key to the specified value.toString()
-
Method Details
-
create
Create a new instance of empty settings.- Returns:
- empty settings
-
defaults
Create default settings.- Returns:
- settings containing defaults
-
from
Create settings from the given map.- Parameters:
map
- to create settings from- Returns:
- settings
-
from
Create settings from the given settings.- Parameters:
other
- settings to create settings from- Returns:
- a new instance of settings
-
merge
Creates a new instance of settings by merging given settings with these settings.- Parameters:
other
- settings to merge- Returns:
- new instance of merged settings
-
get
Get setting value for given key.- Type Parameters:
T
- setting value type- Parameters:
key
- setting key- Returns:
- value for given key, or
null
if none.
-
set
Set setting with given key to the specified value.- Parameters:
key
- to setvalue
- to set- Returns:
- updated settings
-
mapType
Map 'from' supertype to 'to' subtype.- Parameters:
from
- supertype classto
- subtype class- Returns:
- updated settings
-
getSubtypeMap
Returns a read-only view of the subtype map.- Returns:
- subtype map
-
lock
Locks these settings for further modifications, making this instance immutable.- Returns:
- read-only settings
-
toString
-