Enum Class GeometryParserFormat

java.lang.Object
java.lang.Enum<GeometryParserFormat>
org.elasticsearch.common.geo.GeometryParserFormat
All Implemented Interfaces:
Serializable, Comparable<GeometryParserFormat>, Constable

public enum GeometryParserFormat extends Enum<GeometryParserFormat>
Supported formats to read/write JSON geometries.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.elasticsearch.geometry.Geometry
    fromXContent​(org.elasticsearch.geometry.utils.GeometryValidator validator, boolean coerce, boolean rightOrientation, org.elasticsearch.common.xcontent.XContentParser parser)
    Parser JSON representation of a geometry
    geometryFormat​(org.elasticsearch.common.xcontent.XContentParser parser)
    Returns a geometry parser format object that can parse and then serialize the object back to the same format.
    abstract org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.geometry.Geometry geometry, org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
    Serializes the geometry into its JSON representation
    valueOf​(String name)
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

  • Method Details

    • values

      public static GeometryParserFormat[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static GeometryParserFormat valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • toXContent

      public abstract org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.geometry.Geometry geometry, org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Serializes the geometry into its JSON representation
      Throws:
      IOException
    • fromXContent

      public abstract org.elasticsearch.geometry.Geometry fromXContent(org.elasticsearch.geometry.utils.GeometryValidator validator, boolean coerce, boolean rightOrientation, org.elasticsearch.common.xcontent.XContentParser parser) throws IOException, ParseException
      Parser JSON representation of a geometry
      Throws:
      IOException
      ParseException
    • geometryFormat

      public static GeometryParserFormat geometryFormat(org.elasticsearch.common.xcontent.XContentParser parser)
      Returns a geometry parser format object that can parse and then serialize the object back to the same format. This method automatically recognizes the format by examining the provided XContentParser.