org.elasticsearch.common.settings
Interface Settings

All Known Implementing Classes:

ImmutableSettings

@ThreadSafe
public interface Settings

Immutable settings allowing to control the configuration.

Using ImmutableSettings.settingsBuilder() in order to create a builder which in turn can create an immutable implementation of settings.

See Also:

ImmutableSettings

Nested Class Summary

static interface

Settings.Builder A settings builder interface.

Method Summary

java.lang.String	get(java.lang.String setting) Returns the setting value associated with the setting key.
java.lang.String	get(java.lang.String setting, java.lang.String defaultValue) Returns the setting value associated with the setting key.
java.lang.String[]	getAsArray(java.lang.String settingPrefix) The values associated with a setting prefix as an array.
java.lang.String[]	getAsArray(java.lang.String settingPrefix, java.lang.String[] defaultArray) The values associated with a setting prefix as an array.
java.lang.Boolean	getAsBoolean(java.lang.String setting, java.lang.Boolean defaultValue) Returns the setting value (as boolean) associated with the setting key.
ByteSizeValue	getAsBytesSize(java.lang.String setting, ByteSizeValue defaultValue) Returns the setting value (as size) associated with the setting key.
<T> java.lang.Class<? extends T>	getAsClass(java.lang.String setting, java.lang.Class<? extends T> defaultClazz) Returns the setting value (as a class) associated with the setting key.
<T> java.lang.Class<? extends T>	getAsClass(java.lang.String setting, java.lang.Class<? extends T> defaultClazz, java.lang.String prefixPackage, java.lang.String suffixClassName) Returns the setting value (as a class) associated with the setting key.
java.lang.Double	getAsDouble(java.lang.String setting, java.lang.Double defaultValue) Returns the setting value (as double) associated with the setting key.
java.lang.Float	getAsFloat(java.lang.String setting, java.lang.Float defaultValue) Returns the setting value (as float) associated with the setting key.
java.lang.Integer	getAsInt(java.lang.String setting, java.lang.Integer defaultValue) Returns the setting value (as int) associated with the setting key.
java.lang.Long	getAsLong(java.lang.String setting, java.lang.Long defaultValue) Returns the setting value (as long) associated with the setting key.
java.util.Map<java.lang.String,java.lang.String>	getAsMap() The settings as a Map.
SizeValue	getAsSize(java.lang.String setting, SizeValue defaultValue) Returns the setting value (as size) associated with the setting key.
TimeValue	getAsTime(java.lang.String setting, TimeValue defaultValue) Returns the setting value (as time) associated with the setting key.
Settings	getByPrefix(java.lang.String prefix) A settings that are filtered (and key is removed) with the specified prefix.
java.lang.ClassLoader	getClassLoader() The class loader associated with this settings.
Settings	getComponentSettings(java.lang.Class component) Component settings for a specific component.
Settings	getComponentSettings(java.lang.String prefix, java.lang.Class component) Component settings for a specific component.
Settings	getGlobalSettings() The global settings if these settings are group settings.
java.util.Map<java.lang.String,Settings>	getGroups(java.lang.String settingPrefix) Returns group settings for the given setting prefix.

Method Detail

getGlobalSettings

Settings getGlobalSettings()

The global settings if these settings are group settings.

getComponentSettings

Settings getComponentSettings(java.lang.Class component)

Component settings for a specific component. Returns all the settings for the given class, where the FQN of the class is used, without the org.elasticsearch prefix.

getComponentSettings

Settings getComponentSettings(java.lang.String prefix,
                              java.lang.Class component)

Component settings for a specific component. Returns all the settings for the given class, where the FQN of the class is used, without provided prefix.

getByPrefix

Settings getByPrefix(java.lang.String prefix)

A settings that are filtered (and key is removed) with the specified prefix.

getClassLoader

java.lang.ClassLoader getClassLoader()

The class loader associated with this settings.

getAsMap

java.util.Map<java.lang.String,java.lang.String> getAsMap()

The settings as a Map.

get

java.lang.String get(java.lang.String setting)

Returns the setting value associated with the setting key.

Parameters:

setting - The setting key

Returns:

The setting value, null if it does not exists.

get

java.lang.String get(java.lang.String setting,
                     java.lang.String defaultValue)

Returns the setting value associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The setting value, or the default value if no value exists

