sirius.kernel.settings

Class Extension

java.lang.Object

sirius.kernel.settings.Settings

sirius.kernel.settings.Extension

All Implemented Interfaces:

Comparable<Extension>

public class Extension
extends Settings
implements Comparable<Extension>

Represents an extension loaded via the Settings framework.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT Name of the default entry for an extension
protected String	id
protected static Log	LOG
protected int	priority
protected String	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Extension(String type, String id, com.typesafe.config.ConfigObject configObject, com.typesafe.config.ConfigObject defaultConfig)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Extension o)
boolean	equals(Object o)
Value	get(String path) Returns the Value defined for the given key.
com.typesafe.config.Config	getConfig(String key) Returns the sub config available for the given key.
Context	getContext() Returns all values defined in this extension as Context.
String	getId() Returns the unique ID of this extension
long	getMilliseconds(String path) Returns the duration in milliseconds defined for the given key.
String	getQualifiedName() Returns the complete "dot separated" name like {@code [extension.path].
Value	getRaw(String path) Returns the Value defined for the given key.
String	getType() Returns the type name of the extension
int	hashCode()
boolean	isDefault() Determined if this extension is an artifically created default extension.
Object	make(String classProperty) Creates a new instance of the class which is named in classProperty Tries to lookup the value for classProperty, fetches the corresponding class and creates a new instance for it.
Value	require(String path) Returns the Value defined for the given key or throws a HandledException if no value was found 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.

Methods inherited from class sirius.kernel.settings.Settings

getConfig, getConfigs, getInt, getMap, getString, getStringList, injectValueFromConfig

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final String DEFAULT

Name of the default entry for an extension

See Also:

Constant Field Values

LOG

protected static final Log LOG

priority

protected final int priority

type

protected final String type

id

protected final String id

Constructor Detail

Extension

protected Extension(String type,
                    String id,
                    com.typesafe.config.ConfigObject configObject,
                    com.typesafe.config.ConfigObject defaultConfig)

Method Detail

getRaw

@Nonnull
public Value getRaw(String path)

Returns the Value defined for the given key.

In contrast to get(String) this will not perform an automatic translation if the value starts with a dollar sign.

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()

get

@Nonnull
public Value get(String path)

Description copied from class: Settings

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.

Overrides:

get in class Settings

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()

getConfig

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

Description copied from class: Settings

Returns the sub config available for the given key.

Overrides:

getConfig in class Settings

Parameters:

key - name of the sub config to retrieve

Returns:

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

getContext

@Nonnull
public Context getContext()

Description copied from class: Settings

Returns all values defined in this extension as Context.

Overrides:

getContext in class Settings

Returns:

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

getMilliseconds

public long getMilliseconds(String path)

Description copied from class: Settings

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.

Overrides:

getMilliseconds in class Settings

Parameters:

path - the access path to retrieve the value

Returns:

the encoded duration as milliseconds.

require

@Nonnull
public Value require(String path)

Returns the Value defined for the given key or throws a HandledException if no value was found

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.

Returning a Value instead of a plain object provides lots of conversion methods on the one hand and also guarantees a non null result on the other hand, since a Value can be empty.

Parameters:

path - the access path to retrieve the value

Returns:

the value wrapping the contents for the given path. This will never by null.

Throws:

HandledException - if no value was found for the given path

make

@Nonnull
public Object make(String classProperty)

Creates a new instance of the class which is named in classProperty

Tries to lookup the value for classProperty, fetches the corresponding class and creates a new instance for it.

Returning a Value instead of a plain object provides lots of conversion methods on the one hand and also guarantees a non null result on the other hand, since a Value can be empty.

Parameters:

classProperty - the property which is used to retrieve the class name

Returns:

a new instance of the given class

Throws:

HandledException - if no valid class was given, or if no instance could be created

getType

public String getType()

Returns the type name of the extension

Returns:

the name of the type, this extension was registered for

getId

public String getId()

Returns the unique ID of this extension

Returns:

the map key, used to register this extension

getQualifiedName

public String getQualifiedName()

Returns the complete "dot separated" name like [extension.path].[id]

Returns:

the complete access path used to identify this extension

isDefault

public boolean isDefault()

Determined if this extension is an artifically created default extension.

Returns:

true if this is an artifically created default extension used by ExtendedSettings.getExtension(String, String) if nothing was found

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(@Nullable
                     Extension o)

Specified by:

compareTo in interface Comparable<Extension>