public interface Settings extends ToXContent
Using ImmutableSettings.settingsBuilder()
in order to create a builder
which in turn can create an immutable implementation of settings.
ImmutableSettings
Modifier and Type | Interface and Description |
---|---|
static interface |
Settings.Builder
A settings builder interface.
|
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
EMPTY_PARAMS
Modifier and Type | Method and Description |
---|---|
String |
get(String setting)
Returns the setting value associated with the setting key.
|
String |
get(String[] settings)
Returns the setting value associated with the first setting key.
|
String |
get(String[] settings,
String defaultValue)
Returns the setting value associated with the first setting key, if none exists,
returns the default value provided.
|
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.
|
String[] |
getAsArray(String settingPrefix,
String[] defaultArray,
Boolean commaDelimited)
The values associated with a setting prefix as an array.
|
Boolean |
getAsBoolean(String[] settings,
Boolean defaultValue)
Returns the setting value (as boolean) associated with the setting key.
|
Boolean |
getAsBoolean(String setting,
Boolean defaultValue)
Returns the setting value (as boolean) associated with the setting key.
|
ByteSizeValue |
getAsBytesSize(String[] settings,
ByteSizeValue defaultValue)
Returns the setting value (as size) associated with the setting key.
|
ByteSizeValue |
getAsBytesSize(String setting,
ByteSizeValue defaultValue)
Returns the setting value (as size) associated with the setting key.
|
<T> Class<? extends T> |
getAsClass(String setting,
Class<? extends T> defaultClazz)
Returns the setting value (as a class) associated with the setting key.
|
<T> Class<? extends T> |
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[] settings,
Double defaultValue)
Returns the setting value (as double) associated with teh first setting key, if none
exists, returns the default value provided.
|
Double |
getAsDouble(String setting,
Double defaultValue)
Returns the setting value (as double) associated with the setting key.
|
Float |
getAsFloat(String[] settings,
Float defaultValue)
Returns the setting value (as float) associated with teh first setting key, if none
exists, returns the default value provided.
|
Float |
getAsFloat(String setting,
Float defaultValue)
Returns the setting value (as float) associated with the setting key.
|
Integer |
getAsInt(String[] settings,
Integer defaultValue)
Returns the setting value (as int) associated with the first setting key.
|
Integer |
getAsInt(String setting,
Integer defaultValue)
Returns the setting value (as int) associated with the setting key.
|
Long |
getAsLong(String[] settings,
Long defaultValue)
Returns the setting value (as long) 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 flat
Map . |
ByteSizeValue |
getAsMemory(String[] setting,
String defaultValue)
Returns the setting value (as size) associated with the setting key.
|
ByteSizeValue |
getAsMemory(String setting,
String defaultValue)
Returns the setting value (as size) associated with the setting key.
|
RatioValue |
getAsRatio(String[] settings,
String defaultValue)
Returns the setting value (as a RatioValue) associated with the setting key.
|
RatioValue |
getAsRatio(String setting,
String defaultValue)
Returns the setting value (as a RatioValue) associated with the setting key.
|
Settings |
getAsSettings(String setting)
Returns the settings mapped to the given setting name.
|
SizeValue |
getAsSize(String[] settings,
SizeValue defaultValue)
Returns the setting value (as size) associated with the setting key.
|
SizeValue |
getAsSize(String setting,
SizeValue defaultValue)
Returns the setting value (as size) associated with the setting key.
|
Map<String,Object> |
getAsStructuredMap()
The settings as a structured
Map . |
TimeValue |
getAsTime(String[] settings,
TimeValue defaultValue)
Returns the setting value (as time) 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)
Returns 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.
|
Map<String,Settings> |
getGroups(String settingPrefix,
boolean ignoreNonGrouped)
Returns group settings for the given setting prefix.
|
Set<String> |
names() |
String |
toDelimitedString(char delimiter)
Returns the settings as delimited string.
|
toXContent
Settings getComponentSettings(Class component)
Settings getComponentSettings(String prefix, Class component)
Settings getByPrefix(String prefix)
Settings getAsSettings(String setting)
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 keyString get(String setting, String defaultValue)
String get(String[] settings, String defaultValue)
Map<String,Settings> getGroups(String settingPrefix) throws SettingsException
SettingsException
Map<String,Settings> getGroups(String settingPrefix, boolean ignoreNonGrouped) throws SettingsException
SettingsException
Float getAsFloat(String setting, Float defaultValue) throws SettingsException
SettingsException
Float getAsFloat(String[] settings, Float defaultValue) throws SettingsException
SettingsException
Double getAsDouble(String setting, Double defaultValue) throws SettingsException
SettingsException
Double getAsDouble(String[] settings, Double defaultValue) throws SettingsException
SettingsException
Integer getAsInt(String setting, Integer defaultValue) throws SettingsException
SettingsException
Integer getAsInt(String[] settings, Integer defaultValue) throws SettingsException
SettingsException
Long getAsLong(String setting, Long defaultValue) throws SettingsException
SettingsException
Long getAsLong(String[] settings, Long defaultValue) throws SettingsException
SettingsException
Boolean getAsBoolean(String setting, Boolean defaultValue) throws SettingsException
SettingsException
Boolean getAsBoolean(String[] settings, Boolean defaultValue) throws SettingsException
SettingsException
TimeValue getAsTime(String setting, TimeValue defaultValue) throws SettingsException
SettingsException
TimeValue getAsTime(String[] settings, TimeValue defaultValue) throws SettingsException
SettingsException
ByteSizeValue getAsBytesSize(String setting, ByteSizeValue defaultValue) throws SettingsException
SettingsException
ByteSizeValue getAsBytesSize(String[] settings, ByteSizeValue defaultValue) throws SettingsException
SettingsException
ByteSizeValue getAsMemory(String setting, String defaultValue) throws SettingsException
SettingsException
ByteSizeValue getAsMemory(String[] setting, String defaultValue) throws SettingsException
SettingsException
RatioValue getAsRatio(String setting, String defaultValue) throws SettingsException
SettingsException
RatioValue getAsRatio(String[] settings, String defaultValue) throws SettingsException
SettingsException
SizeValue getAsSize(String setting, SizeValue defaultValue) throws SettingsException
SettingsException
SizeValue getAsSize(String[] settings, SizeValue defaultValue) throws SettingsException
SettingsException
<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 settingNoClassSettingsException
- 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 isNoClassSettingsException
- Failure to load the classString[] getAsArray(String settingPrefix, String[] defaultArray, Boolean commaDelimited) 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 bydefaultArray
- The default array to use if no value is specifiedcommaDelimited
- Whether to try to parse a string as a comma-delimited valueSettingsException
String[] getAsArray(String settingPrefix, String[] defaultArray) throws SettingsException
If commaDelimited is true, it will automatically load a comma separated list under the settingPrefix and merge with the numbered format.
settingPrefix
- The setting prefix to load the array bySettingsException
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 bySettingsException
Version getAsVersion(String setting, Version defaultVersion) throws SettingsException
SettingsException
String toDelimitedString(char delimiter)
Copyright © 2009–2015. All rights reserved.