getGroups

java.util.Map<java.lang.String,Settings> getGroups(java.lang.String settingPrefix)
                                                   throws SettingsException

Returns group settings for the given setting prefix.

Throws:

SettingsException

getAsFloat

java.lang.Float getAsFloat(java.lang.String setting,
                           java.lang.Float defaultValue)
                           throws SettingsException

Returns the setting value (as float) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (float) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

getAsDouble

java.lang.Double getAsDouble(java.lang.String setting,
                             java.lang.Double defaultValue)
                             throws SettingsException

Returns the setting value (as double) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (double) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

getAsInt

java.lang.Integer getAsInt(java.lang.String setting,
                           java.lang.Integer defaultValue)
                           throws SettingsException

Returns the setting value (as int) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (int) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

getAsLong

java.lang.Long getAsLong(java.lang.String setting,
                         java.lang.Long defaultValue)
                         throws SettingsException

Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (long) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

getAsBoolean

java.lang.Boolean getAsBoolean(java.lang.String setting,
                               java.lang.Boolean defaultValue)
                               throws SettingsException

Returns the setting value (as boolean) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (boolean) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

getAsTime

TimeValue getAsTime(java.lang.String setting,
                    TimeValue defaultValue)
                    throws SettingsException

Returns the setting value (as time) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (time) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

See Also:

TimeValue.parseTimeValue(String, org.elasticsearch.common.unit.TimeValue)

getAsBytesSize

ByteSizeValue getAsBytesSize(java.lang.String setting,
                             ByteSizeValue defaultValue)
                             throws SettingsException

Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (size) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

See Also:

ByteSizeValue.parseBytesSizeValue(String, org.elasticsearch.common.unit.ByteSizeValue)

getAsSize

SizeValue getAsSize(java.lang.String setting,
                    SizeValue defaultValue)
                    throws SettingsException

Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided.

Parameters:

setting - The setting key

defaultValue - The value to return if no value is associated with the setting

Returns:

The (size) value, or the default value if no value exists.

Throws:

SettingsException - Failure to parse the setting

See Also:

ByteSizeValue.parseBytesSizeValue(String, org.elasticsearch.common.unit.ByteSizeValue)

getAsClass

<T> java.lang.Class<? extends T> getAsClass(java.lang.String setting,
                                            java.lang.Class<? extends T> defaultClazz)
                                        throws NoClassSettingsException

Returns the setting value (as a class) associated with the setting key. If it does not exists, returns the default class provided.

Type Parameters:

T - The type of the class

Parameters:

setting - The setting key

defaultClazz - The class to return if no value is associated with the setting

Returns:

The class setting value, or the default class provided is no value exists

Throws:

NoClassSettingsException - Failure to load a class

getAsClass

<T> java.lang.Class<? extends T> getAsClass(java.lang.String setting,
                                            java.lang.Class<? extends T> defaultClazz,
                                            java.lang.String prefixPackage,
                                            java.lang.String suffixClassName)
                                        throws NoClassSettingsException

Returns the setting value (as a class) associated with the setting key. If the value itself fails to represent a loadable class, the value will be appended to the prefixPackage and suffixed with the suffixClassName and it will try to be loaded with it.

Type Parameters:

T - The type of the class

Parameters:

setting - The setting key

defaultClazz - The class to return if no value is associated with the setting

prefixPackage - The prefix package to prefix the value with if failing to load the class as is

suffixClassName - The suffix class name to prefix the value with if failing to load the class as is

Returns:

The class represented by the setting value, or the default class provided if no value exists

Throws:

NoClassSettingsException - Failure to load the class

getAsArray

java.lang.String[] getAsArray(java.lang.String settingPrefix,
                              java.lang.String[] defaultArray)
                              throws SettingsException

The values associated with a setting prefix as an array. The settings array is in the format of: settingPrefix.[index].

Parameters:

settingPrefix - The setting prefix to load the array by

Returns:

The setting array values

Throws:

SettingsException

getAsArray

java.lang.String[] getAsArray(java.lang.String settingPrefix)
                              throws SettingsException

The values associated with a setting prefix as an array. The settings array is in the format of: settingPrefix.[index].

Parameters:

settingPrefix - The setting prefix to load the array by

Returns:

The setting array values

Throws:

SettingsException