Interface JsonData

All Superinterfaces:
JsonpSerializable

@JsonpDeserializable
public interface JsonData
extends JsonpSerializable
A raw JSON value. It can be converted to a JSON node tree or to an arbitrary object using a JsonpMapper.

This type is used in API types for values that don't have a statically-defined type or that cannot be represented as a generic parameter of the enclosing data structure.

Instances of this class returned by API clients keep a reference to the client's JsonpMapper and can be converted to arbitrary types using to(Class) without requiring an explicit mapper.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static JsonpDeserializer<JsonData> _DESERIALIZER  
  • Method Summary

    Modifier and Type Method Description
    <T> T deserialize​(JsonpDeserializer<T> deserializer)
    Converts this object using a deserializer.
    <T> T deserialize​(JsonpDeserializer<T> deserializer, JsonpMapper mapper)
    Converts this object using a deserializer.
    static JsonData from​(jakarta.json.stream.JsonParser parser, JsonpMapper mapper)
    Creates a raw JSON value from a parser.
    static <T> JsonData of​(T value)
    Creates a raw JSON value from an existing object.
    static <T> JsonData of​(T value, JsonpMapper mapper)
    Creates a raw JSON value from an existing object, along with the mapper to use for further conversions.
    <T> T to​(java.lang.Class<T> clazz)
    Converts this object to a target class.
    <T> T to​(java.lang.Class<T> clazz, JsonpMapper mapper)
    Converts this object to a target class.
    jakarta.json.JsonValue toJson()
    Converts this object to a JSON node tree.
    jakarta.json.JsonValue toJson​(JsonpMapper mapper)
    Converts this object to a JSON node tree.

    Methods inherited from interface co.elastic.clients.json.JsonpSerializable

    serialize
  • Field Details

  • Method Details

    • toJson

      jakarta.json.JsonValue toJson()
      Converts this object to a JSON node tree. A mapper must have been provided at creation time.
      Throws:
      java.lang.IllegalStateException - if no mapper was provided at creation time.
    • toJson

      jakarta.json.JsonValue toJson​(JsonpMapper mapper)
      Converts this object to a JSON node tree.
    • to

      <T> T to​(java.lang.Class<T> clazz)
      Converts this object to a target class. A mapper must have been provided at creation time.
      Throws:
      java.lang.IllegalStateException - if no mapper was provided at creation time.
    • to

      <T> T to​(java.lang.Class<T> clazz, JsonpMapper mapper)
      Converts this object to a target class.
    • deserialize

      <T> T deserialize​(JsonpDeserializer<T> deserializer)
      Converts this object using a deserializer. A mapper must have been provided at creation time.
      Throws:
      java.lang.IllegalStateException - if no mapper was provided at creation time.
    • deserialize

      <T> T deserialize​(JsonpDeserializer<T> deserializer, JsonpMapper mapper)
      Converts this object using a deserializer.
    • of

      static <T> JsonData of​(T value)
      Creates a raw JSON value from an existing object. A mapper will be needed to convert the result.
    • of

      static <T> JsonData of​(T value, JsonpMapper mapper)
      Creates a raw JSON value from an existing object, along with the mapper to use for further conversions.
    • from

      static JsonData from​(jakarta.json.stream.JsonParser parser, JsonpMapper mapper)
      Creates a raw JSON value from a parser. The provider mapper will be used for conversions unless one is explicitly provided using to(Class, JsonpMapper), toJson(JsonpMapper) or deserialize(JsonpDeserializer).