|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
ImmutableSettings
Nested Class Summary | |
---|---|
static interface |
Settings.Builder
A settings builder interface. |
Method Summary | ||
---|---|---|
String |
get(String setting)
Returns the setting value associated with the setting key. |
|
String |
get(String setting,
String defaultValue)
Returns the setting value associated with the setting key. |
|
String[] |
getAsArray(String settingPrefix)
The values associated with a setting prefix as an array. |
|
String[] |
getAsArray(String settingPrefix,
String[] defaultArray)
The values associated with a setting prefix as an array. |
|
Boolean |
getAsBoolean(String setting,
Boolean defaultValue)
Returns the setting value (as boolean) associated with the setting key. |
|
ByteSizeValue |
getAsBytesSize(String setting,
ByteSizeValue defaultValue)
Returns the setting value (as size) associated with the setting key. |
|
|
getAsClass(String setting,
Class<? extends T> defaultClazz)
Returns the setting value (as a class) associated with the setting key. |
|
|
getAsClass(String setting,
Class<? extends T> defaultClazz,
String prefixPackage,
String suffixClassName)
Returns the setting value (as a class) associated with the setting key. |
|
Double |
getAsDouble(String setting,
Double defaultValue)
Returns the setting value (as double) associated with the setting key. |
|
Float |
getAsFloat(String setting,
Float defaultValue)
Returns the setting value (as float) associated with the setting key. |
|
Integer |
getAsInt(String setting,
Integer defaultValue)
Returns the setting value (as int) associated with the setting key. |
|
Long |
getAsLong(String setting,
Long defaultValue)
Returns the setting value (as long) associated with the setting key. |
|
com.google.common.collect.ImmutableMap<String,String> |
getAsMap()
The settings as a Map . |
|
SizeValue |
getAsSize(String setting,
SizeValue defaultValue)
Returns the setting value (as size) associated with the setting key. |
|
TimeValue |
getAsTime(String setting,
TimeValue defaultValue)
Returns the setting value (as time) associated with the setting key. |
|
Version |
getAsVersion(String setting,
Version defaultVersion)
Retruns a parsed version. |
|
Settings |
getByPrefix(String prefix)
A settings that are filtered (and key is removed) with the specified prefix. |
|
ClassLoader |
getClassLoader()
The class loader associated with this settings, or Classes.getDefaultClassLoader()
if not set. |
|
ClassLoader |
getClassLoaderIfSet()
The class loader associated with this settings, but only if explicitly set, otherwise null. |
|
Settings |
getComponentSettings(Class component)
Component settings for a specific component. |
|
Settings |
getComponentSettings(String prefix,
Class component)
Component settings for a specific component. |
|
Map<String,Settings> |
getGroups(String settingPrefix)
Returns group settings for the given setting prefix. |
Method Detail |
---|
Settings getComponentSettings(Class component)
Settings getComponentSettings(String prefix, Class component)
Settings getByPrefix(String prefix)
ClassLoader getClassLoader()
Classes.getDefaultClassLoader()
if not set.
@Nullable ClassLoader getClassLoaderIfSet()
com.google.common.collect.ImmutableMap<String,String> getAsMap()
Map
.
String get(String setting)
setting
- The setting key
String get(String setting, String defaultValue)
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
Map<String,Settings> getGroups(String settingPrefix) throws SettingsException
SettingsException
Float getAsFloat(String setting, Float defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingDouble getAsDouble(String setting, Double defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingInteger getAsInt(String setting, Integer defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingLong getAsLong(String setting, Long defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingBoolean getAsBoolean(String setting, Boolean defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingTimeValue getAsTime(String setting, TimeValue defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingTimeValue.parseTimeValue(String, org.elasticsearch.common.unit.TimeValue)
ByteSizeValue getAsBytesSize(String setting, ByteSizeValue defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingByteSizeValue.parseBytesSizeValue(String, org.elasticsearch.common.unit.ByteSizeValue)
SizeValue getAsSize(String setting, SizeValue defaultValue) throws SettingsException
setting
- The setting keydefaultValue
- The value to return if no value is associated with the setting
SettingsException
- Failure to parse the settingByteSizeValue.parseBytesSizeValue(String, org.elasticsearch.common.unit.ByteSizeValue)
<T> Class<? extends T> getAsClass(String setting, Class<? extends T> defaultClazz) throws NoClassSettingsException
T
- The type of the classsetting
- The setting keydefaultClazz
- The class to return if no value is associated with the setting
NoClassSettingsException
- Failure to load a class<T> Class<? extends T> getAsClass(String setting, Class<? extends T> defaultClazz, String prefixPackage, String suffixClassName) throws NoClassSettingsException
T
- The type of the classsetting
- The setting keydefaultClazz
- The class to return if no value is associated with the settingprefixPackage
- The prefix package to prefix the value with if failing to load the class as issuffixClassName
- The suffix class name to prefix the value with if failing to load the class as is
NoClassSettingsException
- Failure to load the classString[] getAsArray(String settingPrefix, String[] defaultArray) throws SettingsException
It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format.
settingPrefix
- The setting prefix to load the array by
SettingsException
String[] getAsArray(String settingPrefix) throws SettingsException
It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format.
settingPrefix
- The setting prefix to load the array by
SettingsException
Version getAsVersion(String setting, Version defaultVersion) throws SettingsException
SettingsException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |