|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwslite.json.JSONObject
public class JSONObject
A JSONObject is an unordered collection of name/value pairs. Its
external form is a string wrapped in curly braces with colons between the
names and values, and commas between the values and names. The internal form
is an object having 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
object. 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
object, 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 object. 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
.=
or =>
as well as
by :
.;
(semicolon) as
well as by ,
(comma).Field Summary | |
---|---|
static java.lang.Object |
NULL
It is sometimes more convenient and less ambiguous to have a
|
Method Summary | |
---|---|
java.lang.Object
|
JSONObject()
Construct an empty JSONObject. |
java.lang.Object
|
JSONObject(JSONObject jo, String[] names)
Construct a JSONObject from a subset of another JSONObject. |
java.lang.Object
|
JSONObject(JSONTokener x)
Construct a JSONObject from a JSONTokener. |
java.lang.Object
|
JSONObject(java.util.Map map)
Construct a JSONObject from a Map. |
java.lang.Object
|
JSONObject(java.lang.Object bean)
Construct a JSONObject from an Object using bean getters. |
java.lang.Object
|
JSONObject(java.lang.Object object, String[] names)
Construct a JSONObject from an Object, using reflection to find the public members. |
java.lang.Object
|
JSONObject(java.lang.String source)
Construct a JSONObject from a source JSON text string. |
java.lang.Object
|
JSONObject(java.lang.String baseName, java.util.Locale locale)
Construct a JSONObject from a ResourceBundle. |
JSONObject
|
accumulate(java.lang.String key, java.lang.Object value)
Accumulate values under a key. |
JSONObject
|
append(java.lang.String key, java.lang.Object value)
Append values to the array under a key. |
void
|
clear()
|
boolean
|
containsKey(java.lang.Object key)
|
boolean
|
containsValue(java.lang.Object value)
|
static java.lang.String
|
doubleToString(double d)
Produce a string from a double. |
java.util.Set
|
entrySet()
|
java.lang.Object
|
get(java.lang.String key)
Get the value object associated with a key. |
java.lang.Object
|
get(java.lang.Object key)
|
boolean
|
getBoolean(java.lang.String key)
Get the boolean value associated with a key. |
double
|
getDouble(java.lang.String key)
Get the double value associated with a key. |
int
|
getInt(java.lang.String key)
Get the int value associated with a key. |
JSONArray
|
getJSONArray(java.lang.String key)
Get the JSONArray value associated with a key. |
JSONObject
|
getJSONObject(java.lang.String key)
Get the JSONObject value associated with a key. |
long
|
getLong(java.lang.String key)
Get the long value associated with a key. |
static String[]
|
getNames(JSONObject jo)
Get an array of field names from a JSONObject. |
static String[]
|
getNames(java.lang.Object object)
Get an array of field names from an Object. |
java.lang.String
|
getString(java.lang.String key)
Get the string associated with a key. |
boolean
|
has(java.lang.String key)
Determine if the JSONObject contains a specific key. |
JSONObject
|
increment(java.lang.String key)
Increment a property of a JSONObject. |
boolean
|
isEmpty()
|
boolean
|
isNull(java.lang.String key)
Determine if the value associated with the key is null or if there is no value. |
java.util.Set
|
keySet()
|
java.util.Iterator
|
keys()
Get an enumeration of the 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 java.lang.String
|
numberToString(java.lang.Number number)
Produce a string from a Number. |
java.lang.Object
|
opt(java.lang.String key)
Get an optional value associated with a key. |
boolean
|
optBoolean(java.lang.String key)
Get an optional boolean associated with a key. |
boolean
|
optBoolean(java.lang.String key, boolean defaultValue)
Get an optional boolean associated with a key. |
double
|
optDouble(java.lang.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(java.lang.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. |
int
|
optInt(java.lang.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(java.lang.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(java.lang.String key)
Get an optional JSONArray associated with a key. |
JSONObject
|
optJSONObject(java.lang.String key)
Get an optional JSONObject associated with a key. |
long
|
optLong(java.lang.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(java.lang.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. |
java.lang.String
|
optString(java.lang.String key)
Get an optional string associated with a key. |
java.lang.String
|
optString(java.lang.String key, java.lang.String defaultValue)
Get an optional string associated with a key. |
JSONObject
|
put(java.lang.String key, boolean value)
Put a key/boolean pair in the JSONObject. |
JSONObject
|
put(java.lang.String key, java.util.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(java.lang.String key, double value)
Put a key/double pair in the JSONObject. |
JSONObject
|
put(java.lang.String key, int value)
Put a key/int pair in the JSONObject. |
JSONObject
|
put(java.lang.String key, long value)
Put a key/long pair in the JSONObject. |
JSONObject
|
put(java.lang.String key, java.util.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(java.lang.String key, java.lang.Object value)
Put a key/value pair in the JSONObject. |
java.lang.Object
|
put(java.lang.Object key, java.lang.Object value)
|
void
|
putAll(java.util.Map m)
|
JSONObject
|
putOnce(java.lang.String key, java.lang.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(java.lang.String key, java.lang.Object value)
Put a key/value pair in the JSONObject, but only if the key and the value are both non-null. |
static java.lang.String
|
quote(java.lang.String string)
Produce a string in double quotes with backslash sequences in all the right places. |
java.lang.Object
|
remove(java.lang.String key)
Remove a name and its value, if present. |
java.lang.Object
|
remove(java.lang.Object key)
|
int
|
size()
|
static java.lang.Object
|
stringToValue(java.lang.String string)
Try to convert a string into a number, boolean, or null. |
static void
|
testValidity(java.lang.Object o)
Throw an exception if the object is a NaN or infinite number. |
JSONArray
|
toJSONArray(JSONArray names)
Produce a JSONArray containing the values of the members of this JSONObject. |
java.lang.String
|
toString()
Make a JSON text of this JSONObject. |
java.lang.String
|
toString(int indentFactor)
Make a prettyprinted JSON text of this JSONObject. |
static java.lang.String
|
valueToString(java.lang.Object value)
Make a JSON text of an Object value. |
java.util.Collection
|
values()
|
static java.lang.Object
|
wrap(java.lang.Object object)
Wrap an object, if necessary. |
java.io.Writer
|
write(java.io.Writer writer)
Write the contents of the JSONObject as JSON text to a writer. |
Methods inherited from class java.lang.Object | |
---|---|
java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Field Detail |
---|
public static final java.lang.Object NULL
NULL
object than to use Java's null
value.
JSONObject.NULL.equals(null)
returns true
.
JSONObject.NULL.toString()
returns "null"
.
Method Detail |
---|
public java.lang.Object JSONObject()
public java.lang.Object JSONObject(JSONObject jo, String[] names)
jo
- A JSONObject.names
- An array of strings.
public java.lang.Object JSONObject(JSONTokener x)
x
- A JSONTokener object containing the source string.
public java.lang.Object JSONObject(java.util.Map map)
map
- A map object that can be used to initialize the contents of
the JSONObject.
public java.lang.Object JSONObject(java.lang.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 object has a method named "getName"
, and
if the result of calling object.getName()
is "Larry Fine"
,
then the JSONObject will contain "name": "Larry Fine"
.
bean
- An object that has getter methods that should be used
to make a JSONObject.
public java.lang.Object JSONObject(java.lang.Object object, String[] names)
object
- An object that has fields that should be used to make a
JSONObject.names
- An array of strings, the names of the fields to be obtained
from the object.
public java.lang.Object JSONObject(java.lang.String source)
source
- A string beginning
with {
(left brace) and ending
with }
(right brace).
public java.lang.Object JSONObject(java.lang.String baseName, java.util.Locale locale)
baseName
- The ResourceBundle base name.locale
- The Locale to load the ResourceBundle for.
public JSONObject accumulate(java.lang.String key, java.lang.Object value)
key
- A key string.value
- An object to be accumulated under the key.
public JSONObject append(java.lang.String key, java.lang.Object value)
key
- A key string.value
- An object to be accumulated under the key.
public void clear()
public boolean containsKey(java.lang.Object key)
public boolean containsValue(java.lang.Object value)
public static java.lang.String doubleToString(double d)
d
- A double.
public java.util.Set entrySet()
public java.lang.Object get(java.lang.String key)
key
- A key string.
public java.lang.Object get(java.lang.Object key)
public boolean getBoolean(java.lang.String key)
key
- A key string.
public double getDouble(java.lang.String key)
key
- A key string.
public int getInt(java.lang.String key)
key
- A key string.
public JSONArray getJSONArray(java.lang.String key)
key
- A key string.
public JSONObject getJSONObject(java.lang.String key)
key
- A key string.
public long getLong(java.lang.String key)
key
- A key string.
public static String[] getNames(JSONObject jo)
public static String[] getNames(java.lang.Object object)
public java.lang.String getString(java.lang.String key)
key
- A key string.
public boolean has(java.lang.String key)
key
- A key string.
public JSONObject increment(java.lang.String key)
key
- A key string.
public boolean isEmpty()
public boolean isNull(java.lang.String key)
key
- A key string.
public java.util.Set keySet()
public java.util.Iterator keys()
public int length()
public JSONArray names()
public static java.lang.String numberToString(java.lang.Number number)
number
- A Number
public java.lang.Object opt(java.lang.String key)
key
- A key string.
public boolean optBoolean(java.lang.String key)
key
- A key string.
public boolean optBoolean(java.lang.String key, boolean defaultValue)
key
- A key string.defaultValue
- The default.
public double optDouble(java.lang.String key)
key
- A string which is the key.
public double optDouble(java.lang.String key, double defaultValue)
key
- A key string.defaultValue
- The default.
public int optInt(java.lang.String key)
key
- A key string.
public int optInt(java.lang.String key, int defaultValue)
key
- A key string.defaultValue
- The default.
public JSONArray optJSONArray(java.lang.String key)
key
- A key string.
public JSONObject optJSONObject(java.lang.String key)
key
- A key string.
public long optLong(java.lang.String key)
key
- A key string.
public long optLong(java.lang.String key, long defaultValue)
key
- A key string.defaultValue
- The default.
public java.lang.String optString(java.lang.String key)
key
- A key string.
public java.lang.String optString(java.lang.String key, java.lang.String defaultValue)
key
- A key string.defaultValue
- The default.
public JSONObject put(java.lang.String key, boolean value)
key
- A key string.value
- A boolean which is the value.
public JSONObject put(java.lang.String key, java.util.Collection value)
key
- A key string.value
- A Collection value.
public JSONObject put(java.lang.String key, double value)
key
- A key string.value
- A double which is the value.
public JSONObject put(java.lang.String key, int value)
key
- A key string.value
- An int which is the value.
public JSONObject put(java.lang.String key, long value)
key
- A key string.value
- A long which is the value.
public JSONObject put(java.lang.String key, java.util.Map value)
key
- A key string.value
- A Map value.
public JSONObject put(java.lang.String key, java.lang.Object value)
key
- A key string.value
- An object which is the value. It should be of one of these
types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String,
or the JSONObject.NULL object.
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
public void putAll(java.util.Map m)
public JSONObject putOnce(java.lang.String key, java.lang.Object value)
public JSONObject putOpt(java.lang.String key, java.lang.Object value)
key
- A key string.value
- An object which is the value. It should be of one of these
types: Boolean, Double, Integer, JSONArray, JSONObject, Long, String,
or the JSONObject.NULL object.
public static java.lang.String quote(java.lang.String string)
string
- A String
public java.lang.Object remove(java.lang.String key)
key
- The name to be removed.
public java.lang.Object remove(java.lang.Object key)
public int size()
public static java.lang.Object stringToValue(java.lang.String string)
string
- A String.
public static void testValidity(java.lang.Object o)
o
- The object to test.
public JSONArray toJSONArray(JSONArray names)
names
- A JSONArray containing a list of key strings. This
determines the sequence of the values in the result.
public java.lang.String toString()
Warning: This method assumes that the data structure is acyclical.
{
(left brace) and ending
with }
(right brace).
public java.lang.String toString(int indentFactor)
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).
public static java.lang.String valueToString(java.lang.Object value)
Warning: This method assumes that the data structure is acyclical.
value
- The value to be serialized.{
(left brace) and ending
with }
(right brace).
public java.util.Collection values()
public static java.lang.Object wrap(java.lang.Object object)
object
- The object to wrap
public java.io.Writer write(java.io.Writer writer)
Warning: This method assumes that the data structure is acyclical.
Groovy Documentation