io.lettuce.core.json

Interface JsonValue

All Known Subinterfaces:

JsonArray, JsonObject

public interface JsonValue

Representation of a JSON text as per the RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format, Section 3. Values

Implementations of this interface need to make sure parsing of the JSON is not done inside the event loop thread, used to process the data coming from the Redis server; otherwise larger JSON documents might cause performance degradation that spans across all threads using the driver.

Since:

6.5

Author:

Tihomir Mateev

See Also:

JsonObject, JsonArray, RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format

Method Summary

Modifier and Type	Method and Description
Boolean	asBoolean()
ByteBuffer	asByteBuffer()
JsonArray	asJsonArray()
JsonObject	asJsonObject()
Number	asNumber()
String	asString()
boolean	isBoolean()
boolean	isJsonArray()
boolean	isJsonObject()
boolean	isNull()
boolean	isNumber()
boolean	isString()
<T> T	toObject(Class<T> type) Given a Class type, this method will attempt to convert the JSON value to the provided type.
String	toString() Execute any RedisCodec decoding and fetch the result.

Method Detail

toString

String toString()

Execute any RedisCodec decoding and fetch the result.

Overrides:

toString in class Object

Returns:

the String representation of this JsonValue

asByteBuffer

ByteBuffer asByteBuffer()

Returns:

the raw JSON text as a ByteBuffer

isJsonArray

boolean isJsonArray()

Returns:

true if this JsonValue represents a JSON array

asJsonArray

JsonArray asJsonArray()

Returns:

the JsonArray representation of this JsonValue, null if this is not a JSON array

See Also:

isJsonArray()

isJsonObject

boolean isJsonObject()

Returns:

true if this JsonValue represents a JSON object

asJsonObject

JsonObject asJsonObject()

Returns:

the JsonObject representation of this JsonValue, null if this is not a JSON object

See Also:

isJsonObject()

isString

boolean isString()

Returns:

true if this JsonValue represents a JSON string

asString

String asString()

Returns:

the String representation of this JsonValue, null if this is not a JSON string

See Also:

isString()

isNumber

boolean isNumber()

Returns:

true if this JsonValue represents a JSON number

asNumber

Number asNumber()

Returns:

the Number representation of this JsonValue, null if this is not a JSON number

See Also:

isNumber()

isBoolean

boolean isBoolean()

Returns:

true if this JsonValue represents a JSON boolean value

asBoolean

Boolean asBoolean()

Returns:

the Boolean representation of this JsonValue, null if this is not a JSON boolean value

See Also:

isNumber()

isNull

boolean isNull()

Returns:

true if this JsonValue represents the value of null

toObject

<T> T toObject(Class<T> type)

Given a Class type, this method will attempt to convert the JSON value to the provided type.

Returns:

the newly created instance of the provided type with the data from the JSON value

Throws:

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