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 a null value
    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 values true or false
    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
    T getValue()
    Returns the current value of the parameter
    void setValue​(T value)
    Sets the current value of the parameter
    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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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 serialization
      updateable - whether the parameter can be updated with a new value during a mapping update
      defaultValue - the default value for the parameter, used if unspecified in mappings
      parser - a function that converts an object to a parameter value
      initializer - a function that reads a parameter value from an existing mapper

  • Method Details

    • getValue

      public T getValue()
      Returns the current value of the parameter

    • setValue

      public void setValue​(T value)
      Sets the current value of the parameter

    • acceptsNull

      public ParametrizedFieldMapper.Parameter<T> acceptsNull()
      Allows the parameter to accept a null 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 values true or false
      Parameters:
      name - the parameter name
      updateable - whether the parameter can be changed by a mapping update
      initializer - a function that reads the parameter value from an existing mapper
      defaultValue - 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 name
      updateable - whether the parameter can be changed by a mapping update
      initializer - a function that reads the parameter value from an existing mapper
      defaultValue - 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 name
      updateable - whether the parameter can be changed by a mapping update
      initializer - a function that reads the parameter value from an existing mapper
      defaultValue - the default value, to be used if the parameter is undefined in a mapping