Package org.elasticsearch.common.xcontent

Enum XContentType

java.lang.Object
java.lang.Enum<XContentType>
org.elasticsearch.common.xcontent.XContentType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<XContentType>, java.lang.constant.Constable
public enum XContentType
extends java.lang.Enum<XContentType>
The content type of XContent.

  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    CBOR
    A CBOR based content type.
    JSON
    A JSON based content type.
    SMILE
    The jackson based smile binary format.
    YAML
    A YAML based content type.

  • Method Summary

    Modifier and Type Method Description
    static XContentType fromMediaType​(java.lang.String mediaType)
    Attempts to match the given media type with the known XContentType values.
    static XContentType fromMediaTypeOrFormat​(java.lang.String mediaType)
    Accepts either a format string, which is equivalent to shortName() or a media type that optionally has parameters and attempts to match the value to an XContentType.
    int index()  
    java.lang.String mediaType()  
    abstract java.lang.String mediaTypeWithoutParameters()  
    abstract java.lang.String shortName()  
    static XContentType valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static XContentType[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    abstract XContent xContent()  

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • JSON

      public static final XContentType JSON
      A JSON based content type.

    • SMILE

      public static final XContentType SMILE
      The jackson based smile binary format. Fast and compact binary format.

    • YAML

      public static final XContentType YAML
      A YAML based content type.

    • CBOR

      public static final XContentType CBOR
      A CBOR based content type.

  • Method Details

    • values

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

    • valueOf

      public static XContentType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • fromMediaTypeOrFormat

      public static XContentType fromMediaTypeOrFormat​(java.lang.String mediaType)
      Accepts either a format string, which is equivalent to shortName() or a media type that optionally has parameters and attempts to match the value to an XContentType. The comparisons are done in lower case format and this method also supports a wildcard accept for application/*. This method can be used to parse the Accept HTTP header or a format query string parameter. This method will return null if no match is found

    • fromMediaType

      public static XContentType fromMediaType​(java.lang.String mediaType)
      Attempts to match the given media type with the known XContentType values. This match is done in a case-insensitive manner. The provided media type should not include any parameters. This method is suitable for parsing part of the Content-Type HTTP header. This method will return null if no match is found

    • index

      public int index()

    • mediaType

      public java.lang.String mediaType()

    • shortName

      public abstract java.lang.String shortName()

    • xContent

      public abstract XContent xContent()

    • mediaTypeWithoutParameters

      public abstract java.lang.String mediaTypeWithoutParameters()