Package org.elasticsearch.index.mapper
Class ParametrizedFieldMapper.Parameter<T>
java.lang.Object
org.elasticsearch.index.mapper.ParametrizedFieldMapper.Parameter<T>
- Type Parameters:
T
- the type of the value the parameter holds
- Enclosing class:
- ParametrizedFieldMapper
public static final class ParametrizedFieldMapper.Parameter<T>
extends java.lang.Object
A configurable parameter for a field mapper
-
Field Summary
Fields Modifier and Type Field Description java.lang.String
name
-
Constructor Summary
Constructors Constructor Description Parameter(java.lang.String name, boolean updateable, T defaultValue, java.util.function.BiFunction<java.lang.String,java.lang.Object,T> parser, java.util.function.Function<FieldMapper,T> initializer)
Creates a new Parameter -
Method Summary
Modifier and Type Method Description ParametrizedFieldMapper.Parameter<T>
acceptsNull()
Allows the parameter to accept anull
valuestatic ParametrizedFieldMapper.Parameter<java.lang.Boolean>
boolParam(java.lang.String name, boolean updateable, java.util.function.Function<FieldMapper,java.lang.Boolean> initializer, boolean defaultValue)
Defines a parameter that takes the valuestrue
orfalse
static ParametrizedFieldMapper.Parameter<java.lang.Float>
floatParam(java.lang.String name, boolean updateable, java.util.function.Function<FieldMapper,java.lang.Float> initializer, float defaultValue)
Defines a parameter that takes a float valueT
getValue()
Returns the current value of the parametervoid
setValue(T value)
Sets the current value of the parameterstatic ParametrizedFieldMapper.Parameter<java.lang.String>
stringParam(java.lang.String name, boolean updateable, java.util.function.Function<FieldMapper,java.lang.String> initializer, java.lang.String defaultValue)
Defines a parameter that takes a string value
-
Field Details
-
name
public final java.lang.String name
-
-
Constructor Details
-
Parameter
public Parameter(java.lang.String name, boolean updateable, T defaultValue, java.util.function.BiFunction<java.lang.String,java.lang.Object,T> parser, java.util.function.Function<FieldMapper,T> initializer)Creates a new Parameter- Parameters:
name
- the parameter name, used in parsing and serializationupdateable
- whether the parameter can be updated with a new value during a mapping updatedefaultValue
- the default value for the parameter, used if unspecified in mappingsparser
- a function that converts an object to a parameter valueinitializer
- a function that reads a parameter value from an existing mapper
-
-
Method Details
-
getValue
Returns the current value of the parameter -
setValue
Sets the current value of the parameter -
acceptsNull
Allows the parameter to accept anull
value -
boolParam
public static ParametrizedFieldMapper.Parameter<java.lang.Boolean> boolParam(java.lang.String name, boolean updateable, java.util.function.Function<FieldMapper,java.lang.Boolean> initializer, boolean defaultValue)Defines a parameter that takes the valuestrue
orfalse
- Parameters:
name
- the parameter nameupdateable
- whether the parameter can be changed by a mapping updateinitializer
- a function that reads the parameter value from an existing mapperdefaultValue
- the default value, to be used if the parameter is undefined in a mapping
-
floatParam
public static ParametrizedFieldMapper.Parameter<java.lang.Float> floatParam(java.lang.String name, boolean updateable, java.util.function.Function<FieldMapper,java.lang.Float> initializer, float defaultValue)Defines a parameter that takes a float value- Parameters:
name
- the parameter nameupdateable
- whether the parameter can be changed by a mapping updateinitializer
- a function that reads the parameter value from an existing mapperdefaultValue
- the default value, to be used if the parameter is undefined in a mapping
-
stringParam
public static ParametrizedFieldMapper.Parameter<java.lang.String> stringParam(java.lang.String name, boolean updateable, java.util.function.Function<FieldMapper,java.lang.String> initializer, java.lang.String defaultValue)Defines a parameter that takes a string value- Parameters:
name
- the parameter nameupdateable
- whether the parameter can be changed by a mapping updateinitializer
- a function that reads the parameter value from an existing mapperdefaultValue
- the default value, to be used if the parameter is undefined in a mapping
-