Settings.Builder (Elasticsearch: Core 2.3.5 API)

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

Enclosing class:

Settings
```
public static class Settings.Builder
extends Object
```
A builder allowing to put different settings and then build() an immutable settings implementation. Use Settings.settingsBuilder() in order to construct it.

Field Summary

Fields
Modifier and Type Field and Description

static Settings EMPTY_SETTINGS

Fields
Modifier and Type	Field and Description
`static Settings`	`EMPTY_SETTINGS`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Settings`	`build()` Builds a `Settings` (underlying uses `Settings`) based on everything set on this builder.
`Settings.Builder`	`extendArray(String setting, String... values)` Sets the setting as an array of values, but keeps existing elements for the key.
`String`	`get(String key)` Returns a setting value based on the setting key.
`Map<String,String>`	`internalMap()`
`Settings.Builder`	`loadFromDelimitedString(String value, char delimiter)`
`Settings.Builder`	`loadFromPath(Path path)` Loads settings from a url that represents them using the `SettingsLoaderFactory.loaderFromSource(String)`.
`Settings.Builder`	`loadFromSource(String source)` Loads settings from the actual string content that represents them using the `SettingsLoaderFactory.loaderFromSource(String)`.
`Settings.Builder`	`loadFromStream(String resourceName, InputStream is)` Loads settings from a stream that represents them using the `SettingsLoaderFactory.loaderFromSource(String)`.
`Settings.Builder`	`normalizePrefix(String prefix)` Checks that all settings in the builder start with the specified prefix.
`Settings.Builder`	`put(Map<String,String> settings)` Sets all the provided settings.
`Settings.Builder`	`put(Object... settings)` Puts tuples of key value pairs of settings.
`Settings.Builder`	`put(Properties properties)` Sets all the provided settings.
`Settings.Builder`	`put(Settings settings)` Sets all the provided settings.
`Settings.Builder`	`put(String setting, boolean value)` Sets the setting with the provided setting key and the boolean value.
`Settings.Builder`	`put(String key, Class clazz)` Sets a setting with the provided setting key and class as value.
`Settings.Builder`	`put(String setting, double value)` Sets the setting with the provided setting key and the double value.
`Settings.Builder`	`put(String setting, float value)` Sets the setting with the provided setting key and the float value.
`Settings.Builder`	`put(String setting, int value)` Sets the setting with the provided setting key and the int value.
`Settings.Builder`	`put(String setting, long value)` Sets the setting with the provided setting key and the long value.
`Settings.Builder`	`put(String setting, long value, ByteSizeUnit sizeUnit)` Sets the setting with the provided setting key and the size value.
`Settings.Builder`	`put(String setting, long value, TimeUnit timeUnit)` Sets the setting with the provided setting key and the time value.
`Settings.Builder`	`put(String key, String value)` Sets a setting with the provided setting key and value.
`Settings.Builder`	`put(String settingPrefix, String groupName, String[] settings, String[] values)` Sets the setting group.
`Settings.Builder`	`put(String setting, Version version)`
`Settings.Builder`	`putArray(String setting, String... values)` Sets the setting with the provided setting key and an array of values.
`Settings.Builder`	`putProperties(String prefix, Properties properties)` Puts all the properties with keys starting with the provided `prefix`.
`Settings.Builder`	`putProperties(String prefix, Properties properties, String[] ignorePrefixes)` Puts all the properties with keys starting with the provided `prefix`.
`String`	`remove(String key)` Removes the provided setting from the internal map holding the current list of settings.
`Settings.Builder`	`replacePropertyPlaceholders()` Runs across all the settings set on this builder and replaces `${...}` elements in the each setting value according to the following logic:

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

- Field Detail
  - EMPTY_SETTINGS
```
public static final Settings EMPTY_SETTINGS
```
- Method Detail
  - internalMap
```
public Map<String,String> internalMap()
```
  - remove
```
public String remove(String key)
```
    Removes the provided setting from the internal map holding the current list of settings.
  - get
```
public String get(String key)
```
    Returns a setting value based on the setting key.
  - put
```
public Settings.Builder put(Object... settings)
```
    Puts tuples of key value pairs of settings. Simplified version instead of repeating calling put for each one.
  - put
```
public Settings.Builder put(String key,
                            String value)
```
    Sets a setting with the provided setting key and value.
    
    Parameters:
    
    key - The setting key
    
    value - The setting value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String key,
                            Class clazz)
```
    Sets a setting with the provided setting key and class as value.
    
    Parameters:
    
    key - The setting key
    
    clazz - The setting class value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String setting,
                            boolean value)
