Package jakarta.json

Interface JsonValue

All Known Subinterfaces:
JsonArray, JsonNumber, JsonObject, JsonString, JsonStructure
public interface JsonValue
JsonValue represents an immutable JSON value.

A JSON value is one of the following: an object (JsonObject), an array (JsonArray), a number (JsonNumber), a string (JsonString), true (JsonValue.TRUE), false (JsonValue.FALSE), or null (JsonValue.NULL).

  • Field Details

    • EMPTY_JSON_OBJECT

      static final JsonObject EMPTY_JSON_OBJECT
      The empty JSON object.
      Since:
      1.1

    • EMPTY_JSON_ARRAY

      static final JsonArray EMPTY_JSON_ARRAY
      The empty JSON array.
      Since:
      1.1

    • NULL

      static final JsonValue NULL
      JSON null value.

    • TRUE

      static final JsonValue TRUE
      JSON true value.

    • FALSE

      static final JsonValue FALSE
      JSON false value.

  • Method Details

    • getValueType

      JsonValue.ValueType getValueType()
      Returns the value type of this JSON value.
      Returns:
      JSON value type

    • asJsonObject

      default JsonObject asJsonObject()
      Return the JsonValue as a JsonObject
      Returns:
      the JsonValue as a JsonObject
      Throws:
      ClassCastException - if the JsonValue is not a JsonObject
      Since:
      1.1

    • asJsonArray

      default JsonArray asJsonArray()
      Return the JsonValue as a JsonArray
      Returns:
      the JsonValue as a JsonArray
      Throws:
      ClassCastException - if the JsonValue is not a JsonArray
      Since:
      1.1

    • toString

      String toString()
      Returns JSON text for this JSON value.
      Overrides:
      toString in class Object
      Returns:
      JSON text