javax.json

Interface JsonObject

All Superinterfaces:

JsonStructure, JsonValue, Map<String,JsonValue>

public interface JsonObject
extends JsonStructure, Map<String,JsonValue>

A JsonObject, e.g.

 {
     "name":"karl",
     "age":38,
     "address": {
         "street":"dummystreet"
         "housenumber":12
     }
 }
 

A JsonObject is always also a Map which uses the attribute names as key mapping to their JsonValues.

Nested Class Summary

Nested classes/interfaces inherited from interface javax.json.JsonValue

JsonValue.ValueType

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from interface javax.json.JsonValue

EMPTY_JSON_ARRAY, EMPTY_JSON_OBJECT, FALSE, NULL, TRUE

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(String name)
boolean	getBoolean(String name, boolean defaultValue)
int	getInt(String name)
int	getInt(String name, int defaultValue)
JsonArray	getJsonArray(String name)
JsonNumber	getJsonNumber(String name)
JsonObject	getJsonObject(String name)
JsonString	getJsonString(String name)
String	getString(String name)
String	getString(String name, String defaultValue)
boolean	isNull(String name)

Methods inherited from interface javax.json.JsonStructure

getValue

Methods inherited from interface javax.json.JsonValue

asJsonArray, asJsonObject, getValueType, toString

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getJsonArray

JsonArray getJsonArray(String name)

Returns:

the JsonArray with the given name or null if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

getJsonObject

JsonObject getJsonObject(String name)

Returns:

the JsonObject with the given name or null if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

getJsonNumber

JsonNumber getJsonNumber(String name)

Returns:

the JsonNumber with the given name or null if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

getJsonString

JsonString getJsonString(String name)

Returns:

the JsonString with the given name or null if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

getString

String getString(String name)

Returns:

the native string with the given name or null if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

getString

String getString(String name,
                 String defaultValue)

Returns:

the native string with the given name or the default value if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

getInt

int getInt(String name)

Returns:

the int with the given name or null if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

NullPointerException - if an object with the given name doesn't exist

getInt

int getInt(String name,
           int defaultValue)

Returns:

the int with the given name or the default value if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

getBoolean

boolean getBoolean(String name)

Returns:

the boolean with the given name or null if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

NullPointerException - if an object with the given name doesn't exist

getBoolean

boolean getBoolean(String name,
                   boolean defaultValue)

Returns:

the boolean with the given name or the default value if there is no attribute with that name

Throws:

ClassCastException - if the JsonValue cannot be correctly cast

isNull

boolean isNull(String name)

Returns:

whether the attribute with the given name is JsonValue.NULL