io.lettuce.core.json

Interface JsonParser

All Known Implementing Classes:

DefaultJsonParser

public interface JsonParser

The JsonParser is an abstraction that allows transforming a JSON document from a ByteBuffer to implementations of the JsonValue interface and vice versa. Underneath there could be different implementations that use different JSON parser libraries or custom implementations. Respectively the JsonParser is responsible for building new instances of the JsonArray and JsonObject interfaces, as they are ultimately tightly coupled with the specific JSON parser that is being used.

A custom implementation of the JsonParser can be provided to the ClientOptions in case the default implementation does not fit the requirements.

Since:

6.5

Author:

Tihomir Mateev

Method Summary

Modifier and Type	Method and Description
JsonArray	createJsonArray() Create a new empty JsonArray.
JsonObject	createJsonObject() Create a new empty JsonObject.
JsonValue	createJsonValue(ByteBuffer bytes) Create a new JsonValue from the provided ByteBuffer.
JsonValue	createJsonValue(String value) Create a new JsonValue from the provided value.
JsonValue	fromObject(Object object) Create a new JsonValue from the provided object.
JsonValue	loadJsonValue(ByteBuffer bytes) Loads the provided ByteBuffer in a new JsonValue.

Method Detail

loadJsonValue

JsonValue loadJsonValue(ByteBuffer bytes)

Loads the provided ByteBuffer in a new JsonValue. Does not start the actual processing of the ByteBuffer until a method of the JsonValue is called.

Parameters:

bytes - the ByteBuffer to create the JsonValue from

Returns:

the created JsonValue

Throws:

RedisJsonException - if the provided ByteBuffer is not a valid JSON document

createJsonValue

JsonValue createJsonValue(ByteBuffer bytes)

Create a new JsonValue from the provided ByteBuffer.

Parameters:

bytes - the ByteBuffer to create the JsonValue from

Returns:

the created JsonValue

Throws:

RedisJsonException - if the provided ByteBuffer is not a valid JSON document

createJsonValue

JsonValue createJsonValue(String value)

Create a new JsonValue from the provided value.

Parameters:

value - the value to create the JsonValue from

Returns:

the created JsonValue

Throws:

RedisJsonException - if the provided value is not a valid JSON document

createJsonObject

JsonObject createJsonObject()

Create a new empty JsonObject.

Returns:

the created JsonObject

createJsonArray

JsonArray createJsonArray()

Create a new empty JsonArray.

Returns:

the created JsonArray

fromObject

JsonValue fromObject(Object object)

Create a new JsonValue from the provided object.

Parameters:

object - the object to create the JsonValue from

Returns:

the created JsonValue

Throws:

RedisJsonException - if the provided object is not a valid JSON document