org.elasticsearch.common.settings

Class Setting<T>

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.common.settings.Setting<T>

All Implemented Interfaces:

ToXContent

public class Setting<T>
extends ToXContentToBytes

A setting. Encapsulates typical stuff like default value, parsing, and scope. Some (SettingsProperty.Dynamic) can by modified at run time using the API. All settings inside elasticsearch or in any of the plugins should use this type-safe and generic settings infrastructure together with AbstractScopedSettings. This class contains several utility methods that makes it straight forward to add settings for the majority of the cases. For instance a simple boolean settings can be defined like this:

 public static final Setting<Boolean>; MY_BOOLEAN = Setting.boolSetting("my.bool.setting", true, SettingsProperty.NodeScope);
 

To retrieve the value of the setting a Settings object can be passed directly to the get(Settings) method.

 final boolean myBooleanValue = MY_BOOLEAN.get(settings);
 

It's recommended to use typed settings rather than string based settings. For example adding a setting for an enum type:

 public enum Color {
     RED, GREEN, BLUE;
 }
 public static final Setting<Color> MY_BOOLEAN =
     new Setting<>("my.color.setting", Color.RED.toString(), Color::valueOf, SettingsProperty.NodeScope);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Setting.AffixKey
static class	Setting.GroupKey
static interface	Setting.Key
static class	Setting.ListKey
static class	Setting.Property
static class	Setting.SimpleKey

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
protected java.util.function.Function<Settings,java.lang.String>	defaultValue

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Setting(Setting.Key key, java.util.function.Function<Settings,java.lang.String> defaultValue, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties) Creates a new Setting instance.
Setting(Setting.Key key, Setting<T> fallbackSetting, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties) Creates a new Setting instance.
Setting(java.lang.String key, java.util.function.Function<Settings,java.lang.String> defaultValue, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties) Creates a new Setting instance
Setting(java.lang.String key, Setting<T> fallBackSetting, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties) Creates a new Setting instance
Setting(java.lang.String key, java.lang.String defaultValue, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties) Creates a new Setting instance

Method Summary

