org.elasticsearch.common.settings

Class Settings

java.lang.Object

org.elasticsearch.common.settings.Settings

All Implemented Interfaces:

ToXContent

public final class Settings
extends java.lang.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 java.util.Set<java.lang.String>	FORMAT_PARAMS

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
static Settings.Builder	builder() Returns a builder to be used in order to build settings.
boolean	equals(java.lang.Object o)
Settings	filter(java.util.function.Predicate<java.lang.String> predicate) Returns a new settings object that contains all setting of the current one filtered by the given settings key predicate.
java.lang.String	get(java.lang.String setting) Returns the setting value associated with the setting key.
java.lang.String	get(java.lang.String setting, java.lang.String defaultValue) Returns the setting value associated with the setting key.
java.lang.String[]	getAsArray(java.lang.String settingPrefix) The values associated with a setting prefix as an array.
java.lang.String[]	getAsArray(java.lang.String settingPrefix, java.lang.String[] defaultArray) The values associated with a setting prefix as an array.
java.lang.String[]	getAsArray(java.lang.String settingPrefix, java.lang.String[] defaultArray, java.lang.Boolean commaDelimited) The values associated with a setting prefix as an array.
java.lang.Boolean	getAsBoolean(java.lang.String setting, java.lang.Boolean defaultValue) Returns the setting value (as boolean) associated with the setting key.
ByteSizeValue	getAsBytesSize(java.lang.String setting, ByteSizeValue defaultValue) Returns the setting value (as size) associated with the setting key.
java.lang.Double	getAsDouble(java.lang.String setting, java.lang.Double defaultValue) Returns the setting value (as double) associated with the setting key.
java.lang.Float	getAsFloat(java.lang.String setting, java.lang.Float defaultValue) Returns the setting value (as float) associated with the setting key.
java.util.Map<java.lang.String,Settings>	getAsGroups() Returns group settings for the given setting prefix.
java.util.Map<java.lang.String,Settings>	getAsGroups(boolean ignoreNonGrouped)
java.lang.Integer	getAsInt(java.lang.String setting, java.lang.Integer defaultValue) Returns the setting value (as int) associated with the setting key.
java.lang.Long	getAsLong(java.lang.String setting, java.lang.Long defaultValue) Returns the setting value (as long) associated with the setting key.
java.util.Map<java.lang.String,java.lang.String>	getAsMap() The settings as a flat Map.
ByteSizeValue	getAsMemory(java.lang.String setting, java.lang.String defaultValue) Returns the setting value (as size) associated with the setting key.
RatioValue	getAsRatio(java.lang.String setting, java.lang.String defaultValue) Returns the setting value (as a RatioValue) associated with the setting key.
Settings	getAsSettings(java.lang.String setting) Returns the settings mapped to the given setting name.
SizeValue	getAsSize(java.lang.String setting, SizeValue defaultValue) Returns the setting value (as size) associated with the setting key.
java.util.Map<java.lang.String,java.lang.Object>	getAsStructuredMap() The settings as a structured Map.
TimeValue	getAsTime(java.lang.String setting, TimeValue defaultValue) Returns the setting value (as time) associated with the setting key.
Version	getAsVersion(java.lang.String setting, Version defaultVersion) Returns a parsed version.
Settings	getByPrefix(java.lang.String prefix) A settings that are filtered (and key is removed) with the specified prefix.
java.util.Map<java.lang.String,Settings>	getGroups(java.lang.String settingPrefix) Returns group settings for the given setting prefix.
java.util.Map<java.lang.String,Settings>	getGroups(java.lang.String settingPrefix, boolean ignoreNonGrouped) Returns group settings for the given setting prefix.
int	hashCode()
boolean	hasValue(java.lang.String key) Returns true iff the given key has a value in this settings object
boolean	isEmpty() Returns true if this settings object contains no settings
java.util.Set<java.lang.String>	keySet() Returns the fully qualified setting names contained in this settings object.
java.util.Set<java.lang.String>	names()
static Settings	readSettingsFromStream(StreamInput in)
int	size() Returns the number of settings in this settings object.
java.lang.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

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

isFragment

Field Detail

EMPTY

public static final Settings EMPTY

FORMAT_PARAMS

public static final java.util.Set<java.lang.String> FORMAT_PARAMS

Method Detail

getAsMap

public java.util.Map<java.lang.String,java.lang.String> getAsMap()

The settings as a flat Map.

