io.lettuce.core.json.JsonValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lettuce-core Show documentation

Advanced and thread-safe Java Redis client for synchronous, asynchronous, and reactive usage. Supports Cluster, Sentinel, Pipelining, Auto-Reconnect, Codecs and much more.

The newest version!

/*
 * Copyright 2024, Redis Ltd. and Contributors
 * All rights reserved.
 *
 * Licensed under the MIT License.
 */

package io.lettuce.core.json;

import java.nio.ByteBuffer;

/**
 * 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.
 *
 * @see JsonObject
 * @see JsonArray
 * @see RFC 8259 - The JavaScript Object Notation (JSON) Data
 *      Interchange Format
 * @author Tihomir Mateev
 * @since 6.5
 */
public interface JsonValue {

    /**
     * Execute any {@link io.lettuce.core.codec.RedisCodec} decoding and fetch the result.
     * 
     * @return the {@link String} representation of this {@link JsonValue}
     */
    String toString();

    /**
     * @return the raw JSON text as a {@link ByteBuffer}
     */
    ByteBuffer asByteBuffer();

    /**
     * @return {@code true} if this {@link JsonValue} represents a JSON array
     */
    boolean isJsonArray();

    /**
     * @return the {@link JsonArray} representation of this {@link JsonValue}, null if this is not a JSON array
     * @see #isJsonArray()
     */
    JsonArray asJsonArray();

    /**
     * @return {@code true} if this {@link JsonValue} represents a JSON object
     */
    boolean isJsonObject();

    /**
     * @return the {@link JsonObject} representation of this {@link JsonValue}, null if this is not a JSON object
     * @see #isJsonObject()
     */
    JsonObject asJsonObject();

    /**
     * @return {@code true} if this {@link JsonValue} represents a JSON string
     */
    boolean isString();

    /**
     * @return the {@link String} representation of this {@link JsonValue}, null if this is not a JSON string
     * @see #isString()
     */
    String asString();

    /**
     * @return {@code true} if this {@link JsonValue} represents a JSON number
     */
    boolean isNumber();

    /**
     * @return the {@link Number} representation of this {@link JsonValue}, null if this is not a JSON number
     * @see #isNumber()
     */
    Number asNumber();

    /**
     * @return {@code true} if this {@link JsonValue} represents a JSON boolean value
     */
    boolean isBoolean();

    /**
     * @return the {@link Boolean} representation of this {@link JsonValue}, null if this is not a JSON boolean value
     * @see #isNumber()
     */
    Boolean asBoolean();

    /**
     * @return {@code true} if this {@link JsonValue} represents the value of null
     */
    boolean isNull();

    /**
     * Given a {@link Class} type, this method will attempt to convert the JSON value to the provided type.
     * 
     * @return  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
     */
     T toObject(Class type);

}