public final class JsonObject extends JsonValue
get
and opt
methods for accessing the values by name, and put
methods for adding or replacing
values by name. The values can be any of these types: Boolean
,
JsonArray
, JsonObject
, Number
, String
, or the
JsonObject.NULL
beginObject. A JsonObject constructor can be used to convert an
external form JSON text into an internal form whose values can be retrieved with the
get
and opt
methods, or to convert values into a JSON text using the
put
and toString
methods. A get
method returns a value if
one can be found, and throws an exception if one cannot be found. An opt
method
returns a default value instead of throwing an exception, and so is useful for obtaining optional
values.
The generic get()
and opt()
methods return an beginObject, which you
can cast or query for type. There are also typed
get
and opt
methods that do type checking and type coercion for you.
The opt methods differ from the get methods in that they do not throw. Instead, they return a
specified value, such as null.
The put
methods add or replace values in an beginObject. For example,
myString = new JsonObject() .put("JSON", "Hello, World!").toString();produces the string
{"JSON": "Hello, World"}
.
The texts produced by the toString
methods strictly conform to the JSON syntax
rules. The constructors are more forgiving in the texts they will accept:
,
(comma) may appear just before the closing
brace.'
(single quote).{ } [ ] / \ : , #
and if they do not look like numbers and if they are
not the reserved words true
, false
, or null
.Modifier and Type | Field and Description |
---|---|
static Object |
NULL
It is sometimes more convenient and less ambiguous to have a
NULL beginObject than
to use Java's null value. |
Modifier | Constructor and Description |
---|---|
|
JsonObject()
Construct an empty JSONObject.
|
protected |
JsonObject(int initialCapacity)
Constructor to specify an initial capacity of the internal map.
|
|
JsonObject(JsonObject jo,
String[] names)
Construct a JSONObject from a subset of another JSONObject.
|
|
JsonObject(JsonTokener x)
Construct a JSONObject from a JsonTokener.
|
|
JsonObject(Map<?,?> m)
Construct a JSONObject from a Map.
|
|
JsonObject(Object bean)
Construct a JSONObject from an Object using bean getters.
|
|
JsonObject(Object object,
String[] names)
Construct a JSONObject from an Object, using reflection to find the public members.
|
|
JsonObject(String source)
Construct a JSONObject from a source JSON text string.
|
|
JsonObject(String baseName,
Locale locale)
Construct a JSONObject from a ResourceBundle.
|
Modifier and Type | Method and Description |
---|---|
JsonObject |
accumulate(String key,
Object value)
Accumulate values under a key.
|
JsonObject |
append(String key,
Object value)
Append values to the beginArray under a key.
|
static String |
doubleToString(double d)
Produce a string from a double.
|
protected Set<Map.Entry<String,Object>> |
entrySet()
Get a set of entries of the JsonObject.
|
Object |
get(String key)
Get the value beginObject associated with a key.
|
BigDecimal |
getBigDecimal(String key)
Get the BigDecimal value associated with a key.
|
BigInteger |
getBigInteger(String key)
Get the BigInteger value associated with a key.
|
boolean |
getBoolean(String key)
Get the boolean value associated with a key.
|
double |
getDouble(String key)
Get the double value associated with a key.
|
<E extends Enum<E>> |
getEnum(Class<E> clazz,
String key)
Get the enum value associated with a key.
|
float |
getFloat(String key)
Get the float value associated with a key.
|
int |
getInt(String key)
Get the int value associated with a key.
|
JsonArray |
getJSONArray(String key)
Get the JsonArray value associated with a key.
|
JsonObject |
getJSONObject(String key)
Get the JsonObject value associated with a key.
|
long |
getLong(String key)
Get the long value associated with a key.
|
static String[] |
getNames(JsonObject jo)
Get an beginArray of field names from a JsonObject.
|
static String[] |
getNames(Object object)
Get an beginArray of field names from an Object.
|
Number |
getNumber(String key)
Get the Number value associated with a key.
|
String |
getString(String key)
Get the string associated with a key.
|
JsonType |
getType() |
boolean |
has(String key)
Determine if the JsonObject contains a specific key.
|
JsonObject |
increment(String key)
Increment a property of a JsonObject.
|
protected static boolean |
isDecimalNotation(String val)
Tests if the value should be tried as a decimal.
|
boolean |
isNull(String key)
Determine if the value associated with the key is null or if there is no value.
|
Iterator<String> |
keys()
Get an enumeration of the keys of the JsonObject.
|
Set<String> |
keySet()
Get a set of keys of the JsonObject.
|
int |
length()
Get the number of keys stored in the JsonObject.
|
JsonArray |
names()
Produce a JsonArray containing the names of the elements of this JsonObject.
|
static String |
numberToString(Number number)
Produce a string from a Number.
|
Object |
opt(String key)
Get an optional value associated with a key.
|
BigDecimal |
optBigDecimal(String key,
BigDecimal defaultValue)
Get an optional BigDecimal associated with a key, or the defaultValue if there is no such key
or if its value is not a number.
|
BigInteger |
optBigInteger(String key,
BigInteger defaultValue)
Get an optional BigInteger associated with a key, or the defaultValue if there is no such key
or if its value is not a number.
|
boolean |
optBoolean(String key)
Get an optional boolean associated with a key.
|
boolean |
optBoolean(String key,
boolean defaultValue)
Get an optional boolean associated with a key.
|
double |
optDouble(String key)
Get an optional double associated with a key, or NaN if there is no such key or if its value is
not a number.
|
double |
optDouble(String key,
double defaultValue)
Get an optional double associated with a key, or the defaultValue if there is no such key or if
its value is not a number.
|
<E extends Enum<E>> |
optEnum(Class<E> clazz,
String key)
Get the enum value associated with a key.
|
<E extends Enum<E>> |
optEnum(Class<E> clazz,
String key,
E defaultValue)
Get the enum value associated with a key.
|
float |
optFloat(String key)
Get the optional double value associated with an index.
|
float |
optFloat(String key,
float defaultValue)
Get the optional double value associated with an index.
|
int |
optInt(String key)
Get an optional int value associated with a key, or zero if there is no such key or if the
value is not a number.
|
int |
optInt(String key,
int defaultValue)
Get an optional int value associated with a key, or the default if there is no such key or if
the value is not a number.
|
JsonArray |
optJSONArray(String key)
Get an optional JsonArray associated with a key.
|
JsonObject |
optJSONObject(String key)
Get an optional JsonObject associated with a key.
|
long |
optLong(String key)
Get an optional long value associated with a key, or zero if there is no such key or if the
value is not a number.
|
long |
optLong(String key,
long defaultValue)
Get an optional long value associated with a key, or the default if there is no such key or if
the value is not a number.
|
Number |
optNumber(String key)
Get an optional
Number value associated with a key, or null if there is no
such key or if the value is not a number. |
Number |
optNumber(String key,
Number defaultValue)
Get an optional
Number value associated with a key, or the default if there is no such
key or if the value is not a number. |
Object |
optQuery(JsonPointer jsonPointer)
Queries and returns a value from this beginObject using
jsonPointer , or returns null if
the query fails due to a missing key. |
Object |
optQuery(String jsonPointer)
Queries and returns a value from this beginObject using
jsonPointer , or returns null if
the query fails due to a missing key. |
String |
optString(String key)
Get an optional string associated with a key.
|
String |
optString(String key,
String defaultValue)
Get an optional string associated with a key.
|
JsonObject |
put(String key,
boolean value)
Put a key/boolean pair in the JsonObject.
|
JsonObject |
put(String key,
Collection<?> value)
Put a key/value pair in the JsonObject, where the value will be a JsonArray which is produced
from a Collection.
|
JsonObject |
put(String key,
double value)
Put a key/double pair in the JsonObject.
|
JsonObject |
put(String key,
float value)
Put a key/float pair in the JsonObject.
|
JsonObject |
put(String key,
int value)
Put a key/int pair in the JsonObject.
|
JsonObject |
put(String key,
JsonLiteral literal) |
JsonObject |
put(String key,
long value)
Put a key/long pair in the JsonObject.
|
JsonObject |
put(String key,
Map<?,?> value)
Put a key/value pair in the JsonObject, where the value will be a JsonObject which is produced
from a Map.
|
JsonObject |
put(String key,
Object value)
Put a key/value pair in the JsonObject.
|
JsonObject |
putOnce(String key,
Object value)
Put a key/value pair in the JsonObject, but only if the key and the value are both non-null,
and only if there is not already a member with that name.
|
JsonObject |
putOpt(String key,
Object value)
Put a key/value pair in the JsonObject, but only if the key and the value are both non-null.
|
Object |
query(JsonPointer jsonPointer)
Uses a user initialized JsonPointer and tries to match it to an item within this JsonObject.
|
Object |
query(String jsonPointer)
Creates a JsonPointer using an initialization string and tries to match it to an item within
this JsonObject.
|
static String |
quote(String string)
Produce a string in double quotes with backslash sequences in all the right places.
|
static Writer |
quote(String string,
Writer w) |
Object |
remove(String key)
Remove a name and its value, if present.
|
boolean |
similar(Object other)
Determine if two JSONObjects are similar.
|
protected static Number |
stringToNumber(String val)
Converts a string to a number using the narrowest possible type.
|
static Object |
stringToValue(String string)
Try to convert a string into a number, boolean, or null.
|
static void |
testValidity(Object o)
Throw an exception if the beginObject is a NaN or infinite number.
|
JsonArray |
toJSONArray(JsonArray names)
Produce a JsonArray containing the values of the members of this JsonObject.
|
Map<String,Object> |
toMap()
Returns a java.util.Map containing all of the entries in this beginObject.
|
String |
toString()
Make a JSON text of this JsonObject.
|
String |
toString(int indentFactor)
Make a pretty-printed JSON text of this JsonObject.
|
static String |
valueToString(Object value)
Make a JSON text of an Object value.
|
static Object |
wrap(Object object)
Wrap an beginObject, if necessary.
|
Writer |
write(Writer writer)
Write the contents of the JsonObject as JSON text to a writer.
|
Writer |
write(Writer writer,
int indentFactor,
int indent)
Write the contents of the JsonObject as JSON text to a writer.
|
isJsonArray, isJsonLiteral, isJsonObject, toBuffer
public static final Object NULL
NULL
beginObject than
to use Java's null
value. JsonObject.NULL.equals(null)
returns
true
. JsonObject.NULL.toString()
returns "null"
.public JsonObject()
public JsonObject(JsonObject jo, String[] names)
jo
- A JSONObject.names
- An beginArray of strings.public JsonObject(JsonTokener x) throws JsonException
x
- A JsonTokener beginObject containing the source string.JsonException
- If there is a syntax error in the source string or a duplicated key.public JsonObject(Map<?,?> m)
m
- A map beginObject that can be used to initialize the contents of the JSONObject.public JsonObject(Object bean)
"get"
or "is"
followed by an uppercase letter, the method is invoked,
and a key and the value returned from the getter method are put into the new JSONObject.
The key is formed by removing the "get"
or "is"
prefix. If the second
remaining character is not upper case, then the first character is converted to lower case.
For example, if an beginObject has a method named "getName"
, and if the result of
calling beginObject.getName()
is "Larry Fine"
, then the JSONObject
will contain "name": "Larry Fine"
.
Methods that return void
as well as static
methods are ignored.
bean
- An beginObject that has getter methods that should be used to make a JSONObject.public JsonObject(Object object, String[] names)
object
- An beginObject that has fields that should be used to make a JSONObject.names
- An beginArray of strings, the names of the fields to be obtained from the
beginObject.public JsonObject(String source) throws JsonException
source
- A string beginning with {
(left brace) and
ending with }
(right brace).JsonException
- If there is a syntax error in the source string or a duplicated key.public JsonObject(String baseName, Locale locale) throws JsonException
baseName
- The ResourceBundle base name.locale
- The Locale to load the ResourceBundle for.JsonException
- If any JSONExceptions are detected.protected JsonObject(int initialCapacity)
initialCapacity
- initial capacity of the internal map.public JsonObject accumulate(String key, Object value) throws JsonException
key
- A key string.value
- An beginObject to be accumulated under the key.JsonException
- If the value is an invalid number or if the key is null.public JsonObject append(String key, Object value) throws JsonException
key
- A key string.value
- An beginObject to be accumulated under the key.JsonException
- If the key is null or if the current value associated with the key is not
a JsonArray.public static String doubleToString(double d)
d
- A double.public Object get(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found.public <E extends Enum<E>> E getEnum(Class<E> clazz, String key) throws JsonException
clazz
- The type of enum to retrieve.key
- A key string.JsonException
- if the key is not found or if the value cannot be converted to an enum.public boolean getBoolean(String key) throws JsonException
key
- A key string.JsonException
- if the value is not a Boolean or the String "true" or "false".public BigInteger getBigInteger(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value cannot be converted to
BigInteger.public BigDecimal getBigDecimal(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value cannot be converted to
BigDecimal.public double getDouble(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value is not a Number beginObject and
cannot be converted to a number.public float getFloat(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value is not a Number beginObject and
cannot be converted to a number.public Number getNumber(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value is not a Number beginObject and
cannot be converted to a number.public int getInt(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value cannot be converted to an
integer.public JsonArray getJSONArray(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value is not a JsonArray.public JsonObject getJSONObject(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value is not a JsonObject.public long getLong(String key) throws JsonException
key
- A key string.JsonException
- if the key is not found or if the value cannot be converted to a long.public static String[] getNames(JsonObject jo)
public static String[] getNames(Object object)
public String getString(String key) throws JsonException
key
- A key string.JsonException
- if there is no string value for the key.public boolean has(String key)
key
- A key string.public JsonObject increment(String key) throws JsonException
key
- A key string.JsonException
- If there is already a property with this name that is not an Integer,
Long, Double, or Float.public boolean isNull(String key)
key
- A key string.public Iterator<String> keys()
Set.iterator()
public Set<String> keySet()
Map.keySet()
protected Set<Map.Entry<String,Object>> entrySet()
Map.entrySet()
public int length()
public JsonArray names()
public static String numberToString(Number number) throws JsonException
number
- A NumberJsonException
- If n is a non-finite number.public Object opt(String key)
key
- A key string.public <E extends Enum<E>> E optEnum(Class<E> clazz, String key)
clazz
- The type of enum to retrieve.key
- A key string.public <E extends Enum<E>> E optEnum(Class<E> clazz, String key, E defaultValue)
clazz
- The type of enum to retrieve.key
- A key string.defaultValue
- The default in case the value is not foundclazz
public boolean optBoolean(String key)
key
- A key string.public boolean optBoolean(String key, boolean defaultValue)
key
- A key string.defaultValue
- The default.public BigDecimal optBigDecimal(String key, BigDecimal defaultValue)
key
- A key string.defaultValue
- The default.public BigInteger optBigInteger(String key, BigInteger defaultValue)
key
- A key string.defaultValue
- The default.public double optDouble(String key)
key
- A string which is the key.public double optDouble(String key, double defaultValue)
key
- A key string.defaultValue
- The default.public float optFloat(String key)
key
- A key string.public float optFloat(String key, float defaultValue)
key
- A key string.defaultValue
- The default value.public int optInt(String key)
key
- A key string.public int optInt(String key, int defaultValue)
key
- A key string.defaultValue
- The default.public JsonArray optJSONArray(String key)
key
- A key string.public JsonObject optJSONObject(String key)
key
- A key string.public long optLong(String key)
key
- A key string.public long optLong(String key, long defaultValue)
key
- A key string.defaultValue
- The default.public Number optNumber(String key)
Number
value associated with a key, or null
if there is no
such key or if the value is not a number. If the value is a string, an attempt will be made to
evaluate it as a number (BigDecimal
). This method would be used in cases where type
coercion of the number value is unwanted.key
- A key string.public Number optNumber(String key, Number defaultValue)
Number
value associated with a key, or the default if there is no such
key or if the value is not a number. If the value is a string, an attempt will be made to
evaluate it as a number. This method would be used in cases where type coercion of the number
value is unwanted.key
- A key string.defaultValue
- The default.public String optString(String key)
key
- A key string.public String optString(String key, String defaultValue)
key
- A key string.defaultValue
- The default.public JsonObject put(String key, JsonLiteral literal)
key
- literal
- public JsonObject put(String key, boolean value) throws JsonException
key
- A key string.value
- A boolean which is the value.JsonException
- If the key is null.public JsonObject put(String key, Collection<?> value) throws JsonException
key
- A key string.value
- A Collection value.JsonException
public JsonObject put(String key, double value) throws JsonException
key
- A key string.value
- A double which is the value.JsonException
- If the key is null or if the number is invalid.public JsonObject put(String key, float value) throws JsonException
key
- A key string.value
- A float which is the value.JsonException
- If the key is null or if the number is invalid.public JsonObject put(String key, int value) throws JsonException
key
- A key string.value
- An int which is the value.JsonException
- If the key is null.public JsonObject put(String key, long value) throws JsonException
key
- A key string.value
- A long which is the value.JsonException
- If the key is null.public JsonObject put(String key, Map<?,?> value) throws JsonException
key
- A key string.value
- A Map value.JsonException
public JsonObject put(String key, Object value) throws JsonException
key
- A key string.value
- An beginObject which is the value. It should be of one of these types: Boolean,
Double, Integer, JsonArray, JsonObject, Long, String, or the JsonObject.NULL beginObject.JsonException
- If the value is non-finite number or if the key is null.public JsonObject putOnce(String key, Object value) throws JsonException
key
- stringvalue
- beginObjectJsonException
- if the key is a duplicatepublic JsonObject putOpt(String key, Object value) throws JsonException
key
- A key string.value
- An beginObject which is the value. It should be of one of these types: Boolean,
Double, Integer, JsonArray, JsonObject, Long, String, or the JsonObject.NULL beginObject.JsonException
- If the value is a non-finite number.public Object query(String jsonPointer)
{ "a":{"b":"c"} }and this JsonPointer string:
"/a/b"Then this method will return the String "c". A JsonPointerException may be thrown from code called by this method.
jsonPointer
- string that can be used to create a JsonPointerpublic Object query(JsonPointer jsonPointer)
{ "a":{"b":"c"} }and this JsonPointer:
"/a/b"Then this method will return the String "c". A JsonPointerException may be thrown from code called by this method.
jsonPointer
- string that can be used to create a JsonPointerpublic Object optQuery(String jsonPointer)
jsonPointer
, or returns null if
the query fails due to a missing key.jsonPointer
- the string representation of the JSON pointernull
IllegalArgumentException
- if jsonPointer
has invalid syntaxpublic Object optQuery(JsonPointer jsonPointer)
jsonPointer
, or returns null if
the query fails due to a missing key.jsonPointer
- The JSON pointernull
IllegalArgumentException
- if jsonPointer
has invalid syntaxpublic static String quote(String string)
string
- A Stringpublic static Writer quote(String string, Writer w) throws IOException
IOException
public Object remove(String key)
key
- The name to be removed.public boolean similar(Object other)
other
- The other JsonObjectprotected static boolean isDecimalNotation(String val)
val
- value to testprotected static Number stringToNumber(String val) throws NumberFormatException
val
- value to convertNumberFormatException
- thrown if the value is not a valid number. A public caller should
catch this and wrap it in a JsonException
if applicable.public static Object stringToValue(String string)
string
- A String.public static void testValidity(Object o) throws JsonException
o
- The beginObject to test.JsonException
- If o is a non-finite number.public JsonArray toJSONArray(JsonArray names) throws JsonException
names
- A JsonArray containing a list of key strings. This determines the sequence of the
values in the result.JsonException
- If any of the values are non-finite numbers.public String toString()
Warning: This method assumes that the data structure is acyclical.
public String toString(int indentFactor) throws JsonException
If indentFactor > 0
and the JsonObject
has only one key, then the
beginObject will be output on a single line:
{"key": 1}
If an beginObject has 2 or more keys, then it will be output across multiple lines: {
"key1": 1,
"key2": "value 2",
"key3": 3
}
Warning: This method assumes that the data structure is acyclical.
indentFactor
- The number of spaces to add to each level of indentation.{
(left brace) and ending with
}
(right brace).JsonException
- If the beginObject contains an invalid number.public static String valueToString(Object value) throws JsonException
Warning: This method assumes that the data structure is acyclical.
value
- The value to be serialized.{
(left brace) and ending with
}
(right brace).JsonException
- If the value is or contains an invalid number.public static Object wrap(Object object)
object
- The beginObject to wrappublic Writer write(Writer writer) throws JsonException
Warning: This method assumes that the data structure is acyclical.
JsonException
public Writer write(Writer writer, int indentFactor, int indent) throws JsonException
If indentFactor > 0
and the JsonObject
has only one key, then the
beginObject will be output on a single line:
{"key": 1}
If an beginObject has 2 or more keys, then it will be output across multiple lines: {
"key1": 1,
"key2": "value 2",
"key3": 3
}
Warning: This method assumes that the data structure is acyclical.
writer
- Writes the serialized JSONindentFactor
- The number of spaces to add to each level of indentation.indent
- The indentation of the top level.JsonException
public Map<String,Object> toMap()
Warning: This method assumes that the data structure is acyclical.
Copyright © 2018 Terra Software Informatics LLC.. All rights reserved.