Returns:

an unmodifiable map of settings

getAsStructuredMap

public java.util.Map<java.lang.String,java.lang.Object> getAsStructuredMap()

The settings as a structured Map.

getByPrefix

public Settings getByPrefix(java.lang.String prefix)

A settings that are filtered (and key is removed) with the specified prefix.

filter

public Settings filter(java.util.function.Predicate<java.lang.String> predicate)

Returns a new settings object that contains all setting of the current one filtered by the given settings key predicate.

getAsSettings

public Settings getAsSettings(java.lang.String setting)

Returns the settings mapped to the given setting name.

get

public java.lang.String get(java.lang.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 java.lang.String get(java.lang.String setting,
                            java.lang.String defaultValue)

Returns the setting value associated with the setting key. If it does not exists, returns the default value provided.

getAsFloat

public java.lang.Float getAsFloat(java.lang.String setting,
                                  java.lang.Float defaultValue)

Returns the setting value (as float) associated with the setting key. If it does not exists, returns the default value provided.

getAsDouble

public java.lang.Double getAsDouble(java.lang.String setting,
                                    java.lang.Double defaultValue)

Returns the setting value (as double) associated with the setting key. If it does not exists, returns the default value provided.

getAsInt

public java.lang.Integer getAsInt(java.lang.String setting,
                                  java.lang.Integer defaultValue)

Returns the setting value (as int) associated with the setting key. If it does not exists, returns the default value provided.

getAsLong

public java.lang.Long getAsLong(java.lang.String setting,
                                java.lang.Long defaultValue)

Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided.

hasValue

public boolean hasValue(java.lang.String key)

Returns true iff the given key has a value in this settings object

getAsBoolean

public java.lang.Boolean getAsBoolean(java.lang.String setting,
                                      java.lang.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(java.lang.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.

getAsBytesSize

public ByteSizeValue getAsBytesSize(java.lang.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

getAsMemory

public ByteSizeValue getAsMemory(java.lang.String setting,
                                 java.lang.String defaultValue)
                          throws SettingsException

Returns the setting value (as size) associated with the setting key. Provided values can either be absolute values (interpreted 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(java.lang.String setting,
                             java.lang.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(java.lang.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

getAsArray

public java.lang.String[] getAsArray(java.lang.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 java.lang.String[] getAsArray(java.lang.String settingPrefix,
                                     java.lang.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 java.lang.String[] getAsArray(java.lang.String settingPrefix,
                                     java.lang.String[] defaultArray,
                                     java.lang.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 java.util.Map<java.lang.String,Settings> getGroups(java.lang.String settingPrefix)
                                                   throws SettingsException

Returns group settings for the given setting prefix.

Throws:

SettingsException

getGroups

public java.util.Map<java.lang.String,Settings> getGroups(java.lang.String settingPrefix,
                                                          boolean ignoreNonGrouped)
                                                   throws SettingsException

Returns group settings for the given setting prefix.

Throws:

SettingsException

getAsGroups

public java.util.Map<java.lang.String,Settings> getAsGroups()
                                                     throws SettingsException

Returns group settings for the given setting prefix.

Throws:

SettingsException

getAsGroups

public java.util.Map<java.lang.String,Settings> getAsGroups(boolean ignoreNonGrouped)
                                                     throws SettingsException

Throws:

SettingsException

getAsVersion

public Version getAsVersion(java.lang.String setting,
                            Version defaultVersion)
                     throws SettingsException

Returns a parsed version.

Throws:

SettingsException

names

public java.util.Set<java.lang.String> names()

Returns:

The direct keys of this settings

toDelimitedString

public java.lang.String toDelimitedString(char delimiter)

Returns the settings as delimited string.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

readSettingsFromStream

public static Settings readSettingsFromStream(StreamInput in)
                                       throws java.io.IOException

Throws:

java.io.IOException

writeSettingsToStream

public static void writeSettingsToStream(Settings settings,
                                         StreamOutput out)
                                  throws java.io.IOException

Throws:

java.io.IOException

builder

public static Settings.Builder builder()

Returns a builder to be used in order to build settings.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

isEmpty

public boolean isEmpty()

Returns true if this settings object contains no settings

Returns:

true if this settings object contains no settings

size

public int size()

Returns the number of settings in this settings object.

keySet

public java.util.Set<java.lang.String> keySet()

Returns the fully qualified setting names contained in this settings object.