Modifier and Type	Method and Description
static <T> Setting<T>	adfixKeySetting(java.lang.String prefix, java.lang.String suffix, java.util.function.Function<Settings,java.lang.String> defaultValue, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties) This setting type allows to validate settings that have the same type and a common prefix and suffix.
static <T> Setting<T>	adfixKeySetting(java.lang.String prefix, java.lang.String suffix, java.lang.String defaultValue, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties)
static <T> Setting<T>	affixKeySetting(Setting.AffixKey key, java.util.function.Function<Settings,java.lang.String> defaultValue, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties)
static Setting<java.lang.Boolean>	boolSetting(java.lang.String key, boolean defaultValue, Setting.Property... properties)
static Setting<java.lang.Boolean>	boolSetting(java.lang.String key, Setting<java.lang.Boolean> fallbackSetting, Setting.Property... properties)
static Setting<ByteSizeValue>	byteSizeSetting(java.lang.String key, ByteSizeValue defaultValue, ByteSizeValue minValue, ByteSizeValue maxValue, Setting.Property... properties)
static Setting<ByteSizeValue>	byteSizeSetting(java.lang.String key, ByteSizeValue value, Setting.Property... properties)
static Setting<ByteSizeValue>	byteSizeSetting(java.lang.String key, java.util.function.Function<Settings,java.lang.String> defaultValue, ByteSizeValue minValue, ByteSizeValue maxValue, Setting.Property... properties)
static Setting<ByteSizeValue>	byteSizeSetting(java.lang.String key, java.util.function.Function<Settings,java.lang.String> defaultValue, Setting.Property... properties)
static Setting<ByteSizeValue>	byteSizeSetting(java.lang.String key, Setting<ByteSizeValue> fallbackSetting, Setting.Property... properties)
static Setting<ByteSizeValue>	byteSizeSetting(java.lang.String key, java.lang.String percentage, Setting.Property... properties)
static Setting<java.lang.Double>	doubleSetting(java.lang.String key, double defaultValue, double minValue, Setting.Property... properties)
boolean	equals(java.lang.Object o)
boolean	exists(Settings settings) Returns true iff this setting is present in the given settings object.
static Setting<java.lang.Float>	floatSetting(java.lang.String key, float defaultValue, float minValue, Setting.Property... properties)
static Setting<java.lang.Float>	floatSetting(java.lang.String key, float defaultValue, Setting.Property... properties)
T	get(Settings settings) Returns the settings value.
T	get(Settings primary, Settings secondary) Returns the value for this setting but falls back to the second provided settings object
Setting<T>	getConcreteSetting(java.lang.String key)
T	getDefault(Settings settings) Returns the default value for this setting.
java.lang.String	getDefaultRaw(Settings settings) Returns the default value string representation for this setting.
java.lang.String	getKey() Returns the settings key or a prefix if this setting is a group setting.
java.util.EnumSet<Setting.Property>	getProperties() Returns the setting properties
java.lang.String	getRaw(Settings settings) Returns the raw (string) settings value.
Setting.Key	getRawKey() Returns the original representation of a setting key.
static Setting<Settings>	groupSetting(java.lang.String key, java.util.function.Consumer<Settings> validator, Setting.Property... properties)
static Setting<Settings>	groupSetting(java.lang.String key, Setting.Property... properties)
int	hashCode()
boolean	hasIndexScope() Returns true if this setting has an index scope, otherwise false
boolean	hasNodeScope() Returns true if this setting has a node scope, otherwise false
static Setting<java.lang.Integer>	intSetting(java.lang.String key, int defaultValue, int minValue, int maxValue, Setting.Property... properties)
static Setting<java.lang.Integer>	intSetting(java.lang.String key, int defaultValue, int minValue, Setting.Property... properties)
static Setting<java.lang.Integer>	intSetting(java.lang.String key, int defaultValue, Setting.Property... properties)
static Setting<java.lang.Integer>	intSetting(java.lang.String key, Setting<java.lang.Integer> fallbackSetting, int minValue, Setting.Property... properties)
boolean	isDeprecated() Returns true if this setting is deprecated, otherwise false
boolean	isDynamic() Returns true if this setting is dynamically updateable, otherwise false
boolean	isFiltered() Returns true if this setting must be filtered, otherwise false
static <T> Setting<java.util.List<T>>	listSetting(java.lang.String key, java.util.function.Function<Settings,java.util.List<java.lang.String>> defaultStringValue, java.util.function.Function<java.lang.String,T> singleValueParser, Setting.Property... properties)
static <T> Setting<java.util.List<T>>	listSetting(java.lang.String key, java.util.List<java.lang.String> defaultStringValue, java.util.function.Function<java.lang.String,T> singleValueParser, Setting.Property... properties)
static <T> Setting<java.util.List<T>>	listSetting(java.lang.String key, Setting<java.util.List<T>> fallbackSetting, java.util.function.Function<java.lang.String,T> singleValueParser, Setting.Property... properties)
static Setting<java.lang.Long>	longSetting(java.lang.String key, long defaultValue, long minValue, Setting.Property... properties)
boolean	match(java.lang.String toTest) Returns true iff the given key matches the settings key or if this setting is a group setting if the given key is part of the settings group.
static ByteSizeValue	parseByteSize(java.lang.String s, ByteSizeValue minValue, ByteSizeValue maxValue, java.lang.String key)
static int	parseInt(java.lang.String s, int minValue, int maxValue, java.lang.String key)
static int	parseInt(java.lang.String s, int minValue, java.lang.String key)
static long	parseLong(java.lang.String s, long minValue, java.lang.String key)
static TimeValue	parseTimeValue(java.lang.String s, TimeValue minValue, java.lang.String key)
static Setting<TimeValue>	positiveTimeSetting(java.lang.String key, TimeValue defaultValue, Setting.Property... properties)
static <T> Setting<T>	prefixKeySetting(java.lang.String prefix, java.lang.String defaultValue, java.util.function.Function<java.lang.String,T> parser, Setting.Property... properties) This setting type allows to validate settings that have the same type and a common prefix.
static Setting<java.lang.String>	simpleString(java.lang.String key, Setting.Property... properties)
static Setting<TimeValue>	timeSetting(java.lang.String key, java.util.function.Function<Settings,java.lang.String> defaultValue, TimeValue minValue, Setting.Property... properties)
static Setting<TimeValue>	timeSetting(java.lang.String key, Setting<TimeValue> fallbackSetting, Setting.Property... properties)
static Setting<TimeValue>	timeSetting(java.lang.String key, TimeValue defaultValue, Setting.Property... properties)
static Setting<TimeValue>	timeSetting(java.lang.String key, TimeValue defaultValue, TimeValue minValue, Setting.Property... properties)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

