Package org.elasticsearch.common.xcontent

Class ParseFieldRegistry<T>

java.lang.Object
org.elasticsearch.common.xcontent.ParseFieldRegistry<T>
public class ParseFieldRegistry<T> extends Object
Registry for looking things up using ParseField semantics.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParseFieldRegistry(String registryName)
    Build the registry.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getNames()
    All the names under which values are registered.
    T
    lookup(String name, org.elasticsearch.common.xcontent.XContentLocation xContentLocation, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)
    Lookup a value from the registry by name while checking that the name matches the ParseField.
    T
    lookupReturningNullIfNotFound(String name, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)
    Lookup a value from the registry by name while checking that the name matches the ParseField.
    void
    register(T value, String name)
    Register a parser.
    void
    register(T value, org.elasticsearch.common.xcontent.ParseField parseField)
    Register a parser.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ParseFieldRegistry

      public ParseFieldRegistry(String registryName)
      Build the registry.
      Parameters:
      registryName - used for error messages

  • Method Details

    • getNames

      public Set<String> getNames()
      All the names under which values are registered. Expect this to be used mostly for testing.

    • register

      public void register(T value, String name)
      Register a parser.

    • register

      public void register(T value, org.elasticsearch.common.xcontent.ParseField parseField)
      Register a parser.

    • lookup

      public T lookup(String name, org.elasticsearch.common.xcontent.XContentLocation xContentLocation, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)
      Lookup a value from the registry by name while checking that the name matches the ParseField.
      Parameters:
      name - The name of the thing to look up.
      Returns:
      The value being looked up. Never null.
      Throws:
      ParsingException - if the named thing isn't in the registry or the name was deprecated and deprecated names aren't supported.

    • lookupReturningNullIfNotFound

      public T lookupReturningNullIfNotFound(String name, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)
      Lookup a value from the registry by name while checking that the name matches the ParseField.
      Parameters:
      name - The name of the thing to look up.
      Returns:
      The value being looked up or null if it wasn't found.
      Throws:
      ParsingException - if the named thing isn't in the registry or the name was deprecated and deprecated names aren't supported.