```
    Sets the setting with the provided setting key and the boolean value.
    
    Parameters:
    
    setting - The setting key
    
    value - The boolean value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String setting,
                            int value)
```
    Sets the setting with the provided setting key and the int value.
    
    Parameters:
    
    setting - The setting key
    
    value - The int value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String setting,
                            Version version)
```
  - put
```
public Settings.Builder put(String setting,
                            long value)
```
    Sets the setting with the provided setting key and the long value.
    
    Parameters:
    
    setting - The setting key
    
    value - The long value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String setting,
                            float value)
```
    Sets the setting with the provided setting key and the float value.
    
    Parameters:
    
    setting - The setting key
    
    value - The float value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String setting,
                            double value)
```
    Sets the setting with the provided setting key and the double value.
    
    Parameters:
    
    setting - The setting key
    
    value - The double value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String setting,
                            long value,
                            TimeUnit timeUnit)
```
    Sets the setting with the provided setting key and the time value.
    
    Parameters:
    
    setting - The setting key
    
    value - The time value
    
    Returns:
    
    The builder
  - put
```
public Settings.Builder put(String setting,
                            long value,
                            ByteSizeUnit sizeUnit)
```
    Sets the setting with the provided setting key and the size value.
    
    Parameters:
    
    setting - The setting key
    
    value - The size value
    
    Returns:
    
    The builder
  - putArray
```
public Settings.Builder putArray(String setting,
                                 String... values)
```
    Sets the setting with the provided setting key and an array of values.
    
    Parameters:
    
    setting - The setting key
    
    values - The values
    
    Returns:
    
    The builder
  - extendArray
```
public Settings.Builder extendArray(String setting,
                                    String... values)
```
    Sets the setting as an array of values, but keeps existing elements for the key.
  - put
```
public Settings.Builder put(String settingPrefix,
                            String groupName,
                            String[] settings,
                            String[] values)
                     throws SettingsException
```
    Sets the setting group.
    
    Throws:
    
    SettingsException
  - put
```
public Settings.Builder put(Settings settings)
```
    Sets all the provided settings.
  - put
```
public Settings.Builder put(Map<String,String> settings)
```
    Sets all the provided settings.
  - put
```
public Settings.Builder put(Properties properties)
```
    Sets all the provided settings.
  - loadFromDelimitedString
```
public Settings.Builder loadFromDelimitedString(String value,
                                                char delimiter)
```
  - loadFromSource
```
public Settings.Builder loadFromSource(String source)
```
    Loads settings from the actual string content that represents them using the SettingsLoaderFactory.loaderFromSource(String).
  - loadFromPath
```
public Settings.Builder loadFromPath(Path path)
                              throws SettingsException
```
    Loads settings from a url that represents them using the SettingsLoaderFactory.loaderFromSource(String).
    
    Throws:
    
    SettingsException
  - loadFromStream
```
public Settings.Builder loadFromStream(String resourceName,
                                       InputStream is)
                                throws SettingsException
```
    Loads settings from a stream that represents them using the SettingsLoaderFactory.loaderFromSource(String).
    
    Throws:
    
    SettingsException
  - putProperties
```
public Settings.Builder putProperties(String prefix,
                                      Properties properties)
```
    Puts all the properties with keys starting with the provided prefix.
    
    Parameters:
    
    prefix - The prefix to filter property key by
    
    properties - The properties to put
    
    Returns:
    
    The builder
  - putProperties
```
public Settings.Builder putProperties(String prefix,
                                      Properties properties,
                                      String[] ignorePrefixes)
```
    Puts all the properties with keys starting with the provided prefix.
    
    Parameters:
    
    prefix - The prefix to filter property key by
    
    properties - The properties to put
    
    Returns:
    
    The builder
  - replacePropertyPlaceholders
```
public Settings.Builder replacePropertyPlaceholders()
```
    Runs across all the settings set on this builder and replaces ${...} elements in the each setting value according to the following logic:
    First, tries to resolve it against a System property (System.getProperty(String)), next, tries and resolve it against an environment variable (System.getenv(String)), and last, tries and replace it with another setting already set on this builder.
  - normalizePrefix
```
public Settings.Builder normalizePrefix(String prefix)
```
    Checks that all settings in the builder start with the specified prefix. If a setting doesn't start with the prefix, the builder appends the prefix to such setting.
  - build
```
public Settings build()
```
    Builds a Settings (underlying uses Settings) based on everything set on this builder.

Class Settings.Builder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_SETTINGS

Method Detail

internalMap

remove

get

put

put

put

put

put

put

put

put

put

put

put

putArray

extendArray

put

put

put

put

loadFromDelimitedString

loadFromSource

loadFromPath

loadFromStream

putProperties

putProperties

replacePropertyPlaceholders

normalizePrefix

build