defaultValue

protected final java.util.function.Function<Settings,java.lang.String> defaultValue

Constructor Detail

Setting

public Setting(Setting.Key key,
               java.util.function.Function<Settings,java.lang.String> defaultValue,
               java.util.function.Function<java.lang.String,T> parser,
               Setting.Property... properties)

Creates a new Setting instance. When no scope is provided, we default to Setting.Property.NodeScope.

Parameters:

key - the settings key for this setting.

defaultValue - a default value function that returns the default values string representation.

parser - a parser that parses the string rep into a complex datatype.

properties - properties for this setting like scope, filtering...

Setting

public Setting(java.lang.String key,
               java.lang.String defaultValue,
               java.util.function.Function<java.lang.String,T> parser,
               Setting.Property... properties)

Creates a new Setting instance

Parameters:

key - the settings key for this setting.

defaultValue - a default value.

parser - a parser that parses the string rep into a complex datatype.

properties - properties for this setting like scope, filtering...

Setting

public Setting(java.lang.String key,
               java.util.function.Function<Settings,java.lang.String> defaultValue,
               java.util.function.Function<java.lang.String,T> parser,
               Setting.Property... properties)

Creates a new Setting instance

Parameters:

key - the settings key for this setting.

defaultValue - a default value function that returns the default values string representation.

parser - a parser that parses the string rep into a complex datatype.

properties - properties for this setting like scope, filtering...

Setting

public Setting(Setting.Key key,
               Setting<T> fallbackSetting,
               java.util.function.Function<java.lang.String,T> parser,
               Setting.Property... properties)

Creates a new Setting instance. When no scope is provided, we default to Setting.Property.NodeScope.

Parameters:

key - the settings key for this setting.

fallbackSetting - a setting who's value to fallback on if this setting is not defined

parser - a parser that parses the string rep into a complex datatype.

properties - properties for this setting like scope, filtering...

Setting

public Setting(java.lang.String key,
               Setting<T> fallBackSetting,
               java.util.function.Function<java.lang.String,T> parser,
               Setting.Property... properties)

Creates a new Setting instance

Parameters:

key - the settings key for this setting.

fallBackSetting - a setting to fall back to if the current setting is not set.

parser - a parser that parses the string rep into a complex datatype.

properties - properties for this setting like scope, filtering...

Method Detail

getKey

public final java.lang.String getKey()

Returns the settings key or a prefix if this setting is a group setting. Note: this method should not be used to retrieve a value from a Settings object. Use get(Settings) instead

See Also:

isGroupSetting()

getRawKey

public final Setting.Key getRawKey()

Returns the original representation of a setting key.

isDynamic

public final boolean isDynamic()

Returns true if this setting is dynamically updateable, otherwise false

getProperties

public java.util.EnumSet<Setting.Property> getProperties()

Returns the setting properties

See Also:

Setting.Property

isFiltered

public boolean isFiltered()

Returns true if this setting must be filtered, otherwise false

hasNodeScope

public boolean hasNodeScope()

Returns true if this setting has a node scope, otherwise false

hasIndexScope

public boolean hasIndexScope()

Returns true if this setting has an index scope, otherwise false

isDeprecated

public boolean isDeprecated()

Returns true if this setting is deprecated, otherwise false

getDefaultRaw

public final java.lang.String getDefaultRaw(Settings settings)

Returns the default value string representation for this setting.

Parameters:

settings - a settings object for settings that has a default value depending on another setting if available

getDefault

public final T getDefault(Settings settings)

Returns the default value for this setting.

Parameters:

settings - a settings object for settings that has a default value depending on another setting if available

exists

public boolean exists(Settings settings)

Returns true iff this setting is present in the given settings object. Otherwise false

get

