ImmutableSettings (elasticsearch 1.7.1 API)

java.lang.Object
- org.elasticsearch.common.settings.ImmutableSettings

All Implemented Interfaces:

Settings, ToXContent
```
public class ImmutableSettings
extends Object
implements Settings
```
An immutable implementation of Settings.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableSettings.Builder` A builder allowing to put different settings and then `ImmutableSettings.Builder.build()` an immutable settings implementation.

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields
Modifier and Type Field and Description

static Settings EMPTY

static String FLAT_SETTINGS_KEY
- Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

Fields
Modifier and Type	Field and Description
`static Settings`	`EMPTY`
`static String`	`FLAT_SETTINGS_KEY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableSettings.Builder`	`builder()`
`boolean`	`equals(Object o)`
`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[] settings, 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.
`int`	`hashCode()`
`Set<String>`	`names()`
`static Settings`	`readSettingsFromStream(StreamInput in)`
`static ImmutableSettings.Builder`	`settingsBuilder()` Returns a builder to be used in order to build settings.
`String`	`toDelimitedString(char delimiter)` Returns the settings as delimited string.
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`static void`	`writeSettingsToStream(Settings settings, StreamOutput out)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final Settings EMPTY
```
  - FLAT_SETTINGS_KEY
```
public static final String FLAT_SETTINGS_KEY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Description copied from interface: Settings
    
    The class loader associated with this settings, or Classes.getDefaultClassLoader() if not set.
    
    Specified by:
    
    getClassLoader in interface Settings
  - getClassLoaderIfSet
```
public ClassLoader getClassLoaderIfSet()
```
    Description copied from interface: Settings
    
    The class loader associated with this settings, but only if explicitly set, otherwise null.
    
    Specified by:
    
    getClassLoaderIfSet in interface Settings
  - getAsMap
```
public com.google.common.collect.ImmutableMap<String,String> getAsMap()
```
    Description copied from interface: Settings
    
    The settings as a flat Map.
    
    Specified by:
    
    getAsMap in interface Settings
  - getAsStructuredMap
```
public Map<String,Object> getAsStructuredMap()
```
    Description copied from interface: Settings
    
    The settings as a structured Map.
    
    Specified by:
    
    getAsStructuredMap in interface Settings
  - getComponentSettings
```
public Settings getComponentSettings(Class component)
```
    Description copied from interface: Settings
    
    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. If there is no org.elasticsearch prefix, then the prefix used is the first part of the package name (org / com / ...)
    Specified by: getComponentSettings in interface Settings
  getComponentSettings public Settings getComponentSettings(String prefix, Class component) Description copied from interface: Settings 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. Specified by: getComponentSettings in interface Settings getByPrefix public Settings getByPrefix(String prefix) Description copied from interface: Settings A settings that are filtered (and key is removed) with the specified prefix. Specified by: getByPrefix in interface Settings getAsSettings public Settings getAsSettings(String setting) Description copied from interface: Settings Returns the settings mapped to the given setting name. Specified by: getAsSettings in interface Settings get public String get(String setting) Description copied from interface: Settings Returns the setting value associated with the setting key. Specified by: get in interface Settings Parameters: setting - The setting key Returns: The setting value, null if it does not exists. get public String get(String[] settings) Description copied from interface: Settings Returns the setting value associated with the first setting key. Specified by: get in interface Settings get public String get(String setting, String defaultValue) Description copied from interface: Settings Returns the setting value associated with the setting key. If it does not exists, returns the default value provided. Specified by: get in interface Settings get public String get(String[] settings, String defaultValue) Description copied from interface: Settings Returns the setting value associated with the first setting key, if none exists, returns the default value provided. Specified by: get in interface Settings getAsFloat public Float getAsFloat(String setting, Float defaultValue) Description copied from interface: Settings Returns the setting value (as float) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsFloat in interface Settings getAsFloat public Float getAsFloat(String[] settings, Float defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as float) associated with teh first setting key, if none exists, returns the default value provided. Specified by: getAsFloat in interface Settings Throws: SettingsException getAsDouble public Double getAsDouble(String setting, Double defaultValue) Description copied from interface: Settings Returns the setting value (as double) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsDouble in interface Settings getAsDouble public Double getAsDouble(String[] settings, Double defaultValue) Description copied from interface: Settings Returns the setting value (as double) associated with teh first setting key, if none exists, returns the default value provided. Specified by: getAsDouble in interface Settings getAsInt public Integer getAsInt(String setting, Integer defaultValue) Description copied from interface: Settings Returns the setting value (as int) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsInt in interface Settings getAsInt public Integer getAsInt(String[] settings, Integer defaultValue) Description copied from interface: Settings Returns the setting value (as int) associated with the first setting key. If it does not exists, returns the default value provided. Specified by: getAsInt in interface Settings getAsLong public Long getAsLong(String setting, Long defaultValue) Description copied from interface: Settings Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsLong in interface Settings getAsLong public Long getAsLong(String[] settings, Long defaultValue) Description copied from interface: Settings Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsLong in interface Settings getAsBoolean public Boolean getAsBoolean(String setting, Boolean defaultValue) Description copied from interface: Settings Returns the setting value (as boolean) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsBoolean in interface Settings getAsBoolean public Boolean getAsBoolean(String[] settings, Boolean defaultValue) Description copied from interface: Settings Returns the setting value (as boolean) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsBoolean in interface Settings getAsTime public TimeValue getAsTime(String setting, TimeValue defaultValue) Description copied from interface: Settings Returns the setting value (as time) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsTime in interface Settings getAsTime public TimeValue getAsTime(String[] settings, TimeValue defaultValue) Description copied from interface: Settings Returns the setting value (as time) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsTime in interface Settings getAsBytesSize public ByteSizeValue getAsBytesSize(String setting, ByteSizeValue defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsBytesSize in interface Settings Throws: SettingsException getAsBytesSize public ByteSizeValue getAsBytesSize(String[] settings, ByteSizeValue defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsBytesSize in interface Settings Throws: SettingsException getAsMemory public ByteSizeValue getAsMemory(String setting, String defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as size) associated with the setting key. Provided values can either be absolute values (intepreted as a number of bytes), byte sizes (eg. 1mb) or percentage of the heap size (eg. 12%). If it does not exists, parses the default value provided. Specified by: getAsMemory in interface Settings Throws: SettingsException getAsMemory public ByteSizeValue getAsMemory(String[] settings, String defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as size) associated with the setting key. Provided values can either be absolute values (intepreted as a number of bytes), byte sizes (eg. 1mb) or percentage of the heap size (eg. 12%). If it does not exists, parses the default value provided. Specified by: getAsMemory in interface Settings Throws: SettingsException getAsRatio public RatioValue getAsRatio(String setting, String defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as a RatioValue) associated with the setting key. Provided values can either be a percentage value (eg. 23%), or expressed as a floating point number (eg. 0.23). If it does not exist, parses the default value provided. Specified by: getAsRatio in interface Settings Throws: SettingsException getAsRatio public RatioValue getAsRatio(String[] settings, String defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as a RatioValue) associated with the setting key. Provided values can either be a percentage value (eg. 23%), or expressed as a floating point number (eg. 0.23). If it does not exist, parses the default value provided. Specified by: getAsRatio in interface Settings Throws: SettingsException getAsSize public SizeValue getAsSize(String setting, SizeValue defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsSize in interface Settings Throws: SettingsException getAsSize public SizeValue getAsSize(String[] settings, SizeValue defaultValue) throws SettingsException Description copied from interface: Settings Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided. Specified by: getAsSize in interface Settings Throws: SettingsException getAsClass public <T> Class<? extends T> getAsClass(String setting, Class<? extends T> defaultClazz) throws NoClassSettingsException Description copied from interface: Settings Returns the setting value (as a class) associated with the setting key. If it does not exists, returns the default class provided. Specified by: getAsClass in interface Settings 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 public <T> Class<? extends T> getAsClass(String setting, Class<? extends T> defaultClazz, String prefixPackage, String suffixClassName) throws NoClassSettingsException Description copied from interface: Settings 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. Specified by: getAsClass in interface Settings 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 public String[] getAsArray(String settingPrefix) throws SettingsException Description copied from interface: Settings The values associated with a setting prefix as an array. The settings array is in the format of: settingPrefix.[index]. It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format. Specified by: getAsArray in interface Settings Parameters: settingPrefix - The setting prefix to load the array by Returns: The setting array values Throws: SettingsException getAsArray public String[] getAsArray(String settingPrefix, String[] defaultArray) throws SettingsException Description copied from interface: Settings The values associated with a setting prefix as an array. The settings array is in the format of: settingPrefix.[index]. If commaDelimited is true, it will automatically load a comma separated list under the settingPrefix and merge with the numbered format. Specified by: getAsArray in interface Settings Parameters: settingPrefix - The setting prefix to load the array by Returns: The setting array values Throws: SettingsException getAsArray public String[] getAsArray(String settingPrefix, String[] defaultArray, Boolean commaDelimited) throws SettingsException Description copied from interface: Settings The values associated with a setting prefix as an array. The settings array is in the format of: settingPrefix.[index]. It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format. Specified by: getAsArray in interface Settings Parameters: settingPrefix - The setting prefix to load the array by defaultArray - The default array to use if no value is specified commaDelimited - Whether to try to parse a string as a comma-delimited value Returns: The setting array values Throws: SettingsException getGroups public Map<String,Settings> getGroups(String settingPrefix) throws SettingsException Description copied from interface: Settings Returns group settings for the given setting prefix. Specified by: getGroups in interface Settings Throws: SettingsException getGroups public Map<String,Settings> getGroups(String settingPrefix, boolean ignoreNonGrouped) throws SettingsException Description copied from interface: Settings Returns group settings for the given setting prefix. Specified by: getGroups in interface Settings Throws: SettingsException getAsVersion public Version getAsVersion(String setting, Version defaultVersion) throws SettingsException Description copied from interface: Settings Returns a parsed version. Specified by: getAsVersion in interface Settings Throws: SettingsException names public Set<String> names() Specified by: names in interface Settings Returns: The direct keys of this settings toDelimitedString public String toDelimitedString(char delimiter) Description copied from interface: Settings Returns the settings as delimited string. Specified by: toDelimitedString in interface Settings equals public boolean equals(Object o) Overrides: equals in class Object hashCode public int hashCode() Overrides: hashCode in class Object readSettingsFromStream public static Settings readSettingsFromStream(StreamInput in) throws IOException Throws: IOException writeSettingsToStream public static void writeSettingsToStream(Settings settings, StreamOutput out) throws IOException Throws: IOException builder public static ImmutableSettings.Builder builder() settingsBuilder public static ImmutableSettings.Builder settingsBuilder() Returns a builder to be used in order to build settings. toXContent public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException Specified by: toXContent in interface ToXContent Throws: IOException

Class ImmutableSettings

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

FLAT_SETTINGS_KEY

Method Detail

getClassLoader

getClassLoaderIfSet

getAsMap

getAsStructuredMap

getComponentSettings

getComponentSettings

getByPrefix

getAsSettings

get

get

get

get

getAsFloat

getAsFloat

getAsDouble

getAsDouble

getAsInt

getAsInt

getAsLong

getAsLong

getAsBoolean

getAsBoolean

getAsTime

getAsTime

getAsBytesSize

getAsBytesSize

getAsMemory

getAsMemory

getAsRatio

getAsRatio

getAsSize

getAsSize

getAsClass

getAsClass

getAsArray

getAsArray

getAsArray

getGroups

getGroups

getAsVersion

names

toDelimitedString

equals

hashCode

readSettingsFromStream

writeSettingsToStream

builder

settingsBuilder

toXContent