Package co.elastic.clients.json

Interface JsonpMapper

All Known Subinterfaces:
BufferingJsonpMapper
All Known Implementing Classes:
DelegatingJsonpMapper, JacksonJsonpMapper, JsonbJsonpMapper, JsonpMapperBase, SimpleJsonpMapper
public interface JsonpMapper
A JsonpMapper combines a JSON-P provider and object serialization/deserialization based on JSON-P events.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> T
    attribute(String name)
    Get a named attribute associated to this mapper.
    default <T> T
    attribute(String name, T defaultValue)
    Get a named attribute associated to this mapper, with a default value.
    default <T> T
    deserialize(jakarta.json.stream.JsonParser parser, Class<T> clazz)
    Deserialize an object, given its class.
    default <T> T
    deserialize(jakarta.json.stream.JsonParser parser, Class<T> clazz, jakarta.json.stream.JsonParser.Event event)
    Deserialize an object, given its class and the current event the parser is at.
    <T> T
    deserialize(jakarta.json.stream.JsonParser parser, Type type)
    Deserialize an object, given its type.
    <T> T
    deserialize(jakarta.json.stream.JsonParser parser, Type type, jakarta.json.stream.JsonParser.Event event)
    Deserialize an object, given its type and the current event the parser is at.
    default boolean
    ignoreUnknownFields()
    Should object parsers in the API client be lenient and silently ignore unknown fields?
    jakarta.json.spi.JsonProvider
    jsonProvider()
    Return the JSON-P provider, to create JSON parsers and generators.
    <T> void
    serialize(T value, jakarta.json.stream.JsonGenerator generator)
    Serialize an object.
    <T> JsonpMapper
    withAttribute(String name, T value)
    Create a new mapper with an additional attribute.

  • Method Details

    • jsonProvider

      jakarta.json.spi.JsonProvider jsonProvider()
      Return the JSON-P provider, to create JSON parsers and generators.

    • deserialize

      default <T> T deserialize(jakarta.json.stream.JsonParser parser, Class<T> clazz)
      Deserialize an object, given its class.

    • deserialize

      <T> T deserialize(jakarta.json.stream.JsonParser parser, Type type)
      Deserialize an object, given its type.

    • deserialize

      default <T> T deserialize(jakarta.json.stream.JsonParser parser, Class<T> clazz, jakarta.json.stream.JsonParser.Event event)
      Deserialize an object, given its class and the current event the parser is at.

    • deserialize

      <T> T deserialize(jakarta.json.stream.JsonParser parser, Type type, jakarta.json.stream.JsonParser.Event event)
      Deserialize an object, given its type and the current event the parser is at.

    • serialize

      <T> void serialize(T value, jakarta.json.stream.JsonGenerator generator)
      Serialize an object.

    • ignoreUnknownFields

      default boolean ignoreUnknownFields()
      Should object parsers in the API client be lenient and silently ignore unknown fields?
      Returns:
      true by default.

    • attribute

      @Nullable default <T> T attribute(String name)
      Get a named attribute associated to this mapper.

    • attribute

      default <T> T attribute(String name, T defaultValue)
      Get a named attribute associated to this mapper, with a default value.

    • withAttribute

      <T> JsonpMapper withAttribute(String name, T value)
      Create a new mapper with an additional attribute.

      The JsonpMapperFeatures class contains the names of attributes that all implementations of JsonpMapper must implement.

      See Also: