Settings (Elasticsearch: Core 2.4.0 API)

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

All Implemented Interfaces:

ToXContent
```
public final class Settings
extends Object
implements ToXContent
```
An immutable settings implementation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Settings.Builder` A builder allowing to put different settings and then `Settings.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`	`SETTINGS_REQUIRE_UNITS` Name of the setting to use to disable required units for byte size, time settings.

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

Method Summary

Methods
Modifier and Type	Method and Description
`static Settings.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.
`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.
`Map<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.
`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.
`static boolean`	`getSettingsRequireUnits()`
`int`	`hashCode()`
`Set<String>`	`names()`
`static Settings`	`readSettingsFromStream(StreamInput in)`
`static void`	`setSettingsRequireUnits(boolean v)`
`static Settings.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
```
  - SETTINGS_REQUIRE_UNITS
```
public static final String SETTINGS_REQUIRE_UNITS
```
    Name of the setting to use to disable required units for byte size, time settings.
    
    See Also:
    Constant Field Values
- Method Detail
  - setSettingsRequireUnits
```
public static void setSettingsRequireUnits(boolean v)
```
  - getSettingsRequireUnits
```
public static boolean getSettingsRequireUnits()
```
  - getAsMap
```
public Map<String,String> getAsMap()
```
    The settings as a flat Map.
    
    Returns:
    an unmodifiable map of settings
  - getAsStructuredMap
```
public Map<String,Object> getAsStructuredMap()
```
    The settings as a structured Map.
  - getByPrefix
```
public Settings getByPrefix(String prefix)
```
    A settings that are filtered (and key is removed) with the specified prefix.
  - getAsSettings
```
public Settings getAsSettings(String setting)
```
    Returns the settings mapped to the given setting name.
  - get
```
public String get(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
```
public String get(String[] settings)
```
    Returns the setting value associated with the first setting key.
  - get
```
public String get(String setting,
         String defaultValue)
```
    Returns the setting value associated with the setting key. If it does not exists, returns the default value provided.
  - get
```
public String get(String[] settings,
         String defaultValue)
```
    Returns the setting value associated with the first setting key, if none exists, returns the default value provided.
  - getAsFloat
```
public Float getAsFloat(String setting,
               Float defaultValue)
```
    Returns the setting value (as float) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsFloat
```
public Float getAsFloat(String[] settings,
               Float defaultValue)
                 throws SettingsException
```
    Returns the setting value (as float) associated with teh first setting key, if none exists, returns the default value provided.
    
    Throws:
    
    SettingsException
  - getAsDouble
```
public Double getAsDouble(String setting,
                 Double defaultValue)
```
    Returns the setting value (as double) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsDouble
```
public 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.
  - getAsInt
```
public Integer getAsInt(String setting,
               Integer defaultValue)
```
    Returns the setting value (as int) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsInt
```
public Integer getAsInt(String[] settings,
               Integer defaultValue)
```
    Returns the setting value (as int) associated with the first setting key. If it does not exists, returns the default value provided.
  - getAsLong
```
public Long getAsLong(String setting,
             Long defaultValue)
```
    Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsLong
```
public Long getAsLong(String[] settings,
             Long defaultValue)
```
    Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsBoolean
```
public Boolean getAsBoolean(String setting,
                   Boolean defaultValue)
```
    Returns the setting value (as boolean) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsBoolean
```
public Boolean getAsBoolean(String[] settings,
                   Boolean defaultValue)
```
    Returns the setting value (as boolean) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsTime
```
public TimeValue getAsTime(String setting,
                  TimeValue defaultValue)
```
    Returns the setting value (as time) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsTime
```
public TimeValue getAsTime(String[] settings,
                  TimeValue defaultValue)
```
    Returns the setting value (as time) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsBytesSize
```
public ByteSizeValue getAsBytesSize(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.
    
    Throws:
    
    SettingsException
  - getAsBytesSize
```
public ByteSizeValue getAsBytesSize(String[] settings,
                           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.
    
    Throws:
    
    SettingsException
  - getAsMemory
```
public ByteSizeValue getAsMemory(String setting,
                        String defaultValue)
                          throws SettingsException
```
    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.
    
    Throws:
    
    SettingsException
  - getAsMemory
```
public ByteSizeValue getAsMemory(String[] settings,
                        String defaultValue)
                          throws SettingsException
```
    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.
    
    Throws:
    
    SettingsException
  - getAsRatio
```
public RatioValue getAsRatio(String setting,
                    String defaultValue)
                      throws SettingsException
```
    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.
    
    Throws:
    
    SettingsException
  - getAsRatio
```
public RatioValue getAsRatio(String[] settings,
                    String defaultValue)
                      throws SettingsException
```
    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.
    
    Throws:
    
    SettingsException
  - getAsSize
```
public SizeValue getAsSize(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.
    
    Throws:
    
    SettingsException
  - getAsSize
```
public SizeValue getAsSize(String[] settings,
                  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.
    
    Throws:
    
    SettingsException
  - getAsArray
```
public String[] getAsArray(String settingPrefix)
                    throws SettingsException
```
    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.
    
    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
```
    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.
    
    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
```
    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.
    
    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
```
    Returns group settings for the given setting prefix.
    
    Throws:
    
    SettingsException
  - getGroups
```
public Map<String,Settings> getGroups(String settingPrefix,
                             boolean ignoreNonGrouped)
                               throws SettingsException
```
    Returns group settings for the given setting prefix.
    
    Throws:
    
    SettingsException
  - getAsVersion
```
public Version getAsVersion(String setting,
                   Version defaultVersion)
                     throws SettingsException
```
    Returns a parsed version.
    
    Throws:
    
    SettingsException
  - names
```
public Set<String> names()
```
    Returns:
    The direct keys of this settings
  - toDelimitedString
```
public String toDelimitedString(char delimiter)
```
    Returns the settings as delimited string.
  - 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 Settings.Builder builder()
```
  - settingsBuilder
```
public static Settings.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 Settings

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

SETTINGS_REQUIRE_UNITS

Method Detail

setSettingsRequireUnits

getSettingsRequireUnits

getAsMap

getAsStructuredMap

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

getAsArray

getAsArray

getAsArray

getGroups

getGroups

getAsVersion

names

toDelimitedString

equals

hashCode

readSettingsFromStream

writeSettingsToStream

builder

settingsBuilder

toXContent