Interface JSONValue

All Superinterfaces:

Formattable

All Known Subinterfaces:

JSONArray, JSONNumber, JSONObject, JSONString

All Known Implementing Classes:

JSONArrayImpl, JSONLiteral, JSONNumberImpl, JSONObjectImpl, JSONStringImpl

@ClassVersion(sourceVersion="$Id: JSONValue.java 1258 2026-06-04 18:33:06Z tquadrat $")
@API(status=STABLE,
     since="0.25.0")
public sealed interface JSONValue
extends Formattable
permits JSONArray, JSONLiteral, JSONNumber, JSONObject, JSONString

This interface describes the base for all the JSON datatypes.

JSONValue implements Formattable for the implementation of pretty-printed output through String.format( "%s", value ) or similar.

formatTo(Formatter,int,int,int) ignores the arguments flags and precision, while the width argument is used internally. Therefore, a call like String.format( "%10s", value ) may result in some unexpected output.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: JSONValue.java 1258 2026-06-04 18:33:06Z tquadrat $

Since:

0.25.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.jsonbuilder.JSONValue"

⁠

Method Summary

Modifier and Type	Method	Description
default JSONArray	asArray()	Returns this JSON value as JSONArray, assuming that this value represents a JSON array.
default JSONLiteral	asBoolean()	Returns this JSON value as JSON literals false or true, assuming that this value represents a JSON Boolean.
default JSONNumber	asNumber()	Returns this JSON value as JSONNumber, assuming that this value represents a JSON number.
default JSONObject	asObject()	Returns this JSON value as JSONObject, assuming that this value represents a JSON object.
default JSONString	asString()	Returns this JSON value as JSONString, assuming that this value represents a JSON String.
void	formatTo(Formatter formatter, int flags, int width, int precision)
default boolean	isArray()	Detects whether this value represents a JSON array.
default boolean	isBoolean()	Detects whether this value represents a boolean value.
default boolean	isFalse()	Detects whether this value represents the JSON literal false.
default boolean	isNull()	Detects whether this value represents the JSON literal null.
default boolean	isNumber()	Detects whether this value represents a JSON number.
default boolean	isObject()	Detects whether this value represents a JSON object.
default boolean	isString()	Detects whether this value represents a JSON string.
default boolean	isTrue()	Detects whether this value represents the JSON literal true.
String	toString()

Method Details

asArray

default JSONArray asArray()

Returns this JSON value as JSONArray, assuming that this value represents a JSON array. If this is not the case, an IllegalStateException is thrown.

Returns:

This JSONValue instance as a JSONArray.

Throws:

IllegalStateException - This JSON value is not a JSON array.

asBoolean

default JSONLiteral asBoolean()

Returns this JSON value as JSON literals false or true, assuming that this value represents a JSON Boolean. If this is not the case, an IllegalStateException is thrown.

Returns:

This JSONValue instance as a JSONLiteral.

Throws:

IllegalStateException - This JSON value is not a JSON Boolean.

asNumber

default JSONNumber asNumber()

Returns this JSON value as JSONNumber, assuming that this value represents a JSON number. If this is not the case, an IllegalStateException is thrown.

Returns:

This JSONValue instance as a JSONNumber.

Throws:

IllegalStateException - This JSON value is not a JSON String.

asObject

default JSONObject asObject()

Returns this JSON value as JSONObject, assuming that this value represents a JSON object. If this is not the case, an IllegalStateException is thrown.

Returns:

This JSONValue instance as a JSONObject.

Throws:

IllegalStateException - This JSON value is not a JSON object.

asString

default JSONString asString()

Returns this JSON value as JSONString, assuming that this value represents a JSON String. If this is not the case, an IllegalStateException is thrown.

Returns:

This JSONValue instance as a JSONString.

Throws:

IllegalStateException - This JSON value is not a JSON String.

formatTo

void formatTo(Formatter formatter,
 int flags,
 int width,
 int precision)

Specified by:

formatTo in interface Formattable

isBoolean

default boolean isBoolean()

Detects whether this value represents a boolean value.

Returns:

true if this value represents either the JSON literal true or JSONLiteral.FALSE.

isArray

default boolean isArray()

Detects whether this value represents a JSON array. If this is the case, this value is an instance of JSONArray.

Returns:

true if this value is an instance of JSONArray, false otherwise.

isFalse

default boolean isFalse()

Detects whether this value represents the JSON literal false.

Returns:

true if this value represents the JSON literal false.

isNull

default boolean isNull()

Detects whether this value represents the JSON literal null.

Returns:

true if this value represents the JSON literal null.

isNumber

default boolean isNumber()

Detects whether this value represents a JSON number. If this is the case, this value is an instance of JSONNumber.

Returns:

true if this value is an instance of JSONObject, false otherwise.

isObject

default boolean isObject()

Detects whether this value represents a JSON object. If this is the case, this value is an instance of JSONObject.

Returns:

true if this value is an instance of JSONObject, false otherwise.

isString

default boolean isString()

Detects whether this value represents a JSON string. If this is the case, this value is an instance of JSONString.

Returns:

true if this value is an instance of JSONString, false otherwise.

isTrue

default boolean isTrue()

Detects whether this value represents the JSON literal true.

Returns:

true if this value represents the JSON literal true.

toString

String toString()

Overrides:

toString in class Object