public T get(Settings settings)

Returns the settings value. If the setting is not present in the given settings object the default value is returned instead.

getRaw

public java.lang.String getRaw(Settings settings)

Returns the raw (string) settings value. If the setting is not present in the given settings object the default value is returned instead. This is useful if the value can't be parsed due to an invalid value to access the actual value.

match

public final boolean match(java.lang.String toTest)

Returns true iff the given key matches the settings key or if this setting is a group setting if the given key is part of the settings group.

See Also:

isGroupSetting()

toXContent

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

Throws:

java.io.IOException

get

public final T get(Settings primary,
                   Settings secondary)

Returns the value for this setting but falls back to the second provided settings object

getConcreteSetting

public Setting<T> getConcreteSetting(java.lang.String key)

floatSetting

public static Setting<java.lang.Float> floatSetting(java.lang.String key,
                                                    float defaultValue,
                                                    Setting.Property... properties)

floatSetting

public static Setting<java.lang.Float> floatSetting(java.lang.String key,
                                                    float defaultValue,
                                                    float minValue,
                                                    Setting.Property... properties)

intSetting

public static Setting<java.lang.Integer> intSetting(java.lang.String key,
                                                    int defaultValue,
                                                    int minValue,
                                                    int maxValue,
                                                    Setting.Property... properties)

intSetting

public static Setting<java.lang.Integer> intSetting(java.lang.String key,
                                                    int defaultValue,
                                                    int minValue,
                                                    Setting.Property... properties)

intSetting

public static Setting<java.lang.Integer> intSetting(java.lang.String key,
                                                    Setting<java.lang.Integer> fallbackSetting,
                                                    int minValue,
                                                    Setting.Property... properties)

longSetting

public static Setting<java.lang.Long> longSetting(java.lang.String key,
                                                  long defaultValue,
                                                  long minValue,
                                                  Setting.Property... properties)

simpleString

public static Setting<java.lang.String> simpleString(java.lang.String key,
                                                     Setting.Property... properties)

parseInt

public static int parseInt(java.lang.String s,
                           int minValue,
                           java.lang.String key)

parseInt

public static int parseInt(java.lang.String s,
                           int minValue,
                           int maxValue,
                           java.lang.String key)

parseLong

public static long parseLong(java.lang.String s,
                             long minValue,
                             java.lang.String key)

parseTimeValue

public static TimeValue parseTimeValue(java.lang.String s,
                                       TimeValue minValue,
                                       java.lang.String key)

intSetting

public static Setting<java.lang.Integer> intSetting(java.lang.String key,
                                                    int defaultValue,
                                                    Setting.Property... properties)

boolSetting

public static Setting<java.lang.Boolean> boolSetting(java.lang.String key,
                                                     boolean defaultValue,
                                                     Setting.Property... properties)

boolSetting

public static Setting<java.lang.Boolean> boolSetting(java.lang.String key,
                                                     Setting<java.lang.Boolean> fallbackSetting,
                                                     Setting.Property... properties)

byteSizeSetting

public static Setting<ByteSizeValue> byteSizeSetting(java.lang.String key,
                                                     java.lang.String percentage,
                                                     Setting.Property... properties)

byteSizeSetting

public static Setting<ByteSizeValue> byteSizeSetting(java.lang.String key,
                                                     ByteSizeValue value,
                                                     Setting.Property... properties)

byteSizeSetting

public static Setting<ByteSizeValue> byteSizeSetting(java.lang.String key,
                                                     Setting<ByteSizeValue> fallbackSetting,
                                                     Setting.Property... properties)

byteSizeSetting

public static Setting<ByteSizeValue> byteSizeSetting(java.lang.String key,
                                                     java.util.function.Function<Settings,java.lang.String> defaultValue,
                                                     Setting.Property... properties)

byteSizeSetting

public static Setting<ByteSizeValue> byteSizeSetting(java.lang.String key,
                                                     ByteSizeValue defaultValue,
                                                     ByteSizeValue minValue,
                                                     ByteSizeValue maxValue,
                                                     Setting.Property... properties)

byteSizeSetting

