sirius.kernel.settings

Class Settings

java.lang.Object

sirius.kernel.settings.Settings

Direct Known Subclasses:

ExtendedSettings, Extension

public class Settings
extends Object

Provides a wrapper around a Config supplied by typesafe config.

Contains various boilerplate methods to safe- and quickly access the underlying config.

Constructor Summary

Constructors

Constructor and Description
Settings(com.typesafe.config.Config config) Creates a new wrapper for the given config.

Method Summary

Modifier and Type	Method and Description
Value	get(String path) Returns the Value defined for the given key.
com.typesafe.config.Config	getConfig() Provides access to the underlying config object.
com.typesafe.config.Config	getConfig(String key) Returns the sub config available for the given key.
List<? extends com.typesafe.config.Config>	getConfigs(String key) Returns all config objects underneath the given key.
Context	getContext() Returns all values defined in this extension as Context.
int	getInt(String key) Returns the integer value for the given key.
Map<String,String>	getMap(String key) Reads a embedded map.
long	getMilliseconds(String path) Returns the duration in milliseconds defined for the given key.
String	getString(String key) Returns the string for the given key.
List<String>	getStringList(String key)
boolean	injectValueFromConfig(Object target, Field field, String key) Injects the value selected by 'key' out of the given config into the given field of the given target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Settings

public Settings(@Nonnull
                com.typesafe.config.Config config)

Creates a new wrapper for the given config.

Parameters:

config - the config to wrap

Method Detail

getConfig

public com.typesafe.config.Config getConfig()

Provides access to the underlying config object.

Returns:

the underlying config object

get

@Nonnull
public Value get(String path)

Returns the Value defined for the given key.

If this extension doesn't provide a value for this key, but there is an extension with the name default which provides a value, this is used.

If the value in the config file starts with a dollar sign, the value is treated as an i18n key and the returned value will contain the translation for the current language.

Parameters:

path - the access path to retrieve the value

Returns:

the value wrapping the contents for the given path. This will never by null, but might be empty: Value.isNull()

getContext

@Nonnull
public Context getContext()

Returns all values defined in this extension as Context.

Returns:

a context containing all values defined by this extension or the default extension.

getConfig

@Nullable
public com.typesafe.config.Config getConfig(String key)

Returns the sub config available for the given key.

Parameters:

key - name of the sub config to retrieve

Returns:

the sub config for the given key or null if no such config exists.

getConfigs

@Nonnull
public List<? extends com.typesafe.config.Config> getConfigs(String key)

Returns all config objects underneath the given key.

Assume we have the following config:

 test {
     sub {
         a { ... }
         b { ... }
     }
 }
 

Then getConfigs("sub") for the extension "test" would return a list containing a and b wrapped as config.

The name of the config object is available as "id".

The list will be sorted by "priority". If no explicit priority is given, we try to sort elements along their natural order within the file. If multiple files are merged together, the behaviour of this approach is undefined and priority should be used.

Parameters:

key - the path to the config object containing a list of sub object.

Returns:

a list of config objects underneath the given object or an empty list if there are none

getMilliseconds

public long getMilliseconds(String path)

Returns the duration in milliseconds defined for the given key.

If this extension doesn't provide a value for this key, but there is an extension with the name default which provides a value, this is used.

Parameters:

path - the access path to retrieve the value

Returns:

the encoded duration as milliseconds.

Throws:

HandledException - if an invalid value was given in the config

getString

public String getString(String key)

Returns the string for the given key.

Parameters:

key - the key used to lookup the string value

Returns:

the string value stored of the given key

getInt

public int getInt(String key)

Returns the integer value for the given key.

Parameters:

key - the key used to lookup the value

Returns:

the integer value stored in the config or 0 if an invalid value is present

getStringList

public List<String> getStringList(String key)

getMap

public Map<String,String> getMap(String key)

Reads a embedded map.

Parameters:

key - the key of the map to read

Returns:

the map within the config

injectValueFromConfig

public boolean injectValueFromConfig(Object target,
                                     Field field,
                                     String key)

Injects the value selected by 'key' out of the given config into the given field of the given target.

Parameters:

target - the target object to populate

field - the field to fill

key - the key to read

Returns:

true if a value was present and injected, false otherwise