Module technology.sola.json

Package technology.sola.json

Class JsonElement

java.lang.Object

technology.sola.json.JsonElement

@NullMarked
public class JsonElement
extends Object

JsonElement represents any valid JSON value. Valid JSON values include JsonObject, JsonArray, string, number, true, false and null.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonElement	NULL	Represents the JSON null value.

Constructor Summary

Constructors

Constructor	Description
JsonElement()	Creates a JsonElement with type JsonElementType.NULL.
JsonElement(@Nullable Boolean value)	Creates a JsonElement with type JsonElementType.BOOLEAN if value is non-null or JsonElementType.NULL if null.
JsonElement(@Nullable Double value)	Creates a JsonElement with type JsonElementType.DOUBLE if value is non-null or JsonElementType.NULL if null.
JsonElement(@Nullable Float value)	Creates a JsonElement with type JsonElementType.DOUBLE if value is non-null or JsonElementType.NULL if null.
JsonElement(@Nullable Integer value)	Creates a JsonElement with type JsonElementType.LONG if value is non-null or JsonElementType.NULL if null.
JsonElement(@Nullable Long value)	Creates a JsonElement with type JsonElementType.LONG if value is non-null or JsonElementType.NULL if null.
JsonElement(@Nullable String value)	Creates a JsonElement with type JsonElementType.STRING if value is non-null or JsonElementType.NULL if null.
JsonElement(@Nullable JsonArray value)	Creates a JsonElement with type JsonElementType.JSON_ARRAY if value is non-null or JsonElementType.NULL if null.
JsonElement(@Nullable JsonObject value)	Creates a JsonElement with type JsonElementType.JSON_OBJECT if value is non-null or JsonElementType.NULL if null.

Method Summary

Modifier and Type	Method	Description
JsonArray	asArray()	Returns this JsonElement's value as a JsonArray if its type is JsonElementType.JSON_ARRAY or else throws JsonElementTypeException.
boolean	asBoolean()	Returns this JsonElement's value as a boolean if its type is JsonElementType.BOOLEAN or else throws JsonElementTypeException.
double	asDouble()	Returns this JsonElement's value as a double if its type is JsonElementType.DOUBLE or else throws JsonElementTypeException.
float	asFloat()	Returns this JsonElement's value as a float if its type is JsonElementType.DOUBLE or else throws JsonElementTypeException.
int	asInt()	Returns this JsonElement's value as an int if its type is JsonElementType.LONG or else throws JsonElementTypeException.
long	asLong()	Returns this JsonElement's value as a long if its type is JsonElementType.LONG or else throws JsonElementTypeException.
JsonObject	asObject()	Returns this JsonElement's value as a JsonObject if its type is JsonElementType.JSON_OBJECT or else throws JsonElementTypeException.
String	asString()	Returns this JsonElement's value as a String if its type is JsonElementType.STRING or else throws JsonElementTypeException.
JsonElementType	getType()
boolean	isNull()
String	toString()	Formats this JsonElement as a string with no indentation.
String	toString(int spaces)	Formats this JsonElement as a string with specified spaces for indentation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NULL

public static final JsonElement NULL

Represents the JSON null value.

Constructor Details

JsonElement

public JsonElement()

Creates a JsonElement with type JsonElementType.NULL.

JsonElement

public JsonElement(@Nullable Integer value)

Creates a JsonElement with type JsonElementType.LONG if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

JsonElement

public JsonElement(@Nullable Long value)

Creates a JsonElement with type JsonElementType.LONG if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

JsonElement

public JsonElement(@Nullable Float value)

Creates a JsonElement with type JsonElementType.DOUBLE if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

JsonElement

public JsonElement(@Nullable Double value)

Creates a JsonElement with type JsonElementType.DOUBLE if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

JsonElement

public JsonElement(@Nullable String value)

Creates a JsonElement with type JsonElementType.STRING if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

JsonElement

public JsonElement(@Nullable JsonObject value)

Creates a JsonElement with type JsonElementType.JSON_OBJECT if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

JsonElement

public JsonElement(@Nullable JsonArray value)

Creates a JsonElement with type JsonElementType.JSON_ARRAY if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

JsonElement

public JsonElement(@Nullable Boolean value)

Creates a JsonElement with type JsonElementType.BOOLEAN if value is non-null or JsonElementType.NULL if null.

Parameters:

value - the value of the JsonElement

Method Details

asBoolean

public boolean asBoolean()

Returns this JsonElement's value as a boolean if its type is JsonElementType.BOOLEAN or else throws JsonElementTypeException.

Returns:

value as boolean

asInt

public int asInt()

Returns this JsonElement's value as an int if its type is JsonElementType.LONG or else throws JsonElementTypeException.

Returns:

value as int

asLong

public long asLong()

Returns this JsonElement's value as a long if its type is JsonElementType.LONG or else throws JsonElementTypeException.

Returns:

value as long

asFloat

public float asFloat()

Returns this JsonElement's value as a float if its type is JsonElementType.DOUBLE or else throws JsonElementTypeException.

Returns:

value as float

asDouble

public double asDouble()

Returns this JsonElement's value as a double if its type is JsonElementType.DOUBLE or else throws JsonElementTypeException.

Returns:

value as double

asString

public String asString()

Returns this JsonElement's value as a String if its type is JsonElementType.STRING or else throws JsonElementTypeException.

Returns:

value as String

asObject

public JsonObject asObject()

Returns this JsonElement's value as a JsonObject if its type is JsonElementType.JSON_OBJECT or else throws JsonElementTypeException.

Returns:

value as JsonObject

asArray

public JsonArray asArray()

Returns this JsonElement's value as a JsonArray if its type is JsonElementType.JSON_ARRAY or else throws JsonElementTypeException.

Returns:

value as JsonArray

isNull

public boolean isNull()

Returns:

true if this JsonElement's type is JsonElementType.NULL

getType

public JsonElementType getType()

Returns:

the type of this JsonElement

toString

public String toString()

Formats this JsonElement as a string with no indentation.

Overrides:

toString in class Object

Returns:

formatted JSON string

toString

public String toString(int spaces)

Formats this JsonElement as a string with specified spaces for indentation.

Parameters:

spaces - the spaces for each indentation

Returns:

formatted JSON string with spaces for indentation