public static Setting<ByteSizeValue> byteSizeSetting(java.lang.String key,
                                                     java.util.function.Function<Settings,java.lang.String> defaultValue,
                                                     ByteSizeValue minValue,
                                                     ByteSizeValue maxValue,
                                                     Setting.Property... properties)

parseByteSize

public static ByteSizeValue parseByteSize(java.lang.String s,
                                          ByteSizeValue minValue,
                                          ByteSizeValue maxValue,
                                          java.lang.String key)

positiveTimeSetting

public static Setting<TimeValue> positiveTimeSetting(java.lang.String key,
                                                     TimeValue defaultValue,
                                                     Setting.Property... properties)

listSetting

public static <T> Setting<java.util.List<T>> listSetting(java.lang.String key,
                                                         java.util.List<java.lang.String> defaultStringValue,
                                                         java.util.function.Function<java.lang.String,T> singleValueParser,
                                                         Setting.Property... properties)

listSetting

public static <T> Setting<java.util.List<T>> listSetting(java.lang.String key,
                                                         Setting<java.util.List<T>> fallbackSetting,
                                                         java.util.function.Function<java.lang.String,T> singleValueParser,
                                                         Setting.Property... properties)

listSetting

public static <T> Setting<java.util.List<T>> listSetting(java.lang.String key,
                                                         java.util.function.Function<Settings,java.util.List<java.lang.String>> defaultStringValue,
                                                         java.util.function.Function<java.lang.String,T> singleValueParser,
                                                         Setting.Property... properties)

groupSetting

public static Setting<Settings> groupSetting(java.lang.String key,
                                             Setting.Property... properties)

groupSetting

public static Setting<Settings> groupSetting(java.lang.String key,
                                             java.util.function.Consumer<Settings> validator,
                                             Setting.Property... properties)

timeSetting

public static Setting<TimeValue> timeSetting(java.lang.String key,
                                             java.util.function.Function<Settings,java.lang.String> defaultValue,
                                             TimeValue minValue,
                                             Setting.Property... properties)

timeSetting

public static Setting<TimeValue> timeSetting(java.lang.String key,
                                             TimeValue defaultValue,
                                             TimeValue minValue,
                                             Setting.Property... properties)

timeSetting

public static Setting<TimeValue> timeSetting(java.lang.String key,
                                             TimeValue defaultValue,
                                             Setting.Property... properties)

timeSetting

public static Setting<TimeValue> timeSetting(java.lang.String key,
                                             Setting<TimeValue> fallbackSetting,
                                             Setting.Property... properties)

doubleSetting

public static Setting<java.lang.Double> doubleSetting(java.lang.String key,
                                                      double defaultValue,
                                                      double minValue,
                                                      Setting.Property... properties)

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

prefixKeySetting

public static <T> Setting<T> prefixKeySetting(java.lang.String prefix,
                                              java.lang.String defaultValue,
                                              java.util.function.Function<java.lang.String,T> parser,
                                              Setting.Property... properties)

This setting type allows to validate settings that have the same type and a common prefix. For instance feature.${type}=[true|false] can easily be added with this setting. Yet, prefix key settings don't support updaters out of the box unless getConcreteSetting(String) is used to pull the updater.

adfixKeySetting

public static <T> Setting<T> adfixKeySetting(java.lang.String prefix,
                                             java.lang.String suffix,
                                             java.util.function.Function<Settings,java.lang.String> defaultValue,
                                             java.util.function.Function<java.lang.String,T> parser,
                                             Setting.Property... properties)

This setting type allows to validate settings that have the same type and a common prefix and suffix. For instance storage.${backend}.enable=[true|false] can easily be added with this setting. Yet, adfix key settings don't support updaters out of the box unless getConcreteSetting(String) is used to pull the updater.

adfixKeySetting

public static <T> Setting<T> adfixKeySetting(java.lang.String prefix,
                                             java.lang.String suffix,
                                             java.lang.String defaultValue,
                                             java.util.function.Function<java.lang.String,T> parser,
                                             Setting.Property... properties)

affixKeySetting

public static <T> Setting<T> affixKeySetting(Setting.AffixKey key,
                                             java.util.function.Function<Settings,java.lang.String> defaultValue,
                                             java.util.function.Function<java.lang.String,T> parser,
                                             Setting.Property... properties)