com.sap.cloud.server.odata.json

Class JsonElement

java.lang.Object

com.sap.cloud.server.odata.json.JsonElement

Direct Known Subclasses:

JsonArray, JsonBoolean, JsonNumber, JsonObject, JsonString

public abstract class JsonElement
extends java.lang.Object

Abstract base class for JSON elements (boolean, number, string, array, object). JSON also permits null values; where appropriate a nullable JsonElement (type JsonElement?) should be used.

See Also:

JsonBoolean, JsonNumber, JsonString, JsonArray, JsonObject, JsonElementStream.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_ARRAY Type code for JSON array values.
static int	TYPE_BOOLEAN Type code for JSON boolean values.
static int	TYPE_NUMBER Type code for JSON number values.
static int	TYPE_OBJECT Type code for JSON object values.
static int	TYPE_STRING Type code for JSON string values.

Constructor Summary

Constructors

Constructor and Description
JsonElement()

Method Summary

Modifier and Type	Method and Description
static JsonElement	applyVersion(int version, JsonElement toElement) Apply version (recursively) to all JsonObject instances within toElement.
static java.lang.String	format(JsonElement element) Return JSON element (including null) converted to a string.
abstract int	getType() Return type of JSON element.
static JsonElement	parse(java.lang.String text) Return (nullable) String converted to parsed JSON element (including null).
static JsonArray	parseArray(java.lang.String text) Return string converted to parsed JSON array.
static JsonObject	parseObject(java.lang.String text) Return string converted to parsed JSON object.
static JsonElement	parseOptimized(java.lang.String text, boolean optimized) Return (nullable) String converted to parsed JSON element (including null).
abstract java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

Type code for JSON boolean values.

See Also:

Constant Field Values

TYPE_NUMBER

public static final int TYPE_NUMBER

Type code for JSON number values.

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

Type code for JSON string values.

See Also:

Constant Field Values

TYPE_ARRAY

public static final int TYPE_ARRAY

Type code for JSON array values.

See Also:

Constant Field Values

TYPE_OBJECT

public static final int TYPE_OBJECT

Type code for JSON object values.

See Also:

Constant Field Values

Constructor Detail

JsonElement

public JsonElement()

Method Detail

applyVersion

public static JsonElement applyVersion(int version,
                                       JsonElement toElement)

Apply version (recursively) to all JsonObject instances within toElement.

See Also:

DataVersion, JsonObject.withVersion.

Parameters:

version - Data version.

toElement - (nullable) Element to which version should be applied.

Returns:

(nullable) `toElement`.

format

public static java.lang.String format(JsonElement element)

Return JSON element (including null) converted to a string.

Parameters:

element - (nullable) JSON element.

Returns:

JSON element (including null) converted to a string.

getType

public abstract int getType()

Return type of JSON element.

See Also:

constants.

Returns:

Type of JSON element.

parse

public static JsonElement parse(java.lang.String text)

Return (nullable) String converted to parsed JSON element (including null).

Parameters:

text - Text to be parsed. Must be in JSON element format (null, boolean, number, string, array or object).

Returns:

(nullable) String converted to parsed JSON element (including null).

parseArray

public static JsonArray parseArray(java.lang.String text)

Return string converted to parsed JSON array.

Parameters:

text - Text to be parsed. Must be in JSON array format.

Returns:

String converted to parsed JSON array.

parseObject

public static JsonObject parseObject(java.lang.String text)

Return string converted to parsed JSON object.

Parameters:

text - Text to be parsed. Must be in JSON object format.

Returns:

String converted to parsed JSON object.

parseOptimized

public static JsonElement parseOptimized(java.lang.String text,
                                         boolean optimized)

Return (nullable) String converted to parsed JSON element (including null). If optimized is true, any returned JSON objects will use JsonObject.optimizedEntries to contain key/value pairs for all JSON fields whose name does not contain "@", rather than regular map entries.

Parameters:

text - Text to be parsed. Must be in JSON element format (null, boolean, number, string, array or object).

optimized - Should "property" (non-annotation) entries of JSON objects be held in JsonObject.optimizedEntries.

Returns:

(nullable) String converted to parsed JSON element (including null).

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object