+ Feel free to replace this paragraph with a description of the library. Contributed libraries are developed, documented, and maintained by members of the Processing community. Further directions are included with each library. For feedback and support, please post to the Discourse. We strongly encourage all libraries to be open source, but not all of them are.
+
+
+
+
+
+
+
Download
+
+ Download json4processing version 0.1.3 in
+ .zip format.
+
+
Installation
+
+ Unzip and put the extracted json4processing folder into the libraries folder of your processing sketches. Reference and examples are included in the json4processing folder.
+
+
+
+
+
+
Keywords ?
+
Reference. Have a look at the javadoc reference here. a copy of the reference is included in the .zip as well.
+
Source. The source code of json4processing is available at github, and its repository can be browsed here.
+
+
+
+
Examples
+
Find a list of examples in the current distribution of json4processing, or have a look at them by following the links below.
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+Package
+
+
+
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
+
Interfaces (italic)
Classes
Enums
Exceptions
Errors
Annotation Types
+
+
+Class/Interface
+
+
+
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
Class inheritance diagram
Direct Subclasses
All Known Subinterfaces
All Known Implementing Classes
Class/interface declaration
Class/interface description
+
+
Nested Class Summary
Field Summary
Constructor Summary
Method Summary
+
+
Field Detail
Constructor Detail
Method Detail
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+Annotation Type
+
+
+
+Each annotation type has its own separate page with the following sections:
+
Annotation Type declaration
Annotation Type description
Required Element Summary
Optional Element Summary
Element Detail
+
+
+
+Enum
+
+
+
+Each enum has its own separate page with the following sections:
+
Enum declaration
Enum description
Enum Constant Summary
Enum Constant Detail
+
+
+Tree (Class Hierarchy)
+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+Deprecated API
+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+Index
+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+Prev/Next
+These links take you to the next or previous class, interface, package, or related page.
+Frames/No Frames
+These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+Serialized Form
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+
Replace special characters with XML escapes:
+
+ & (ampersand) is replaced by &
+ < (less than) is replaced by <
+ > (greater than) is replaced by >
+ " (double quote) is replaced by "
+
+
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
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.
+
+This provides static methods to convert comma delimited text into a
+ JSONArray, and to covert a JSONArray into comma delimited text. Comma
+ delimited text is a very popular format for data interchange. It is
+ understood by most database, spreadsheet, and organizer programs.
+
+ Each row of text represents a row in a table or a data record. Each row
+ ends with a NEWLINE character. Each row contains one or more values.
+ Values are separated by commas. A value can contain any character except
+ for comma, unless is is wrapped in single quotes or double quotes.
+
+ The first row usually contains the names of the columns.
+
+ A comma delimited list can be converted into a JSONArray of JSONObjects.
+ The names for the elements in the JSONObjects can be taken from the names
+ in the first row.
+
rowToJSONObject(JSONArray names,
+ JSONTokener x)
+
+
+ Produce a JSONObject from a row of comma delimited text, using a
+ parallel JSONArray of strings to provides the names of the elements.
+
+
+
+static java.lang.String
+
rowToString(JSONArray ja)
+
+
+ Produce a comma delimited text row from a JSONArray.
toJSONArray(JSONArray names,
+ JSONTokener x)
+
+
+ Produce a JSONArray of JSONObjects from a comma delimited text string
+ using a supplied JSONArray as the source of element names.
toJSONArray(JSONArray names,
+ java.lang.String string)
+
+
+ Produce a JSONArray of JSONObjects from a comma delimited text string
+ using a supplied JSONArray as the source of element names.
toJSONArray(java.lang.String string)
+
+
+ Produce a JSONArray of JSONObjects from a comma delimited text string,
+ using the first row as a source of names.
+
+
+
+static java.lang.String
+
toString(JSONArray ja)
+
+
+ Produce a comma delimited text from a JSONArray of JSONObjects.
+
+
+
+static java.lang.String
+
toString(JSONArray names,
+ JSONArray ja)
+
+
+ Produce a comma delimited text from a JSONArray of JSONObjects using
+ a provided list of names.
Produce a comma delimited text row from a JSONArray. Values containing
+ the comma character will be quoted. Troublesome characters may be
+ removed.
+
Produce a comma delimited text from a JSONArray of JSONObjects. The
+ first row will be a list of names obtained by inspecting the first
+ JSONObject.
+
escape(java.lang.String string)
+
+
+ Produce a copy of a string in which the characters '+', '%', '=', ';'
+ and control characters are replaced with "%hh".
Produce a copy of a string in which the characters '+', '%', '=', ';'
+ and control characters are replaced with "%hh". This is a gentle form
+ of URL encoding, attempting to cause as little distortion to the
+ string as possible. The characters '=' and ';' are meta characters in
+ cookies. By convention, they are escaped using the URL-encoding. This is
+ only a convention, not a standard. Often, cookies are expected to have
+ encoded values. We encode '=' and ';' because we must. We encode '%' and
+ '+' because they are meta characters in URL encoding.
+
Convert a cookie specification string into a JSONObject. The string
+ will contain a name value pair separated by '='. The name and the value
+ will be unescaped, possibly converting '+' and '%' sequences. The
+ cookie properties may follow, separated by ';', also represented as
+ name=value (except the secure property, which does not have a value).
+ The name will be stored under the key "name", and the value will be
+ stored under the key "value". This method does not do checking or
+ validation of the parameters. It only converts the cookie string into
+ a JSONObject.
+
+
+
Parameters:
string - The cookie specification string.
+
Returns:
A JSONObject containing "name", "value", and possibly other
+ members.
+
Convert a JSONObject into a cookie specification string. The JSONObject
+ must contain "name" and "value" members.
+ If the JSONObject contains "expires", "domain", "path", or "secure"
+ members, they will be appended to the cookie specification string.
+ All other members are ignored.
+
Convert a cookie list into a JSONObject. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The names and the values
+ will be unescaped, possibly converting '+' and '%' sequences.
+
+ To add a cookie to a cooklist,
+ cookielistJSONObject.put(cookieJSONObject.getString("name"),
+ cookieJSONObject.getString("value"));
+
Convert a JSONObject into a cookie list. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The characters '%', '+', '=', and ';'
+ in the names and values are replaced by "%hh".
+
+A JSONArray is an ordered sequence of values. Its external text form is a
+ string wrapped in square brackets with commas separating the values. The
+ internal form is an object having get and opt
+ methods for accessing the values by index, and put methods for
+ adding or replacing values. The values can be any of these types:
+ Boolean, JSONArray, JSONObject,
+ Number, String, or the
+ JSONObject.NULL object.
+
+ The constructor can convert a JSON text into a Java object. The
+ toString method converts to JSON text.
+
+ 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 texts produced by the toString methods strictly conform to
+ JSON syntax rules. The constructors are more forgiving in the texts they will
+ accept:
+
+
An extra , (comma) may appear just
+ before the closing bracket.
+
The null value will be inserted when there
+ is , (comma) elision.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces,
+ and if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers
+ and if they are not the reserved words true,
+ false, or null.
+
Values can be separated by ; (semicolon) as
+ well as by , (comma).
put(int index,
+ java.util.Collection value)
+
+
+ Put a value in the JSONArray, where the value will be a
+ JSONArray which is produced from a Collection.
Make a string from the contents of this JSONArray. The
+ separator string is inserted between each element.
+ Warning: This method assumes that the data structure is acyclical.
+
+
+
Parameters:
separator - A string that will be inserted between the elements.
+
Returns:
a string.
+
Throws:
+
JSONException - If the array contains an invalid number.
+
+
+
+
+
+length
+
+public int length()
+
+
Get the number of elements in the JSONArray, included nulls.
+
+
+
+
Returns:
The length (or size).
+
+
+
+
+
+opt
+
+public java.lang.Object opt(int index)
+
+
Get the optional object value associated with an index.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
+
Returns:
An object value, or null if there is no
+ object at that index.
+
+
+
+
+
+optBoolean
+
+public boolean optBoolean(int index)
+
+
Get the optional boolean value associated with an index.
+ It returns false if there is no value at that index,
+ or if the value is not Boolean.TRUE or the String "true".
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
+
Get the optional boolean value associated with an index.
+ It returns the defaultValue if there is no value at that index or if
+ it is not a Boolean or the String "true" or "false" (case insensitive).
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
defaultValue - A boolean default.
+
Returns:
The truth.
+
+
+
+
+
+optDouble
+
+public double optDouble(int index)
+
+
Get the optional double value associated with an index.
+ NaN is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
+
Get the optional double value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
+
+
Parameters:
index - subscript
defaultValue - The default value.
+
Returns:
The value.
+
+
+
+
+
+optInt
+
+public int optInt(int index)
+
+
Get the optional int value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
+
Returns:
The value.
+
+
+
+
+
+optInt
+
+public int optInt(int index,
+ int defaultValue)
+
+
Get the optional int value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional JSONObject associated with an index.
+ Null is returned if the key is not found, or null if the index has
+ no value, or if the value is not a JSONObject.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
+
Returns:
A JSONObject value.
+
+
+
+
+
+optLong
+
+public long optLong(int index)
+
+
Get the optional long value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
+
Returns:
The value.
+
+
+
+
+
+optLong
+
+public long optLong(int index,
+ long defaultValue)
+
+
Get the optional long value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
defaultValue - The default value.
+
Returns:
The value.
+
+
+
+
+
+optString
+
+public java.lang.String optString(int index)
+
+
Get the optional string value associated with an index. It returns an
+ empty string if there is no value at that index. If the value
+ is not a string and is not null, then it is coverted to a string.
+
+
+
Parameters:
index - The index must be between 0 and length() - 1.
+
Put or replace a boolean value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
+
Put or replace a double value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
+
+
+
Parameters:
index - The subscript.
value - A double value.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the value is
+ not finite.
Put or replace an int value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
+
Put or replace a long value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
+
Put or replace an object value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
+
+
+
Parameters:
index - The subscript.
value - The value to put into the array. The value should be a
+ Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the
+ JSONObject.NULL object.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the the value is
+ an invalid number.
+
+
+
+
+
+remove
+
+public java.lang.Object remove(int index)
+
+
Remove an index and close the hole.
+
+
+
Parameters:
index - The index of the element to be removed.
+
Returns:
The value that was associated with the index,
+ or null if there was no value.
Make a JSON text of this JSONArray. For compactness, no
+ unnecessary whitespace is added. If it is not possible to produce a
+ syntactically correct JSON text then null will be returned instead. This
+ could occur if the array contains an invalid number.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
Returns:
a printable, displayable, transmittable
+ representation of the array.
+This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
+
toJSONObject(java.lang.String string)
+
+
+ Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
+
+
Parameters:
string - The source string.
+
Returns:
A JSONArray containing the structured data from the XML string.
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child content and tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
+
+
Parameters:
x - An XMLTokener.
+
Returns:
A JSONArray containing the structured data from the XML string.
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
+
+
Parameters:
x - An XMLTokener of the XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
+
+
Parameters:
string - The XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
+
Reverse the JSONML transformation, making an XML text from a JSONObject.
+ The JSONObject must contain a "tagName" property. If it has children,
+ then it must have a "childNodes" property containing an array of objects.
+ The other properties are attributes with string values.
+
+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:
+
+
An extra , (comma) may appear just
+ before the closing brace.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces, and
+ if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers and
+ if they are not the reserved words true, false, or
+ null.
+
Keys can be followed by = or => as well as by
+ :.
+
Values can be followed by ; (semicolon) as
+ well as by , (comma).
+
Numbers may have the 0x- (hex) prefix.
+
+
+
+
+
+
Author:
+
JSON.org
+
+
+
+
+
+
+
+
+
+
+Field Summary
+
+
+
+static java.lang.Object
+
NULL
+
+
+ It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
JSONObject(java.util.Map map)
+
+
+ Construct a JSONObject from a Map.
+
+
+
JSONObject(java.lang.Object bean)
+
+
+ Construct a JSONObject from an Object using bean getters.
+
+
+
JSONObject(java.lang.Object object,
+ java.lang.String[] names)
+
+
+ Construct a JSONObject from an Object, using reflection to find the
+ public members.
+
+
+
JSONObject(java.lang.String source)
+
+
+ Construct a JSONObject from a source JSON text string.
+
+
+
JSONObject(java.lang.String baseName,
+ java.util.Locale locale)
+
+
+ Construct a JSONObject from a ResourceBundle.
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.
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.
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.
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.
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.
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.
+
+
+
+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.
It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
+ JSONObject.NULL.equals(null) returns true.
+ JSONObject.NULL.toString() returns "null".
+
+
+
+
+
+
+
+
+
+
+
+Constructor Detail
+
+
+
+
+JSONObject
+
+public JSONObject()
+
+
Construct an empty JSONObject.
+
+
+
+
+
+JSONObject
+
+public JSONObject(JSONObject jo,
+ java.lang.String[] names)
+
+
Construct a JSONObject from a subset of another JSONObject. An array of
+ strings is used to identify the keys that should be copied. Missing keys
+ are ignored.
+
Construct a JSONObject from an Object using bean getters. It reflects on
+ all of the public methods of the object. For each of the methods with no
+ parameters and a name starting with "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".
+
+
+
Parameters:
bean - An object that has getter methods that should be used to make
+ a JSONObject.
Construct a JSONObject from an Object, using reflection to find the
+ public members. The resulting JSONObject's keys will be the strings from
+ the names array, and the values will be the field values associated with
+ those keys in the object. If a key is not found or not visible, then it
+ will not be copied into the new JSONObject.
+
+
+
Parameters:
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.
+
+
+
+
+JSONObject
+
+public JSONObject(java.lang.String source)
+
+
Construct a JSONObject from a source JSON text string. This is the most
+ commonly used JSONObject constructor.
+
+
+
Parameters:
source - A string beginning with { (left
+ brace) and ending with }
+ (right brace).
+
Throws:
+
JSONException - If there is a syntax error in the source string or a
+ duplicated key.
Accumulate values under a key. It is similar to the put method except
+ that if there is already an object stored under the key then a JSONArray
+ is stored under the key to hold all of the accumulated values. If there
+ is already a JSONArray, then the new value is appended to it. In
+ contrast, the put method replaces the previous value.
+
+ If only one value is accumulated that is not a JSONArray, then the result
+ will be the same as using put. But if multiple values are accumulated,
+ then the result will be like append.
+
+
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is an invalid number or if the key is null.
Append values to the array under a key. If the key does not exist in the
+ JSONObject, then the key is put in the JSONObject with its value being a
+ JSONArray containing the value parameter. If the key was already
+ associated with a JSONArray, then the value parameter is appended to it.
+
+
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the key is null or if the current value associated with
+ the key is not a JSONArray.
Increment a property of a JSONObject. If there is no such property,
+ create one with a value of 1. If there is such a property, and if it is
+ an Integer, Long, Double, or Float, then add one to it.
+
+
+
Parameters:
key - A key string.
+
Returns:
this.
+
Throws:
+
JSONException - If there is already a property with this name that is not an
+ Integer, Long, Double, or Float.
+
+
+
+
+
+isNull
+
+public boolean isNull(java.lang.String key)
+
+
Determine if the value associated with the key is null or if there is no
+ value.
+
+
+
Parameters:
key - A key string.
+
Returns:
true if there is no value associated with the key or if the value
+ is the JSONObject.NULL object.
+
+
+
+
+
+keys
+
+public java.util.Iterator keys()
+
+
Get an enumeration of the keys of the JSONObject.
+
+
+
+
Returns:
An iterator of the keys.
+
+
+
+
+
+length
+
+public int length()
+
+
Get the number of keys stored in the JSONObject.
+
Get an optional boolean associated with a key. It returns the
+ defaultValue if there is no such key, or if it is not a Boolean or the
+ String "true" or "false" (case insensitive).
+
+
+
Parameters:
key - A key string.
defaultValue - The default.
+
Returns:
The truth.
+
+
+
+
+
+optDouble
+
+public 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. If the value is a string, an attempt
+ will be made to evaluate it as a number.
+
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. If the value is a
+ string, an attempt will be made to evaluate it as a number.
+
+
+
Parameters:
key - A key string.
defaultValue - The default.
+
Returns:
An object which is the value.
+
+
+
+
+
+optInt
+
+public 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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
+
+
+
Parameters:
key - A key string.
+
Returns:
An object which is the value.
+
+
+
+
+
+optInt
+
+public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
+
Get an optional JSONObject associated with a key. It returns null if
+ there is no such key, or if its value is not a JSONObject.
+
+
+
Parameters:
key - A key string.
+
Returns:
A JSONObject which is the value.
+
+
+
+
+
+optLong
+
+public 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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
+
+
+
Parameters:
key - A key string.
+
Returns:
An object which is the value.
+
+
+
+
+
+optLong
+
+public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
+
Get an optional string associated with a key. It returns an empty string
+ if there is no such key. If the value is not a string and is not null,
+ then it is converted to a string.
+
Put a key/value pair in the JSONObject. If the value is null, then the
+ key will be removed from the JSONObject if it is present.
+
+
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is non-finite number or if the key is null.
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.
+
Put a key/value pair in the JSONObject, but only if the key and the value
+ are both non-null.
+
+
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is a non-finite number.
Produce a JSONArray containing the values of the members of this
+ JSONObject.
+
+
+
Parameters:
names - A JSONArray containing a list of key strings. This determines
+ the sequence of the values in the result.
+
Returns:
A JSONArray of values.
+
Throws:
+
JSONException - If any of the values are non-finite numbers.
+
+
+
+
+
+toString
+
+public java.lang.String toString()
+
+
Make a JSON text of this JSONObject. For compactness, no whitespace is
+ added. If this would not result in a syntactically correct JSON text,
+ then null will be returned instead.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
Returns:
a printable, displayable, portable, transmittable representation
+ of the object, beginning with { (left
+ brace) and ending with } (right
+ brace).
Make a JSON text of an Object value. If the object has an
+ value.toJSONString() method, then that method will be used to produce the
+ JSON text. The method is required to produce a strictly conforming text.
+ If the object does not contain a toJSONString method (which is the most
+ common case), then a text will be produced by other means. If the value
+ is an array or Collection, then a JSONArray will be made from it and its
+ toJSONString method will be called. If the value is a MAP, then a
+ JSONObject will be made from it and its toJSONString method will be
+ called. Otherwise, the value's toString method will be called, and the
+ result will be quoted.
+
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
+
Parameters:
value - The value to be serialized.
+
Returns:
a printable, displayable, transmittable representation of the
+ object, beginning with { (left
+ brace) and ending with } (right
+ brace).
+
Throws:
+
JSONException - If the value is or contains an invalid number.
Wrap an object, if necessary. If the object is null, return the NULL
+ object. If it is an array or collection, wrap it in a JSONArray. If it is
+ a map, wrap it in a JSONObject. If it is a standard property (Double,
+ String, et al) then it is already wrapped. Otherwise, if it comes from
+ one of the java packages, turn it into a string. And if it doesn't, try
+ to wrap it in a JSONObject. If the wrapping fails, then null is returned.
+
+The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object). The
+ toJSONString method will be used instead of the default behavior
+ of using the Object's toString() method and quoting the result.
+
+
+
+
+
+
+
+
+
+
+
+
+
+Method Summary
+
+
+
+ java.lang.String
+
toJSONString()
+
+
+ The toJSONString method allows a class to produce its own JSON
+ serialization.
+
+
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+toJSONString
+
+java.lang.String toJSONString()
+
+
The toJSONString method allows a class to produce its own JSON
+ serialization.
+
+JSONStringer provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONStringer can produce one JSON text.
+
+ A JSONStringer instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONStringer adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
+
Make a fresh JSONStringer. It can be used to build one JSON text.
+
+
+
+
+
+
+
+
+
+Method Detail
+
+
+
+
+toString
+
+public java.lang.String toString()
+
+
Return the JSON text. This method is used to obtain the product of the
+ JSONStringer instance. It will return null if there was a
+ problem in the construction of the JSON text (such as the calls to
+ array were not properly balanced with calls to
+ endArray).
+
+A JSONTokener takes a source string and extracts characters and tokens from
+ it. It is used by the JSONObject and JSONArray constructors to parse
+ JSON source strings.
+
+
+
+
+
Author:
+
JSON.org
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
JSONTokener(java.io.InputStream inputStream)
+
+
+ Construct a JSONTokener from an InputStream.
+
+
+
JSONTokener(java.io.Reader reader)
+
+
+ Construct a JSONTokener from a Reader.
+
+
+
JSONTokener(java.lang.String s)
+
+
+ Construct a JSONTokener from a string.
nextClean()
+
+
+ Get the next char in the string, skipping whitespace.
+
+
+
+ java.lang.String
+
nextString(char quote)
+
+
+ Return the characters up to the next close quote character.
+
+
+
+ java.lang.String
+
nextTo(char delimiter)
+
+
+ Get the text up but not including the specified character or the
+ end of line, whichever comes first.
+
+
+
+ java.lang.String
+
nextTo(java.lang.String delimiters)
+
+
+ Get the text up but not including one of the specified delimiter
+ characters or the end of line, whichever comes first.
Back up one character. This provides a sort of lookahead capability,
+ so that you can test for a digit or letter before attempting to parse
+ the next number or identifier.
+
Return the characters up to the next close quote character.
+ Backslash processing is done. The formal JSON format does not
+ allow strings in single quotes, but an implementation is allowed to
+ accept them.
+
+
+
Parameters:
quote - The quoting character, either
+ " (double quote) or
+ ' (single quote).
+
+JSONWriter provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONWriter can produce one JSON text.
+
+ A JSONWriter instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting a cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONWriter adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
+
+
+
+
+
Author:
+
JSON.org
+
+
+
+
+
+
+
+
+
+
+
+Constructor Summary
+
+
+
JSONWriter(java.io.Writer w)
+
+
+ Make a fresh JSONWriter.
Begin appending a new array. All values until the balancing
+ endArray will be appended to this array. The
+ endArray method must be called to mark the array's end.
+
+
+
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
Begin appending a new object. All keys and values until the balancing
+ endObject will be appended to this object. The
+ endObject method must be called to mark the object's end.
+
+
+
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
escape(java.lang.String string)
+
+
+ Replace special characters with XML escapes:
+
+ & (ampersand) is replaced by &
+ < (less than) is replaced by <
+ > (greater than) is replaced by >
+ " (double quote) is replaced by "
+
+
+
+
+static void
+
noSpace(java.lang.String string)
+
+
+ Throw an exception if the string contains whitespace.
+
+
+
+static java.lang.Object
+
stringToValue(java.lang.String string)
+
+
+ Try to convert a string into a number, boolean, or null.
+ & (ampersand) is replaced by &
+ < (less than) is replaced by <
+ > (greater than) is replaced by >
+ " (double quote) is replaced by "
+
Try to convert a string into a number, boolean, or null. If the string
+ can't be converted, return the string. This is much less ambitious than
+ JSONObject.stringToValue, especially because it does not attempt to
+ convert plus forms, octal forms, hex forms, or E forms lacking decimal
+ points.
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject. Some information may be lost in this transformation
+ because JSON is a data format and XML is a document format. XML uses
+ elements, attributes, and content text, while JSON uses unordered
+ collections of name/value pairs and arrays of values. JSON does not
+ does not like to distinguish between elements and attributes.
+ Sequences of similar elements are represented as JSONArrays. Content
+ text may be placed in a "content" member. Comments, prologs, DTDs, and
+ <[ [ ]]> are ignored.
+
+
+
Parameters:
string - The source string.
+
Returns:
A JSONObject containing the structured data from the XML string.
+
Get the next XML outer token, trimming whitespace. There are two kinds
+ of tokens: the '<' character which begins a markup tag, and the content
+ text between markup tags.
+
+
+
+
Returns:
A string, or a '<' Character, or null if there is no more
+ source text.
+
Returns the next XML meta token. This is used for skipping over
+ and structures.
+
+
+
+
Returns:
Syntax characters (< > / = ! ?) are returned as
+ Character, and strings and names are returned as Boolean. We don't care
+ what the values actually are.
+
Throws:
+
JSONException - If a string is not properly closed or if the XML
+ is badly structured.
Get the next XML Token. These tokens are found inside of angle
+ brackets. It may be one of these characters: / > = ! ? or it
+ may be a string wrapped in single quotes or double quotes, or it may be a
+ name.
+
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
+ Feel free to replace this paragraph with a description of the library. Contributed libraries are developed, documented, and maintained by members of the Processing community. Further directions are included with each library. For feedback and support, please post to the Discourse. We strongly encourage all libraries to be open source, but not all of them are.
+
+
+
+
+
+
+
Download
+
+ Download json4processing version 0.1.4 in
+ .zip format.
+
+
Installation
+
+ Unzip and put the extracted json4processing folder into the libraries folder of your processing sketches. Reference and examples are included in the json4processing folder.
+
+
+
+
+
+
Keywords ?
+
Reference. Have a look at the javadoc reference here. a copy of the reference is included in the .zip as well.
+
Source. The source code of json4processing is available at github, and its repository can be browsed here.
+
+
+
+
Examples
+
Find a list of examples in the current distribution of json4processing, or have a look at them by following the links below.
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
+
Interfaces (italic)
+
Classes
+
Enums
+
Exceptions
+
Errors
+
Annotation Types
+
+
+
+
Class/Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+
Class inheritance diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class/interface declaration
+
Class/interface description
+
+
+
Nested Class Summary
+
Field Summary
+
Constructor Summary
+
Method Summary
+
+
+
Field Detail
+
Constructor Detail
+
Method Detail
+
+
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Annotation Type
+
Each annotation type has its own separate page with the following sections:
+
+
Annotation Type declaration
+
Annotation Type description
+
Required Element Summary
+
Optional Element Summary
+
Element Detail
+
+
+
+
Enum
+
Each enum has its own separate page with the following sections:
+
+
Enum declaration
+
Enum description
+
Enum Constant Summary
+
Enum Constant Detail
+
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
+
Index
+
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
+
Prev/Next
+
These links take you to the next or previous class, interface, package, or related page.
+
+
+
Frames/No Frames
+
These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+
All Classes
+
The All Classes link shows all classes and interfaces except non-static nested types.
+
+
+
Serialized Form
+
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
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.
This provides static methods to convert comma delimited text into a
+ JSONArray, and to covert a JSONArray into comma delimited text. Comma
+ delimited text is a very popular format for data interchange. It is
+ understood by most database, spreadsheet, and organizer programs.
+
+ Each row of text represents a row in a table or a data record. Each row
+ ends with a NEWLINE character. Each row contains one or more values.
+ Values are separated by commas. A value can contain any character except
+ for comma, unless is is wrapped in single quotes or double quotes.
+
+ The first row usually contains the names of the columns.
+
+ A comma delimited list can be converted into a JSONArray of JSONObjects.
+ The names for the elements in the JSONObjects can be taken from the names
+ in the first row.
public static java.lang.String escape(java.lang.String string)
+
Produce a copy of a string in which the characters '+', '%', '=', ';'
+ and control characters are replaced with "%hh". This is a gentle form
+ of URL encoding, attempting to cause as little distortion to the
+ string as possible. The characters '=' and ';' are meta characters in
+ cookies. By convention, they are escaped using the URL-encoding. This is
+ only a convention, not a standard. Often, cookies are expected to have
+ encoded values. We encode '=' and ';' because we must. We encode '%' and
+ '+' because they are meta characters in URL encoding.
Convert a cookie specification string into a JSONObject. The string
+ will contain a name value pair separated by '='. The name and the value
+ will be unescaped, possibly converting '+' and '%' sequences. The
+ cookie properties may follow, separated by ';', also represented as
+ name=value (except the secure property, which does not have a value).
+ The name will be stored under the key "name", and the value will be
+ stored under the key "value". This method does not do checking or
+ validation of the parameters. It only converts the cookie string into
+ a JSONObject.
+
Parameters:
string - The cookie specification string.
+
Returns:
A JSONObject containing "name", "value", and possibly other
+ members.
Convert a JSONObject into a cookie specification string. The JSONObject
+ must contain "name" and "value" members.
+ If the JSONObject contains "expires", "domain", "path", or "secure"
+ members, they will be appended to the cookie specification string.
+ All other members are ignored.
Convert a cookie list into a JSONObject. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The names and the values
+ will be unescaped, possibly converting '+' and '%' sequences.
+
+ To add a cookie to a cooklist,
+ cookielistJSONObject.put(cookieJSONObject.getString("name"),
+ cookieJSONObject.getString("value"));
Convert a JSONObject into a cookie list. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The characters '%', '+', '=', and ';'
+ in the names and values are replaced by "%hh".
A JSONArray is an ordered sequence of values. Its external text form is a
+ string wrapped in square brackets with commas separating the values. The
+ internal form is an object having get and opt
+ methods for accessing the values by index, and put methods for
+ adding or replacing values. The values can be any of these types:
+ Boolean, JSONArray, JSONObject,
+ Number, String, or the
+ JSONObject.NULL object.
+
+ The constructor can convert a JSON text into a Java object. The
+ toString method converts to JSON text.
+
+ 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 texts produced by the toString methods strictly conform to
+ JSON syntax rules. The constructors are more forgiving in the texts they will
+ accept:
+
+
An extra , (comma) may appear just
+ before the closing bracket.
+
The null value will be inserted when there
+ is , (comma) elision.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces,
+ and if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers
+ and if they are not the reserved words true,
+ false, or null.
+
Values can be separated by ; (semicolon) as
+ well as by , (comma).
public java.lang.String join(java.lang.String separator)
+ throws JSONException
+
Make a string from the contents of this JSONArray. The
+ separator string is inserted between each element.
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
separator - A string that will be inserted between the elements.
+
Returns:
a string.
+
Throws:
+
JSONException - If the array contains an invalid number.
Get the optional boolean value associated with an index.
+ It returns false if there is no value at that index,
+ or if the value is not Boolean.TRUE or the String "true".
+
Parameters:
index - The index must be between 0 and length() - 1.
public boolean optBoolean(int index,
+ boolean defaultValue)
+
Get the optional boolean value associated with an index.
+ It returns the defaultValue if there is no value at that index or if
+ it is not a Boolean or the String "true" or "false" (case insensitive).
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional double value associated with an index.
+ NaN is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public double optDouble(int index,
+ double defaultValue)
+
Get the optional double value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
Get the optional int value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional int value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional JSONObject associated with an index.
+ Null is returned if the key is not found, or null if the index has
+ no value, or if the value is not a JSONObject.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional long value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public long optLong(int index,
+ long defaultValue)
+
Get the optional long value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional string value associated with an index. It returns an
+ empty string if there is no value at that index. If the value
+ is not a string and is not null, then it is coverted to a string.
+
Parameters:
index - The index must be between 0 and length() - 1.
Put or replace a boolean value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
Put or replace a double value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
+
Parameters:
index - The subscript.
value - A double value.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the value is
+ not finite.
Put or replace an int value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
Put or replace a long value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
public JSONArray put(int index,
+ java.lang.Object value)
+
Put or replace an object value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
+
Parameters:
index - The subscript.
value - The value to put into the array. The value should be a
+ Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the
+ JSONObject.NULL object.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the the value is
+ an invalid number.
Make a JSON text of this JSONArray. For compactness, no
+ unnecessary whitespace is added. If it is not possible to produce a
+ syntactically correct JSON text then null will be returned instead. This
+ could occur if the array contains an invalid number.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, transmittable
+ representation of the array.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child content and tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener of the XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
Reverse the JSONML transformation, making an XML text from a JSONObject.
+ The JSONObject must contain a "tagName" property. If it has children,
+ then it must have a "childNodes" property containing an array of objects.
+ The other properties are attributes with string values.
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:
+
+
An extra , (comma) may appear just
+ before the closing brace.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces, and
+ if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers and
+ if they are not the reserved words true, false, or
+ null.
+
Keys can be followed by = or => as well as by
+ :.
+
Values can be followed by ; (semicolon) as
+ well as by , (comma).
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.
It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
+ JSONObject.NULL.equals(null) returns true.
+ JSONObject.NULL.toString() returns "null".
public JSONObject(JSONObject jo,
+ java.lang.String[] names)
+
Construct a JSONObject from a subset of another JSONObject. An array of
+ strings is used to identify the keys that should be copied. Missing keys
+ are ignored.
Construct a JSONObject from an Object using bean getters. It reflects on
+ all of the public methods of the object. For each of the methods with no
+ parameters and a name starting with "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".
+
Parameters:
bean - An object that has getter methods that should be used to make
+ a JSONObject.
public JSONObject(java.lang.Object object,
+ java.lang.String[] names)
+
Construct a JSONObject from an Object, using reflection to find the
+ public members. The resulting JSONObject's keys will be the strings from
+ the names array, and the values will be the field values associated with
+ those keys in the object. If a key is not found or not visible, then it
+ will not be copied into the new JSONObject.
+
Parameters:
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 JSONObject accumulate(java.lang.String key,
+ java.lang.Object value)
+
Accumulate values under a key. It is similar to the put method except
+ that if there is already an object stored under the key then a JSONArray
+ is stored under the key to hold all of the accumulated values. If there
+ is already a JSONArray, then the new value is appended to it. In
+ contrast, the put method replaces the previous value.
+
+ If only one value is accumulated that is not a JSONArray, then the result
+ will be the same as using put. But if multiple values are accumulated,
+ then the result will be like append.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is an invalid number or if the key is null.
public JSONObject append(java.lang.String key,
+ java.lang.Object value)
+
Append values to the array under a key. If the key does not exist in the
+ JSONObject, then the key is put in the JSONObject with its value being a
+ JSONArray containing the value parameter. If the key was already
+ associated with a JSONArray, then the value parameter is appended to it.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the key is null or if the current value associated with
+ the key is not a JSONArray.
Increment a property of a JSONObject. If there is no such property,
+ create one with a value of 1. If there is such a property, and if it is
+ an Integer, Long, Double, or Float, then add one to it.
+
Parameters:
key - A key string.
+
Returns:
this.
+
Throws:
+
JSONException - If there is already a property with this name that is not an
+ Integer, Long, Double, or Float.
public boolean optBoolean(java.lang.String key,
+ boolean defaultValue)
+
Get an optional boolean associated with a key. It returns the
+ defaultValue if there is no such key, or if it is not a Boolean or the
+ String "true" or "false" (case insensitive).
Get an optional double associated with a key, or NaN if there is no such
+ key or if its value is not a number. If the value is a string, an attempt
+ will be made to evaluate it as a number.
public 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. If the value is a
+ string, an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
public java.lang.String optString(java.lang.String key)
+
Get an optional string associated with a key. It returns an empty string
+ if there is no such key. If the value is not a string and is not null,
+ then it is converted to a string.
public JSONObject put(java.lang.String key,
+ java.lang.Object value)
+
Put a key/value pair in the JSONObject. If the value is null, then the
+ key will be removed from the JSONObject if it is present.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is non-finite number or if the key is null.
public 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.
public 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.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is a non-finite number.
Make a JSON text of this JSONObject. For compactness, no whitespace is
+ added. If this would not result in a syntactically correct JSON text,
+ then null will be returned instead.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, portable, transmittable representation
+ of the object, beginning with { (left
+ brace) and ending with } (right
+ brace).
public static java.lang.String valueToString(java.lang.Object value)
+
Make a JSON text of an Object value. If the object has an
+ value.toJSONString() method, then that method will be used to produce the
+ JSON text. The method is required to produce a strictly conforming text.
+ If the object does not contain a toJSONString method (which is the most
+ common case), then a text will be produced by other means. If the value
+ is an array or Collection, then a JSONArray will be made from it and its
+ toJSONString method will be called. If the value is a MAP, then a
+ JSONObject will be made from it and its toJSONString method will be
+ called. Otherwise, the value's toString method will be called, and the
+ result will be quoted.
+
+
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
value - The value to be serialized.
+
Returns:
a printable, displayable, transmittable representation of the
+ object, beginning with { (left
+ brace) and ending with } (right
+ brace).
+
Throws:
+
JSONException - If the value is or contains an invalid number.
public static java.lang.Object wrap(java.lang.Object object)
+
Wrap an object, if necessary. If the object is null, return the NULL
+ object. If it is an array or collection, wrap it in a JSONArray. If it is
+ a map, wrap it in a JSONObject. If it is a standard property (Double,
+ String, et al) then it is already wrapped. Otherwise, if it comes from
+ one of the java packages, turn it into a string. And if it doesn't, try
+ to wrap it in a JSONObject. If the wrapping fails, then null is returned.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object). The
+ toJSONString method will be used instead of the default behavior
+ of using the Object's toString() method and quoting the result.
JSONStringer provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONStringer can produce one JSON text.
+
+ A JSONStringer instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONStringer adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Return the JSON text. This method is used to obtain the product of the
+ JSONStringer instance. It will return null if there was a
+ problem in the construction of the JSON text (such as the calls to
+ array were not properly balanced with calls to
+ endArray).
public class JSONTokener
+extends java.lang.Object
+
A JSONTokener takes a source string and extracts characters and tokens from
+ it. It is used by the JSONObject and JSONArray constructors to parse
+ JSON source strings.
Back up one character. This provides a sort of lookahead capability,
+ so that you can test for a digit or letter before attempting to parse
+ the next number or identifier.
public java.lang.String nextString(char quote)
+ throws JSONException
+
Return the characters up to the next close quote character.
+ Backslash processing is done. The formal JSON format does not
+ allow strings in single quotes, but an implementation is allowed to
+ accept them.
+
Parameters:
quote - The quoting character, either
+ " (double quote) or
+ ' (single quote).
JSONWriter provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONWriter can produce one JSON text.
+
+ A JSONWriter instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting a cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONWriter adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Begin appending a new array. All values until the balancing
+ endArray will be appended to this array. The
+ endArray method must be called to mark the array's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
Begin appending a new object. All keys and values until the balancing
+ endObject will be appended to this object. The
+ endObject method must be called to mark the object's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
public static java.lang.String escape(java.lang.String string)
+
Replace special characters with XML escapes:
+
+ & (ampersand) is replaced by &
+ < (less than) is replaced by <
+ > (greater than) is replaced by >
+ " (double quote) is replaced by "
+
public static java.lang.Object stringToValue(java.lang.String string)
+
Try to convert a string into a number, boolean, or null. If the string
+ can't be converted, return the string. This is much less ambitious than
+ JSONObject.stringToValue, especially because it does not attempt to
+ convert plus forms, octal forms, hex forms, or E forms lacking decimal
+ points.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject. Some information may be lost in this transformation
+ because JSON is a data format and XML is a document format. XML uses
+ elements, attributes, and content text, while JSON uses unordered
+ collections of name/value pairs and arrays of values. JSON does not
+ does not like to distinguish between elements and attributes.
+ Sequences of similar elements are represented as JSONArrays. Content
+ text may be placed in a "content" member. Comments, prologs, DTDs, and
+ <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONObject containing the structured data from the XML string.
public java.lang.Object nextContent()
+ throws JSONException
+
Get the next XML outer token, trimming whitespace. There are two kinds
+ of tokens: the '<' character which begins a markup tag, and the content
+ text between markup tags.
+
Returns:
A string, or a '<' Character, or null if there is no more
+ source text.
public java.lang.Object nextMeta()
+ throws JSONException
+
Returns the next XML meta token. This is used for skipping over
+ and structures.
+
Returns:
Syntax characters (< > / = ! ?) are returned as
+ Character, and strings and names are returned as Boolean. We don't care
+ what the values actually are.
+
Throws:
+
JSONException - If a string is not properly closed or if the XML
+ is badly structured.
public java.lang.Object nextToken()
+ throws JSONException
+
Get the next XML Token. These tokens are found inside of angle
+ brackets. It may be one of these characters: / > = ! ? or it
+ may be a string wrapped in single quotes or double quotes, or it may be a
+ name.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
+ Feel free to replace this paragraph with a description of the library. Contributed libraries are developed, documented, and maintained by members of the Processing community. Further directions are included with each library. For feedback and support, please post to the Discourse. We strongly encourage all libraries to be open source, but not all of them are.
+
+
+
+
+
+
+
Download
+
+ Download json4processing version 0.1.5 in
+ .zip format.
+
+
Installation
+
+ Unzip and put the extracted json4processing folder into the libraries folder of your processing sketches. Reference and examples are included in the json4processing folder.
+
+
+
+
+
+
Keywords ?
+
Reference. Have a look at the javadoc reference here. a copy of the reference is included in the .zip as well.
+
Source. The source code of json4processing is available at github, and its repository can be browsed here.
+
+
+
+
Examples
+
Find a list of examples in the current distribution of json4processing, or have a look at them by following the links below.
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
+
Interfaces (italic)
+
Classes
+
Enums
+
Exceptions
+
Errors
+
Annotation Types
+
+
+
+
Class/Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+
Class inheritance diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class/interface declaration
+
Class/interface description
+
+
+
Nested Class Summary
+
Field Summary
+
Constructor Summary
+
Method Summary
+
+
+
Field Detail
+
Constructor Detail
+
Method Detail
+
+
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Annotation Type
+
Each annotation type has its own separate page with the following sections:
+
+
Annotation Type declaration
+
Annotation Type description
+
Required Element Summary
+
Optional Element Summary
+
Element Detail
+
+
+
+
Enum
+
Each enum has its own separate page with the following sections:
+
+
Enum declaration
+
Enum description
+
Enum Constant Summary
+
Enum Constant Detail
+
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
+
Index
+
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
+
Prev/Next
+
These links take you to the next or previous class, interface, package, or related page.
+
+
+
Frames/No Frames
+
These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+
All Classes
+
The All Classes link shows all classes and interfaces except non-static nested types.
+
+
+
Serialized Form
+
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
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.
This provides static methods to convert comma delimited text into a
+ JSONArray, and to covert a JSONArray into comma delimited text. Comma
+ delimited text is a very popular format for data interchange. It is
+ understood by most database, spreadsheet, and organizer programs.
+
+ Each row of text represents a row in a table or a data record. Each row
+ ends with a NEWLINE character. Each row contains one or more values.
+ Values are separated by commas. A value can contain any character except
+ for comma, unless is is wrapped in single quotes or double quotes.
+
+ The first row usually contains the names of the columns.
+
+ A comma delimited list can be converted into a JSONArray of JSONObjects.
+ The names for the elements in the JSONObjects can be taken from the names
+ in the first row.
public static java.lang.String escape(java.lang.String string)
+
Produce a copy of a string in which the characters '+', '%', '=', ';'
+ and control characters are replaced with "%hh". This is a gentle form
+ of URL encoding, attempting to cause as little distortion to the
+ string as possible. The characters '=' and ';' are meta characters in
+ cookies. By convention, they are escaped using the URL-encoding. This is
+ only a convention, not a standard. Often, cookies are expected to have
+ encoded values. We encode '=' and ';' because we must. We encode '%' and
+ '+' because they are meta characters in URL encoding.
Convert a cookie specification string into a JSONObject. The string
+ will contain a name value pair separated by '='. The name and the value
+ will be unescaped, possibly converting '+' and '%' sequences. The
+ cookie properties may follow, separated by ';', also represented as
+ name=value (except the secure property, which does not have a value).
+ The name will be stored under the key "name", and the value will be
+ stored under the key "value". This method does not do checking or
+ validation of the parameters. It only converts the cookie string into
+ a JSONObject.
+
Parameters:
string - The cookie specification string.
+
Returns:
A JSONObject containing "name", "value", and possibly other
+ members.
Convert a JSONObject into a cookie specification string. The JSONObject
+ must contain "name" and "value" members.
+ If the JSONObject contains "expires", "domain", "path", or "secure"
+ members, they will be appended to the cookie specification string.
+ All other members are ignored.
Convert a cookie list into a JSONObject. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The names and the values
+ will be unescaped, possibly converting '+' and '%' sequences.
+
+ To add a cookie to a cooklist,
+ cookielistJSONObject.put(cookieJSONObject.getString("name"),
+ cookieJSONObject.getString("value"));
Convert a JSONObject into a cookie list. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The characters '%', '+', '=', and ';'
+ in the names and values are replaced by "%hh".
A JSONArray is an ordered sequence of values. Its external text form is a
+ string wrapped in square brackets with commas separating the values. The
+ internal form is an object having get and opt
+ methods for accessing the values by index, and put methods for
+ adding or replacing values. The values can be any of these types:
+ Boolean, JSONArray, JSONObject,
+ Number, String, or the
+ JSONObject.NULL object.
+
+ The constructor can convert a JSON text into a Java object. The
+ toString method converts to JSON text.
+
+ 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 texts produced by the toString methods strictly conform to
+ JSON syntax rules. The constructors are more forgiving in the texts they will
+ accept:
+
+
An extra , (comma) may appear just
+ before the closing bracket.
+
The null value will be inserted when there
+ is , (comma) elision.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces,
+ and if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers
+ and if they are not the reserved words true,
+ false, or null.
+
Values can be separated by ; (semicolon) as
+ well as by , (comma).
public java.lang.String join(java.lang.String separator)
+ throws JSONException
+
Make a string from the contents of this JSONArray. The
+ separator string is inserted between each element.
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
separator - A string that will be inserted between the elements.
+
Returns:
a string.
+
Throws:
+
JSONException - If the array contains an invalid number.
Get the optional boolean value associated with an index.
+ It returns false if there is no value at that index,
+ or if the value is not Boolean.TRUE or the String "true".
+
Parameters:
index - The index must be between 0 and length() - 1.
public boolean optBoolean(int index,
+ boolean defaultValue)
+
Get the optional boolean value associated with an index.
+ It returns the defaultValue if there is no value at that index or if
+ it is not a Boolean or the String "true" or "false" (case insensitive).
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional double value associated with an index.
+ NaN is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public double optDouble(int index,
+ double defaultValue)
+
Get the optional double value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
Get the optional int value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional int value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional JSONObject associated with an index.
+ Null is returned if the key is not found, or null if the index has
+ no value, or if the value is not a JSONObject.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional long value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public long optLong(int index,
+ long defaultValue)
+
Get the optional long value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional string value associated with an index. It returns an
+ empty string if there is no value at that index. If the value
+ is not a string and is not null, then it is coverted to a string.
+
Parameters:
index - The index must be between 0 and length() - 1.
Put or replace a boolean value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
Put or replace a double value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
+
Parameters:
index - The subscript.
value - A double value.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the value is
+ not finite.
Put or replace an int value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
Put or replace a long value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
public JSONArray put(int index,
+ java.lang.Object value)
+
Put or replace an object value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
+
Parameters:
index - The subscript.
value - The value to put into the array. The value should be a
+ Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the
+ JSONObject.NULL object.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the the value is
+ an invalid number.
Make a JSON text of this JSONArray. For compactness, no
+ unnecessary whitespace is added. If it is not possible to produce a
+ syntactically correct JSON text then null will be returned instead. This
+ could occur if the array contains an invalid number.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, transmittable
+ representation of the array.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child content and tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener of the XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
Reverse the JSONML transformation, making an XML text from a JSONObject.
+ The JSONObject must contain a "tagName" property. If it has children,
+ then it must have a "childNodes" property containing an array of objects.
+ The other properties are attributes with string values.
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:
+
+
An extra , (comma) may appear just
+ before the closing brace.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces, and
+ if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers and
+ if they are not the reserved words true, false, or
+ null.
+
Keys can be followed by = or => as well as by
+ :.
+
Values can be followed by ; (semicolon) as
+ well as by , (comma).
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.
It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
+ JSONObject.NULL.equals(null) returns true.
+ JSONObject.NULL.toString() returns "null".
public JSONObject(JSONObject jo,
+ java.lang.String[] names)
+
Construct a JSONObject from a subset of another JSONObject. An array of
+ strings is used to identify the keys that should be copied. Missing keys
+ are ignored.
Construct a JSONObject from an Object using bean getters. It reflects on
+ all of the public methods of the object. For each of the methods with no
+ parameters and a name starting with "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".
+
Parameters:
bean - An object that has getter methods that should be used to make
+ a JSONObject.
public JSONObject(java.lang.Object object,
+ java.lang.String[] names)
+
Construct a JSONObject from an Object, using reflection to find the
+ public members. The resulting JSONObject's keys will be the strings from
+ the names array, and the values will be the field values associated with
+ those keys in the object. If a key is not found or not visible, then it
+ will not be copied into the new JSONObject.
+
Parameters:
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 JSONObject accumulate(java.lang.String key,
+ java.lang.Object value)
+
Accumulate values under a key. It is similar to the put method except
+ that if there is already an object stored under the key then a JSONArray
+ is stored under the key to hold all of the accumulated values. If there
+ is already a JSONArray, then the new value is appended to it. In
+ contrast, the put method replaces the previous value.
+
+ If only one value is accumulated that is not a JSONArray, then the result
+ will be the same as using put. But if multiple values are accumulated,
+ then the result will be like append.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is an invalid number or if the key is null.
public JSONObject append(java.lang.String key,
+ java.lang.Object value)
+
Append values to the array under a key. If the key does not exist in the
+ JSONObject, then the key is put in the JSONObject with its value being a
+ JSONArray containing the value parameter. If the key was already
+ associated with a JSONArray, then the value parameter is appended to it.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the key is null or if the current value associated with
+ the key is not a JSONArray.
Increment a property of a JSONObject. If there is no such property,
+ create one with a value of 1. If there is such a property, and if it is
+ an Integer, Long, Double, or Float, then add one to it.
+
Parameters:
key - A key string.
+
Returns:
this.
+
Throws:
+
JSONException - If there is already a property with this name that is not an
+ Integer, Long, Double, or Float.
public boolean optBoolean(java.lang.String key,
+ boolean defaultValue)
+
Get an optional boolean associated with a key. It returns the
+ defaultValue if there is no such key, or if it is not a Boolean or the
+ String "true" or "false" (case insensitive).
Get an optional double associated with a key, or NaN if there is no such
+ key or if its value is not a number. If the value is a string, an attempt
+ will be made to evaluate it as a number.
public 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. If the value is a
+ string, an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
public java.lang.String optString(java.lang.String key)
+
Get an optional string associated with a key. It returns an empty string
+ if there is no such key. If the value is not a string and is not null,
+ then it is converted to a string.
public JSONObject put(java.lang.String key,
+ java.lang.Object value)
+
Put a key/value pair in the JSONObject. If the value is null, then the
+ key will be removed from the JSONObject if it is present.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is non-finite number or if the key is null.
public 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.
public 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.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is a non-finite number.
Make a JSON text of this JSONObject. For compactness, no whitespace is
+ added. If this would not result in a syntactically correct JSON text,
+ then null will be returned instead.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, portable, transmittable representation
+ of the object, beginning with { (left
+ brace) and ending with } (right
+ brace).
public static java.lang.String valueToString(java.lang.Object value)
+
Make a JSON text of an Object value. If the object has an
+ value.toJSONString() method, then that method will be used to produce the
+ JSON text. The method is required to produce a strictly conforming text.
+ If the object does not contain a toJSONString method (which is the most
+ common case), then a text will be produced by other means. If the value
+ is an array or Collection, then a JSONArray will be made from it and its
+ toJSONString method will be called. If the value is a MAP, then a
+ JSONObject will be made from it and its toJSONString method will be
+ called. Otherwise, the value's toString method will be called, and the
+ result will be quoted.
+
+
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
value - The value to be serialized.
+
Returns:
a printable, displayable, transmittable representation of the
+ object, beginning with { (left
+ brace) and ending with } (right
+ brace).
+
Throws:
+
JSONException - If the value is or contains an invalid number.
public static java.lang.Object wrap(java.lang.Object object)
+
Wrap an object, if necessary. If the object is null, return the NULL
+ object. If it is an array or collection, wrap it in a JSONArray. If it is
+ a map, wrap it in a JSONObject. If it is a standard property (Double,
+ String, et al) then it is already wrapped. Otherwise, if it comes from
+ one of the java packages, turn it into a string. And if it doesn't, try
+ to wrap it in a JSONObject. If the wrapping fails, then null is returned.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object). The
+ toJSONString method will be used instead of the default behavior
+ of using the Object's toString() method and quoting the result.
JSONStringer provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONStringer can produce one JSON text.
+
+ A JSONStringer instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONStringer adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Return the JSON text. This method is used to obtain the product of the
+ JSONStringer instance. It will return null if there was a
+ problem in the construction of the JSON text (such as the calls to
+ array were not properly balanced with calls to
+ endArray).
public class JSONTokener
+extends java.lang.Object
+
A JSONTokener takes a source string and extracts characters and tokens from
+ it. It is used by the JSONObject and JSONArray constructors to parse
+ JSON source strings.
Back up one character. This provides a sort of lookahead capability,
+ so that you can test for a digit or letter before attempting to parse
+ the next number or identifier.
public java.lang.String nextString(char quote)
+ throws JSONException
+
Return the characters up to the next close quote character.
+ Backslash processing is done. The formal JSON format does not
+ allow strings in single quotes, but an implementation is allowed to
+ accept them.
+
Parameters:
quote - The quoting character, either
+ " (double quote) or
+ ' (single quote).
JSONWriter provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONWriter can produce one JSON text.
+
+ A JSONWriter instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting a cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONWriter adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Begin appending a new array. All values until the balancing
+ endArray will be appended to this array. The
+ endArray method must be called to mark the array's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
Begin appending a new object. All keys and values until the balancing
+ endObject will be appended to this object. The
+ endObject method must be called to mark the object's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
public static java.lang.String escape(java.lang.String string)
+
Replace special characters with XML escapes:
+
+ & (ampersand) is replaced by &
+ < (less than) is replaced by <
+ > (greater than) is replaced by >
+ " (double quote) is replaced by "
+
public static java.lang.Object stringToValue(java.lang.String string)
+
Try to convert a string into a number, boolean, or null. If the string
+ can't be converted, return the string. This is much less ambitious than
+ JSONObject.stringToValue, especially because it does not attempt to
+ convert plus forms, octal forms, hex forms, or E forms lacking decimal
+ points.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject. Some information may be lost in this transformation
+ because JSON is a data format and XML is a document format. XML uses
+ elements, attributes, and content text, while JSON uses unordered
+ collections of name/value pairs and arrays of values. JSON does not
+ does not like to distinguish between elements and attributes.
+ Sequences of similar elements are represented as JSONArrays. Content
+ text may be placed in a "content" member. Comments, prologs, DTDs, and
+ <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONObject containing the structured data from the XML string.
public java.lang.Object nextContent()
+ throws JSONException
+
Get the next XML outer token, trimming whitespace. There are two kinds
+ of tokens: the '<' character which begins a markup tag, and the content
+ text between markup tags.
+
Returns:
A string, or a '<' Character, or null if there is no more
+ source text.
public java.lang.Object nextMeta()
+ throws JSONException
+
Returns the next XML meta token. This is used for skipping over
+ and structures.
+
Returns:
Syntax characters (< > / = ! ?) are returned as
+ Character, and strings and names are returned as Boolean. We don't care
+ what the values actually are.
+
Throws:
+
JSONException - If a string is not properly closed or if the XML
+ is badly structured.
public java.lang.Object nextToken()
+ throws JSONException
+
Get the next XML Token. These tokens are found inside of angle
+ brackets. It may be one of these characters: / > = ! ? or it
+ may be a string wrapped in single quotes or double quotes, or it may be a
+ name.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
+ Feel free to replace this paragraph with a description of the library. Contributed libraries are developed, documented, and maintained by members of the Processing community. Further directions are included with each library. For feedback and support, please post to the Discourse. We strongly encourage all libraries to be open source, but not all of them are.
+
+
+
+
+
+
+
Download
+
+ Download json4processing version 0.1.6 in
+ .zip format.
+
+
Installation
+
+ Unzip and put the extracted json4processing folder into the libraries folder of your processing sketches. Reference and examples are included in the json4processing folder.
+
+
+
+
+
+
Keywords ?
+
Reference. Have a look at the javadoc reference here. a copy of the reference is included in the .zip as well.
+
Source. The source code of json4processing is available at github, and its repository can be browsed here.
+
+
+
+
Examples
+
Find a list of examples in the current distribution of json4processing, or have a look at them by following the links below.
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
+
Interfaces (italic)
+
Classes
+
Enums
+
Exceptions
+
Errors
+
Annotation Types
+
+
+
+
Class/Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+
Class inheritance diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class/interface declaration
+
Class/interface description
+
+
+
Nested Class Summary
+
Field Summary
+
Constructor Summary
+
Method Summary
+
+
+
Field Detail
+
Constructor Detail
+
Method Detail
+
+
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Annotation Type
+
Each annotation type has its own separate page with the following sections:
+
+
Annotation Type declaration
+
Annotation Type description
+
Required Element Summary
+
Optional Element Summary
+
Element Detail
+
+
+
+
Enum
+
Each enum has its own separate page with the following sections:
+
+
Enum declaration
+
Enum description
+
Enum Constant Summary
+
Enum Constant Detail
+
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
+
Index
+
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
+
Prev/Next
+
These links take you to the next or previous class, interface, package, or related page.
+
+
+
Frames/No Frames
+
These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+
All Classes
+
The All Classes link shows all classes and interfaces except non-static nested types.
+
+
+
Serialized Form
+
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
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.
This provides static methods to convert comma delimited text into a
+ JSONArray, and to covert a JSONArray into comma delimited text. Comma
+ delimited text is a very popular format for data interchange. It is
+ understood by most database, spreadsheet, and organizer programs.
+
+ Each row of text represents a row in a table or a data record. Each row
+ ends with a NEWLINE character. Each row contains one or more values.
+ Values are separated by commas. A value can contain any character except
+ for comma, unless is is wrapped in single quotes or double quotes.
+
+ The first row usually contains the names of the columns.
+
+ A comma delimited list can be converted into a JSONArray of JSONObjects.
+ The names for the elements in the JSONObjects can be taken from the names
+ in the first row.
public static java.lang.String escape(java.lang.String string)
+
Produce a copy of a string in which the characters '+', '%', '=', ';'
+ and control characters are replaced with "%hh". This is a gentle form
+ of URL encoding, attempting to cause as little distortion to the
+ string as possible. The characters '=' and ';' are meta characters in
+ cookies. By convention, they are escaped using the URL-encoding. This is
+ only a convention, not a standard. Often, cookies are expected to have
+ encoded values. We encode '=' and ';' because we must. We encode '%' and
+ '+' because they are meta characters in URL encoding.
public static JSONObj toJSONObject(java.lang.String string)
+ throws JSONException
+
Convert a cookie specification string into a JSONObject. The string
+ will contain a name value pair separated by '='. The name and the value
+ will be unescaped, possibly converting '+' and '%' sequences. The
+ cookie properties may follow, separated by ';', also represented as
+ name=value (except the secure property, which does not have a value).
+ The name will be stored under the key "name", and the value will be
+ stored under the key "value". This method does not do checking or
+ validation of the parameters. It only converts the cookie string into
+ a JSONObject.
+
Parameters:
string - The cookie specification string.
+
Returns:
A JSONObject containing "name", "value", and possibly other
+ members.
Convert a JSONObject into a cookie specification string. The JSONObject
+ must contain "name" and "value" members.
+ If the JSONObject contains "expires", "domain", "path", or "secure"
+ members, they will be appended to the cookie specification string.
+ All other members are ignored.
public static JSONObj toJSONObject(java.lang.String string)
+ throws JSONException
+
Convert a cookie list into a JSONObject. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The names and the values
+ will be unescaped, possibly converting '+' and '%' sequences.
+
+ To add a cookie to a cooklist,
+ cookielistJSONObject.put(cookieJSONObject.getString("name"),
+ cookieJSONObject.getString("value"));
Convert a JSONObject into a cookie list. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The characters '%', '+', '=', and ';'
+ in the names and values are replaced by "%hh".
This is a "mashup" test for combining the two JSON types, the goal is to make
+ it work similarly to how the processing XML library works.
+
+ loadJSON(); should be able of returning both types of objects, and to do that
+ without having the typecast you need to combine the two classes somehow.
+
+ The way you use this is calling JSON.loadJSON("filename"); (or similar) and
+ then the class will maintain the type of object it is (either array or
+ object) and simply forward the requests the user does to the correct class...
+ of course making sure that the type is of correct class! You shouldn't be
+ able of calling ".get(index)" on an JSONObject for example... it should then
+ notify the user by a simple text message to the console.
It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
+ JSONObject.NULL.equals(null) returns true.
+ JSONObject.NULL.toString() returns "null".
A JSONArray is an ordered sequence of values. Its external text form is a
+ string wrapped in square brackets with commas separating the values. The
+ internal form is an object having get and opt
+ methods for accessing the values by index, and put methods for
+ adding or replacing values. The values can be any of these types:
+ Boolean, JSONArray, JSONObject,
+ Number, String, or the
+ JSONObject.NULL object.
+
+ The constructor can convert a JSON text into a Java object. The
+ toString method converts to JSON text.
+
+ 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 texts produced by the toString methods strictly conform to
+ JSON syntax rules. The constructors are more forgiving in the texts they will
+ accept:
+
+
An extra , (comma) may appear just
+ before the closing bracket.
+
The null value will be inserted when there
+ is , (comma) elision.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces,
+ and if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers
+ and if they are not the reserved words true,
+ false, or null.
+
Values can be separated by ; (semicolon) as
+ well as by , (comma).
public java.lang.String join(java.lang.String separator)
+ throws JSONException
+
Make a string from the contents of this JSONArray. The
+ separator string is inserted between each element.
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
separator - A string that will be inserted between the elements.
+
Returns:
a string.
+
Throws:
+
JSONException - If the array contains an invalid number.
Get the optional boolean value associated with an index.
+ It returns false if there is no value at that index,
+ or if the value is not Boolean.TRUE or the String "true".
+
Parameters:
index - The index must be between 0 and length() - 1.
public boolean optBoolean(int index,
+ boolean defaultValue)
+
Get the optional boolean value associated with an index.
+ It returns the defaultValue if there is no value at that index or if
+ it is not a Boolean or the String "true" or "false" (case insensitive).
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional double value associated with an index.
+ NaN is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public double optDouble(int index,
+ double defaultValue)
+
Get the optional double value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
Get the optional int value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional int value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional JSONObject associated with an index.
+ Null is returned if the key is not found, or null if the index has
+ no value, or if the value is not a JSONObject.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional long value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public long optLong(int index,
+ long defaultValue)
+
Get the optional long value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional string value associated with an index. It returns an
+ empty string if there is no value at that index. If the value
+ is not a string and is not null, then it is coverted to a string.
+
Parameters:
index - The index must be between 0 and length() - 1.
Put or replace a boolean value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
Put or replace a double value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
+
Parameters:
index - The subscript.
value - A double value.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the value is
+ not finite.
Put or replace an int value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
Put or replace a long value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
public JSONArr put(int index,
+ java.lang.Object value)
+
Put or replace an object value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
+
Parameters:
index - The subscript.
value - The value to put into the array. The value should be a
+ Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the
+ JSONObject.NULL object.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the the value is
+ an invalid number.
Make a JSON text of this JSONArray. For compactness, no
+ unnecessary whitespace is added. If it is not possible to produce a
+ syntactically correct JSON text then null will be returned instead. This
+ could occur if the array contains an invalid number.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, transmittable
+ representation of the array.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
public static JSONArr toJSONArray(java.lang.String string)
+ throws JSONException
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child content and tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener of the XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
public static JSONObj toJSONObject(java.lang.String string)
+ throws JSONException
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
Reverse the JSONML transformation, making an XML text from a JSONObject.
+ The JSONObject must contain a "tagName" property. If it has children,
+ then it must have a "childNodes" property containing an array of objects.
+ The other properties are attributes with string values.
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:
+
+
An extra , (comma) may appear just
+ before the closing brace.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces, and
+ if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers and
+ if they are not the reserved words true, false, or
+ null.
+
Keys can be followed by = or => as well as by
+ :.
+
Values can be followed by ; (semicolon) as
+ well as by , (comma).
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.
It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
+ JSONObject.NULL.equals(null) returns true.
+ JSONObject.NULL.toString() returns "null".
public JSONObj(JSONObj jo,
+ java.lang.String[] names)
+
Construct a JSONObject from a subset of another JSONObject. An array of
+ strings is used to identify the keys that should be copied. Missing keys
+ are ignored.
Construct a JSONObject from an Object using bean getters. It reflects on
+ all of the public methods of the object. For each of the methods with no
+ parameters and a name starting with "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".
+
Parameters:
bean - An object that has getter methods that should be used to make
+ a JSONObject.
public JSONObj(java.lang.Object object,
+ java.lang.String[] names)
+
Construct a JSONObject from an Object, using reflection to find the
+ public members. The resulting JSONObject's keys will be the strings from
+ the names array, and the values will be the field values associated with
+ those keys in the object. If a key is not found or not visible, then it
+ will not be copied into the new JSONObject.
+
Parameters:
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 JSONObj accumulate(java.lang.String key,
+ java.lang.Object value)
+
Accumulate values under a key. It is similar to the put method except
+ that if there is already an object stored under the key then a JSONArray
+ is stored under the key to hold all of the accumulated values. If there
+ is already a JSONArray, then the new value is appended to it. In
+ contrast, the put method replaces the previous value.
+
+ If only one value is accumulated that is not a JSONArray, then the result
+ will be the same as using put. But if multiple values are accumulated,
+ then the result will be like append.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is an invalid number or if the key is null.
public JSONObj append(java.lang.String key,
+ java.lang.Object value)
+
Append values to the array under a key. If the key does not exist in the
+ JSONObject, then the key is put in the JSONObject with its value being a
+ JSONArray containing the value parameter. If the key was already
+ associated with a JSONArray, then the value parameter is appended to it.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the key is null or if the current value associated with
+ the key is not a JSONArray.
Increment a property of a JSONObject. If there is no such property,
+ create one with a value of 1. If there is such a property, and if it is
+ an Integer, Long, Double, or Float, then add one to it.
+
Parameters:
key - A key string.
+
Returns:
this.
+
Throws:
+
JSONException - If there is already a property with this name that is not an
+ Integer, Long, Double, or Float.
public boolean optBoolean(java.lang.String key,
+ boolean defaultValue)
+
Get an optional boolean associated with a key. It returns the
+ defaultValue if there is no such key, or if it is not a Boolean or the
+ String "true" or "false" (case insensitive).
Get an optional double associated with a key, or NaN if there is no such
+ key or if its value is not a number. If the value is a string, an attempt
+ will be made to evaluate it as a number.
public 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. If the value is a
+ string, an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
public java.lang.String optString(java.lang.String key)
+
Get an optional string associated with a key. It returns an empty string
+ if there is no such key. If the value is not a string and is not null,
+ then it is converted to a string.
public JSONObj put(java.lang.String key,
+ java.lang.Object value)
+
Put a key/value pair in the JSONObject. If the value is null, then the
+ key will be removed from the JSONObject if it is present.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is non-finite number or if the key is null.
public JSONObj 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.
public JSONObj 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.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is a non-finite number.
Make a JSON text of this JSONObject. For compactness, no whitespace is
+ added. If this would not result in a syntactically correct JSON text,
+ then null will be returned instead.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, portable, transmittable representation
+ of the object, beginning with { (left
+ brace) and ending with } (right
+ brace).
public static java.lang.String valueToString(java.lang.Object value)
+
Make a JSON text of an Object value. If the object has an
+ value.toJSONString() method, then that method will be used to produce the
+ JSON text. The method is required to produce a strictly conforming text.
+ If the object does not contain a toJSONString method (which is the most
+ common case), then a text will be produced by other means. If the value
+ is an array or Collection, then a JSONArray will be made from it and its
+ toJSONString method will be called. If the value is a MAP, then a
+ JSONObject will be made from it and its toJSONString method will be
+ called. Otherwise, the value's toString method will be called, and the
+ result will be quoted.
+
+
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
value - The value to be serialized.
+
Returns:
a printable, displayable, transmittable representation of the
+ object, beginning with { (left
+ brace) and ending with } (right
+ brace).
+
Throws:
+
JSONException - If the value is or contains an invalid number.
public static java.lang.Object wrap(java.lang.Object object)
+
Wrap an object, if necessary. If the object is null, return the NULL
+ object. If it is an array or collection, wrap it in a JSONArray. If it is
+ a map, wrap it in a JSONObject. If it is a standard property (Double,
+ String, et al) then it is already wrapped. Otherwise, if it comes from
+ one of the java packages, turn it into a string. And if it doesn't, try
+ to wrap it in a JSONObject. If the wrapping fails, then null is returned.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object). The
+ toJSONString method will be used instead of the default behavior
+ of using the Object's toString() method and quoting the result.
JSONStringer provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONStringer can produce one JSON text.
+
+ A JSONStringer instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONStringer adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Return the JSON text. This method is used to obtain the product of the
+ JSONStringer instance. It will return null if there was a
+ problem in the construction of the JSON text (such as the calls to
+ array were not properly balanced with calls to
+ endArray).
public class JSONTokener
+extends java.lang.Object
+
A JSONTokener takes a source string and extracts characters and tokens from
+ it. It is used by the JSONObject and JSONArray constructors to parse
+ JSON source strings.
Back up one character. This provides a sort of lookahead capability,
+ so that you can test for a digit or letter before attempting to parse
+ the next number or identifier.
Return the characters up to the next close quote character.
+ Backslash processing is done. The formal JSON format does not
+ allow strings in single quotes, but an implementation is allowed to
+ accept them.
+
Parameters:
quote - The quoting character, either
+ " (double quote) or
+ ' (single quote).
JSONWriter provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONWriter can produce one JSON text.
+
+ A JSONWriter instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting a cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONWriter adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Begin appending a new array. All values until the balancing
+ endArray will be appended to this array. The
+ endArray method must be called to mark the array's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
Begin appending a new object. All keys and values until the balancing
+ endObject will be appended to this object. The
+ endObject method must be called to mark the object's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
public static java.lang.String escape(java.lang.String string)
+
Replace special characters with XML escapes:
+
+ & (ampersand) is replaced by &
+ < (less than) is replaced by <
+ > (greater than) is replaced by >
+ " (double quote) is replaced by "
+
public static java.lang.Object stringToValue(java.lang.String string)
+
Try to convert a string into a number, boolean, or null. If the string
+ can't be converted, return the string. This is much less ambitious than
+ JSONObject.stringToValue, especially because it does not attempt to
+ convert plus forms, octal forms, hex forms, or E forms lacking decimal
+ points.
public static JSON toJSON(java.lang.String string)
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject. Some information may be lost in this transformation
+ because JSON is a data format and XML is a document format. XML uses
+ elements, attributes, and content text, while JSON uses unordered
+ collections of name/value pairs and arrays of values. JSON does not
+ does not like to distinguish between elements and attributes.
+ Sequences of similar elements are represented as JSONArrays. Content
+ text may be placed in a "content" member. Comments, prologs, DTDs, and
+ <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONObject containing the structured data from the XML string.
Get the next XML outer token, trimming whitespace. There are two kinds
+ of tokens: the '<' character which begins a markup tag, and the content
+ text between markup tags.
+
Returns:
A string, or a '<' Character, or null if there is no more
+ source text.
Returns the next XML meta token. This is used for skipping over
+ and structures.
+
Returns:
Syntax characters (< > / = ! ?) are returned as
+ Character, and strings and names are returned as Boolean. We don't care
+ what the values actually are.
+
Throws:
+
JSONException - If a string is not properly closed or if the XML
+ is badly structured.
Get the next XML Token. These tokens are found inside of angle
+ brackets. It may be one of these characters: / > = ! ? or it
+ may be a string wrapped in single quotes or double quotes, or it may be a
+ name.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
+ Feel free to replace this paragraph with a description of the library. Contributed libraries are developed, documented, and maintained by members of the Processing community. Further directions are included with each library. For feedback and support, please post to the Discourse. We strongly encourage all libraries to be open source, but not all of them are.
+
+
+
+
+
+
+
Download
+
+ Download json4processing version 0.1.7 in
+ .zip format.
+
+
Installation
+
+ Unzip and put the extracted json4processing folder into the libraries folder of your processing sketches. Reference and examples are included in the json4processing folder.
+
+
+
+
+
+
Keywords ?
+
Reference. Have a look at the javadoc reference here. a copy of the reference is included in the .zip as well.
+
Source. The source code of json4processing is available at github, and its repository can be browsed here.
+
+
+
+
Examples
+
Find a list of examples in the current distribution of json4processing, or have a look at them by following the links below.
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+
+
Interfaces (italic)
+
Classes
+
Enums
+
Exceptions
+
Errors
+
Annotation Types
+
+
+
+
Class/Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+
Class inheritance diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class/interface declaration
+
Class/interface description
+
+
+
Nested Class Summary
+
Field Summary
+
Constructor Summary
+
Method Summary
+
+
+
Field Detail
+
Constructor Detail
+
Method Detail
+
+
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Annotation Type
+
Each annotation type has its own separate page with the following sections:
+
+
Annotation Type declaration
+
Annotation Type description
+
Required Element Summary
+
Optional Element Summary
+
Element Detail
+
+
+
+
Enum
+
Each enum has its own separate page with the following sections:
+
+
Enum declaration
+
Enum description
+
Enum Constant Summary
+
Enum Constant Detail
+
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+
+
+
Deprecated API
+
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+
+
+
Index
+
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+
+
+
Prev/Next
+
These links take you to the next or previous class, interface, package, or related page.
+
+
+
Frames/No Frames
+
These links show and hide the HTML frames. All pages are available with or without frames.
+
+
+
All Classes
+
The All Classes link shows all classes and interfaces except non-static nested types.
+
+
+
Serialized Form
+
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
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.
This provides static methods to convert comma delimited text into a
+ JSONArray, and to covert a JSONArray into comma delimited text. Comma
+ delimited text is a very popular format for data interchange. It is
+ understood by most database, spreadsheet, and organizer programs.
+
+ Each row of text represents a row in a table or a data record. Each row
+ ends with a NEWLINE character. Each row contains one or more values.
+ Values are separated by commas. A value can contain any character except
+ for comma, unless is is wrapped in single quotes or double quotes.
+
+ The first row usually contains the names of the columns.
+
+ A comma delimited list can be converted into a JSONArray of JSONObjects.
+ The names for the elements in the JSONObjects can be taken from the names
+ in the first row.
public static java.lang.String escape(java.lang.String string)
+
Produce a copy of a string in which the characters '+', '%', '=', ';'
+ and control characters are replaced with "%hh". This is a gentle form
+ of URL encoding, attempting to cause as little distortion to the
+ string as possible. The characters '=' and ';' are meta characters in
+ cookies. By convention, they are escaped using the URL-encoding. This is
+ only a convention, not a standard. Often, cookies are expected to have
+ encoded values. We encode '=' and ';' because we must. We encode '%' and
+ '+' because they are meta characters in URL encoding.
public static JSONObj toJSONObject(java.lang.String string)
+ throws JSONException
+
Convert a cookie specification string into a JSONObject. The string
+ will contain a name value pair separated by '='. The name and the value
+ will be unescaped, possibly converting '+' and '%' sequences. The
+ cookie properties may follow, separated by ';', also represented as
+ name=value (except the secure property, which does not have a value).
+ The name will be stored under the key "name", and the value will be
+ stored under the key "value". This method does not do checking or
+ validation of the parameters. It only converts the cookie string into
+ a JSONObject.
+
Parameters:
string - The cookie specification string.
+
Returns:
A JSONObject containing "name", "value", and possibly other
+ members.
Convert a JSONObject into a cookie specification string. The JSONObject
+ must contain "name" and "value" members.
+ If the JSONObject contains "expires", "domain", "path", or "secure"
+ members, they will be appended to the cookie specification string.
+ All other members are ignored.
public static JSONObj toJSONObject(java.lang.String string)
+ throws JSONException
+
Convert a cookie list into a JSONObject. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The names and the values
+ will be unescaped, possibly converting '+' and '%' sequences.
+
+ To add a cookie to a cooklist,
+ cookielistJSONObject.put(cookieJSONObject.getString("name"),
+ cookieJSONObject.getString("value"));
Convert a JSONObject into a cookie list. A cookie list is a sequence
+ of name/value pairs. The names are separated from the values by '='.
+ The pairs are separated by ';'. The characters '%', '+', '=', and ';'
+ in the names and values are replaced by "%hh".
This is a "mashup" test for combining the two JSON types, the goal is to make
+ it work similarly to how the processing XML library works.
+
+ loadJSON(); should be able of returning both types of objects, and to do that
+ without having the typecast you need to combine the two classes somehow.
+
+ The way you use this is calling JSON.loadJSON("filename"); (or similar) and
+ then the class will maintain the type of object it is (either array or
+ object) and simply forward the requests the user does to the correct class...
+ of course making sure that the type is of correct class! You shouldn't be
+ able of calling ".get(index)" on an JSONObject for example... it should then
+ notify the user by a simple text message to the console.
It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
+ JSONObject.NULL.equals(null) returns true.
+ JSONObject.NULL.toString() returns "null".
A JSONArray is an ordered sequence of values. Its external text form is a
+ string wrapped in square brackets with commas separating the values. The
+ internal form is an object having get and opt
+ methods for accessing the values by index, and put methods for
+ adding or replacing values. The values can be any of these types:
+ Boolean, JSONArray, JSONObject,
+ Number, String, or the
+ JSONObject.NULL object.
+
+ The constructor can convert a JSON text into a Java object. The
+ toString method converts to JSON text.
+
+ 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 texts produced by the toString methods strictly conform to
+ JSON syntax rules. The constructors are more forgiving in the texts they will
+ accept:
+
+
An extra , (comma) may appear just
+ before the closing bracket.
+
The null value will be inserted when there
+ is , (comma) elision.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces,
+ and if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers
+ and if they are not the reserved words true,
+ false, or null.
+
Values can be separated by ; (semicolon) as
+ well as by , (comma).
public java.lang.String join(java.lang.String separator)
+ throws JSONException
+
Make a string from the contents of this JSONArray. The
+ separator string is inserted between each element.
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
separator - A string that will be inserted between the elements.
+
Returns:
a string.
+
Throws:
+
JSONException - If the array contains an invalid number.
Get the optional boolean value associated with an index.
+ It returns false if there is no value at that index,
+ or if the value is not Boolean.TRUE or the String "true".
+
Parameters:
index - The index must be between 0 and length() - 1.
public boolean optBoolean(int index,
+ boolean defaultValue)
+
Get the optional boolean value associated with an index.
+ It returns the defaultValue if there is no value at that index or if
+ it is not a Boolean or the String "true" or "false" (case insensitive).
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional double value associated with an index.
+ NaN is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public double optDouble(int index,
+ double defaultValue)
+
Get the optional double value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
Get the optional int value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional int value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional JSONObject associated with an index.
+ Null is returned if the key is not found, or null if the index has
+ no value, or if the value is not a JSONObject.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional long value associated with an index.
+ Zero is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
public long optLong(int index,
+ long defaultValue)
+
Get the optional long value associated with an index.
+ The defaultValue is returned if there is no value for the index,
+ or if the value is not a number and cannot be converted to a number.
+
Parameters:
index - The index must be between 0 and length() - 1.
Get the optional string value associated with an index. It returns an
+ empty string if there is no value at that index. If the value
+ is not a string and is not null, then it is coverted to a string.
+
Parameters:
index - The index must be between 0 and length() - 1.
Put or replace a boolean value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
Put or replace a double value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
+
Parameters:
index - The subscript.
value - A double value.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the value is
+ not finite.
Put or replace an int value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
Put or replace a long value. If the index is greater than the length of
+ the JSONArray, then null elements will be added as necessary to pad
+ it out.
public JSONArr put(int index,
+ java.lang.Object value)
+
Put or replace an object value in the JSONArray. If the index is greater
+ than the length of the JSONArray, then null elements will be added as
+ necessary to pad it out.
+
Parameters:
index - The subscript.
value - The value to put into the array. The value should be a
+ Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the
+ JSONObject.NULL object.
+
Returns:
this.
+
Throws:
+
JSONException - If the index is negative or if the the value is
+ an invalid number.
Make a JSON text of this JSONArray. For compactness, no
+ unnecessary whitespace is added. If it is not possible to produce a
+ syntactically correct JSON text then null will be returned instead. This
+ could occur if the array contains an invalid number.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, transmittable
+ representation of the array.
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
public static JSONArr toJSONArray(java.lang.String string)
+ throws JSONException
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONArray using the JsonML transform. Each XML tag is represented as
+ a JSONArray in which the first element is the tag name. If the tag has
+ attributes, then the second element will be JSONObject containing the
+ name/value pairs. If the tag contains children, then strings and
+ JSONArrays will represent the child content and tags.
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener.
+
Returns:
A JSONArray containing the structured data from the XML string.
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
x - An XMLTokener of the XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
public static JSON toJSON(java.lang.String string)
+ throws JSONException
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject using the JsonML transform. Each XML tag is represented as
+ a JSONObject with a "tagName" property. If the tag has attributes, then
+ the attributes will be in the JSONObject as properties. If the tag
+ contains children, the object will have a "childNodes" property which
+ will be an array of strings and JsonML JSONObjects.
+
+ Comments, prologs, DTDs, and <[ [ ]]> are ignored.
+
Parameters:
string - The XML source text.
+
Returns:
A JSONObject containing the structured data from the XML string.
Reverse the JSONML transformation, making an XML text from a JSONObject.
+ The JSONObject must contain a "tagName" property. If it has children,
+ then it must have a "childNodes" property containing an array of objects.
+ The other properties are attributes with string values.
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:
+
+
An extra , (comma) may appear just
+ before the closing brace.
+
Strings may be quoted with ' (single
+ quote).
+
Strings do not need to be quoted at all if they do not begin with a quote
+ or single quote, and if they do not contain leading or trailing spaces, and
+ if they do not contain any of these characters:
+ { } [ ] / \ : , = ; # and if they do not look like numbers and
+ if they are not the reserved words true, false, or
+ null.
+
Keys can be followed by = or => as well as by
+ :.
+
Values can be followed by ; (semicolon) as
+ well as by , (comma).
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.
It is sometimes more convenient and less ambiguous to have a
+ NULL object than to use Java's null value.
+ JSONObject.NULL.equals(null) returns true.
+ JSONObject.NULL.toString() returns "null".
public JSONObj(JSONObj jo,
+ java.lang.String[] names)
+
Construct a JSONObject from a subset of another JSONObject. An array of
+ strings is used to identify the keys that should be copied. Missing keys
+ are ignored.
Construct a JSONObject from an Object using bean getters. It reflects on
+ all of the public methods of the object. For each of the methods with no
+ parameters and a name starting with "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".
+
Parameters:
bean - An object that has getter methods that should be used to make
+ a JSONObject.
public JSONObj(java.lang.Object object,
+ java.lang.String[] names)
+
Construct a JSONObject from an Object, using reflection to find the
+ public members. The resulting JSONObject's keys will be the strings from
+ the names array, and the values will be the field values associated with
+ those keys in the object. If a key is not found or not visible, then it
+ will not be copied into the new JSONObject.
+
Parameters:
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 JSONObj accumulate(java.lang.String key,
+ java.lang.Object value)
+
Accumulate values under a key. It is similar to the put method except
+ that if there is already an object stored under the key then a JSONArray
+ is stored under the key to hold all of the accumulated values. If there
+ is already a JSONArray, then the new value is appended to it. In
+ contrast, the put method replaces the previous value.
+
+ If only one value is accumulated that is not a JSONArray, then the result
+ will be the same as using put. But if multiple values are accumulated,
+ then the result will be like append.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is an invalid number or if the key is null.
public JSONObj append(java.lang.String key,
+ java.lang.Object value)
+
Append values to the array under a key. If the key does not exist in the
+ JSONObject, then the key is put in the JSONObject with its value being a
+ JSONArray containing the value parameter. If the key was already
+ associated with a JSONArray, then the value parameter is appended to it.
+
Parameters:
key - A key string.
value - An object to be accumulated under the key.
+
Returns:
this.
+
Throws:
+
JSONException - If the key is null or if the current value associated with
+ the key is not a JSONArray.
Increment a property of a JSONObject. If there is no such property,
+ create one with a value of 1. If there is such a property, and if it is
+ an Integer, Long, Double, or Float, then add one to it.
+
Parameters:
key - A key string.
+
Returns:
this.
+
Throws:
+
JSONException - If there is already a property with this name that is not an
+ Integer, Long, Double, or Float.
public boolean optBoolean(java.lang.String key,
+ boolean defaultValue)
+
Get an optional boolean associated with a key. It returns the
+ defaultValue if there is no such key, or if it is not a Boolean or the
+ String "true" or "false" (case insensitive).
Get an optional double associated with a key, or NaN if there is no such
+ key or if its value is not a number. If the value is a string, an attempt
+ will be made to evaluate it as a number.
public 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. If the value is a
+ string, an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
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. If the value is a string, an
+ attempt will be made to evaluate it as a number.
public 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. If the value is a string,
+ an attempt will be made to evaluate it as a number.
public java.lang.String optString(java.lang.String key)
+
Get an optional string associated with a key. It returns an empty string
+ if there is no such key. If the value is not a string and is not null,
+ then it is converted to a string.
public JSONObj put(java.lang.String key,
+ java.lang.Object value)
+
Put a key/value pair in the JSONObject. If the value is null, then the
+ key will be removed from the JSONObject if it is present.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is non-finite number or if the key is null.
public JSONObj 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.
public JSONObj 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.
+
Parameters:
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.
+
Returns:
this.
+
Throws:
+
JSONException - If the value is a non-finite number.
Make a JSON text of this JSONObject. For compactness, no whitespace is
+ added. If this would not result in a syntactically correct JSON text,
+ then null will be returned instead.
+
+ Warning: This method assumes that the data structure is acyclical.
+
+
Overrides:
+
toString in class java.lang.Object
+
Returns:
a printable, displayable, portable, transmittable representation
+ of the object, beginning with { (left
+ brace) and ending with } (right
+ brace).
public static java.lang.String valueToString(java.lang.Object value)
+
Make a JSON text of an Object value. If the object has an
+ value.toJSONString() method, then that method will be used to produce the
+ JSON text. The method is required to produce a strictly conforming text.
+ If the object does not contain a toJSONString method (which is the most
+ common case), then a text will be produced by other means. If the value
+ is an array or Collection, then a JSONArray will be made from it and its
+ toJSONString method will be called. If the value is a MAP, then a
+ JSONObject will be made from it and its toJSONString method will be
+ called. Otherwise, the value's toString method will be called, and the
+ result will be quoted.
+
+
+ Warning: This method assumes that the data structure is acyclical.
+
Parameters:
value - The value to be serialized.
+
Returns:
a printable, displayable, transmittable representation of the
+ object, beginning with { (left
+ brace) and ending with } (right
+ brace).
+
Throws:
+
JSONException - If the value is or contains an invalid number.
public static java.lang.Object wrap(java.lang.Object object)
+
Wrap an object, if necessary. If the object is null, return the NULL
+ object. If it is an array or collection, wrap it in a JSONArray. If it is
+ a map, wrap it in a JSONObject. If it is a standard property (Double,
+ String, et al) then it is already wrapped. Otherwise, if it comes from
+ one of the java packages, turn it into a string. And if it doesn't, try
+ to wrap it in a JSONObject. If the wrapping fails, then null is returned.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object). The
+ toJSONString method will be used instead of the default behavior
+ of using the Object's toString() method and quoting the result.
JSONStringer provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONStringer can produce one JSON text.
+
+ A JSONStringer instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONStringer adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Return the JSON text. This method is used to obtain the product of the
+ JSONStringer instance. It will return null if there was a
+ problem in the construction of the JSON text (such as the calls to
+ array were not properly balanced with calls to
+ endArray).
public class JSONTokener
+extends java.lang.Object
+
A JSONTokener takes a source string and extracts characters and tokens from
+ it. It is used by the JSONObject and JSONArray constructors to parse
+ JSON source strings.
Back up one character. This provides a sort of lookahead capability,
+ so that you can test for a digit or letter before attempting to parse
+ the next number or identifier.
Return the characters up to the next close quote character.
+ Backslash processing is done. The formal JSON format does not
+ allow strings in single quotes, but an implementation is allowed to
+ accept them.
+
Parameters:
quote - The quoting character, either
+ " (double quote) or
+ ' (single quote).
JSONWriter provides a quick and convenient way of producing JSON text.
+ The texts produced strictly conform to JSON syntax rules. No whitespace is
+ added, so the results are ready for transmission or storage. Each instance of
+ JSONWriter can produce one JSON text.
+
+ A JSONWriter instance provides a value method for appending
+ values to the
+ text, and a key
+ method for adding keys before values in objects. There are array
+ and endArray methods that make and bound array values, and
+ object and endObject methods which make and bound
+ object values. All of these methods return the JSONWriter instance,
+ permitting a cascade style. For example,
+ The first method called must be array or object.
+ There are no methods for adding commas or colons. JSONWriter adds them for
+ you. Objects and arrays can be nested up to 20 levels deep.
+
+ This can sometimes be easier than using a JSONObject to build a string.
Begin appending a new array. All values until the balancing
+ endArray will be appended to this array. The
+ endArray method must be called to mark the array's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
Begin appending a new object. All keys and values until the balancing
+ endObject will be appended to this object. The
+ endObject method must be called to mark the object's end.
+
Returns:
this
+
Throws:
+
JSONException - If the nesting is too deep, or if the object is
+ started in the wrong place (for example as a key or after the end of the
+ outermost array or object).
public static java.lang.String escape(java.lang.String string)
+
Replace special characters with XML escapes:
+
+ & (ampersand) is replaced by &
+ < (less than) is replaced by <
+ > (greater than) is replaced by >
+ " (double quote) is replaced by "
+
public static java.lang.Object stringToValue(java.lang.String string)
+
Try to convert a string into a number, boolean, or null. If the string
+ can't be converted, return the string. This is much less ambitious than
+ JSONObject.stringToValue, especially because it does not attempt to
+ convert plus forms, octal forms, hex forms, or E forms lacking decimal
+ points.
public static JSON toJSON(java.lang.String string)
+
Convert a well-formed (but not necessarily valid) XML string into a
+ JSONObject. Some information may be lost in this transformation
+ because JSON is a data format and XML is a document format. XML uses
+ elements, attributes, and content text, while JSON uses unordered
+ collections of name/value pairs and arrays of values. JSON does not
+ does not like to distinguish between elements and attributes.
+ Sequences of similar elements are represented as JSONArrays. Content
+ text may be placed in a "content" member. Comments, prologs, DTDs, and
+ <[ [ ]]> are ignored.
+
Parameters:
string - The source string.
+
Returns:
A JSONObject containing the structured data from the XML string.
Get the next XML outer token, trimming whitespace. There are two kinds
+ of tokens: the '<' character which begins a markup tag, and the content
+ text between markup tags.
+
Returns:
A string, or a '<' Character, or null if there is no more
+ source text.
Returns the next XML meta token. This is used for skipping over
+ and structures.
+
Returns:
Syntax characters (< > / = ! ?) are returned as
+ Character, and strings and names are returned as Boolean. We don't care
+ what the values actually are.
+
Throws:
+
JSONException - If a string is not properly closed or if the XML
+ is badly structured.
Get the next XML Token. These tokens are found inside of angle
+ brackets. It may be one of these characters: / > = ! ? or it
+ may be a string wrapped in single quotes or double quotes, or it may be a
+ name.
The JSONString interface allows a toJSONString()
+ method so that a class can change the behavior of
+ JSONObject.toString(), JSONArray.toString(),
+ and JSONWriter.value(Object).
This provides static methods to convert an XML text into a JSONArray or
+ JSONObject, and to covert a JSONArray or JSONObject into an XML text using
+ the JsonML transform.
processing library json4processing by Andreas Goransson. (c) 2011
+
+
diff --git a/distribution/json4processing-0.1.7/reference/stylesheet.css b/distribution/json4processing-0.1.7/reference/stylesheet.css
new file mode 100644
index 000000000..54998c2bc
--- /dev/null
+++ b/distribution/json4processing-0.1.7/reference/stylesheet.css
@@ -0,0 +1,310 @@
+/* Javadoc style sheet */
+/* Define colors, fonts and other style attributes here to override the defaults */
+/* processingLibs style by andreas schlegel, sojamo */
+
+
+body {
+ margin : 0;
+ padding : 0;
+ padding-left : 10px;
+ padding-right : 8px;
+ background-color : #FFFFFF;
+ font-family : Verdana, Geneva, Arial, Helvetica, sans-serif;
+ font-size : 100%;
+ font-size : 0.7em;
+ font-weight : normal;
+ line-height : normal;
+ margin-bottom:30px;
+}
+
+
+
+
+/* Headings */
+h1, h2, h3, h4, h5, th {
+ font-family :Arial, Helvetica, sans-serif;
+ font-size:1.2em;
+}
+
+
+p {
+ font-size : 1em;
+ width:80%;
+}
+
+pre, code {
+ font-family : "Courier New", Courier, monospace;
+ font-size : 12px;
+ line-height : normal;
+}
+
+
+
+table {
+ border:0;
+ margin-bottom:10px;
+ margin-top:10px;
+}
+
+
+tr, td {
+ border-top: 0px solid;
+ border-left: 0px solid;
+ padding-top:8px;
+ padding-bottom:8px;
+}
+
+
+
+hr {
+ border:0;
+ height:1px;
+ padding:0;
+ margin:0;
+ margin-bottom:4px;
+
+}
+
+
+
+dd, th, td, font {
+ font-size:1.0em;
+ line-height:1.0em;
+}
+
+
+
+dt {
+ margin-bottom:0px;
+}
+
+
+
+dd {
+ margin-top:2px;
+ margin-bottom:4px;
+}
+
+
+
+a {
+ text-decoration: underline;
+ font-weight: normal;
+}
+
+a:hover,
+a:active {
+ text-decoration: underline;
+ font-weight: normal;
+}
+
+a:visited,
+a:link:visited {
+ text-decoration: underline;
+ font-weight: normal;
+}
+
+
+img {
+ border: 0px solid #000000;
+}
+
+
+
+/* Navigation bar fonts */
+.NavBarCell1 {
+ border:0;
+}
+
+.NavBarCell1Rev {
+ border:0;
+}
+
+.NavBarFont1 {
+ font-family: Arial, Helvetica, sans-serif;
+ font-size:1.1em;
+}
+
+
+.NavBarFont1 b {
+ font-weight:normal;
+}
+
+
+
+.NavBarFont1:after, .NavBarFont1Rev:after {
+ font-weight:normal;
+ content: " \\";
+}
+
+
+.NavBarFont1Rev {
+ font-family: Arial, Helvetica, sans-serif;
+ font-size:1.1em;
+}
+
+.NavBarFont1Rev b {
+ font-family: Arial, Helvetica, sans-serif;
+ font-size:1.1em;
+ font-weight:normal;
+}
+
+.NavBarCell2 {
+ font-family: Arial, Helvetica, sans-serif;
+}
+
+.NavBarCell3 {
+ font-family: Arial, Helvetica, sans-serif;
+}
+
+
+
+font.FrameItemFont {
+ font-family: Helvetica, Arial, sans-serif;
+ font-size:1.1em;
+ line-height:1.1em;
+}
+
+font.FrameHeadingFont {
+ font-family: Helvetica, Arial, sans-serif;
+ line-height:32px;
+}
+
+/* Font used in left-hand frame lists */
+.FrameTitleFont {
+ font-family: Helvetica, Arial, sans-serif
+}
+
+
+.toggleList {
+ padding:0;
+ margin:0;
+ margin-top:12px;
+}
+
+.toggleList dt {
+ font-weight:bold;
+ font-size:12px;
+ font-family:arial,sans-serif;
+ padding:0px;
+ margin:10px 0px 10px 0px;
+}
+
+.toggleList dt span {
+ font-family: monospace;
+ padding:0;
+ margin:0;
+}
+
+
+.toggleList dd {
+ margin:0;
+ padding:0;
+}
+
+html.isjs .toggleList dd {
+ display: none;
+}
+
+.toggleList pre {
+ padding: 4px 4px 4px 4px;
+}
+
+
+
+
+
+/* COLORS */
+
+pre, code {
+ color: #000000;
+}
+
+
+body {
+ color : #333333;
+ background-color :#FFFFFF;
+}
+
+
+h1, h2, h3, h4, h5, h6 {
+ color:#555;
+}
+
+a,
+.toggleList dt {
+ color: #1a7eb0;
+}
+
+a:hover,
+a:active {
+ color: #1a7eb0;
+}
+
+a:visited,
+a:link:visited {
+ color: #1a7eb0;
+}
+
+td,tr {
+ border-color: #999999;
+}
+
+hr {
+ color:#999999;
+ background:#999999;
+}
+
+
+.TableHeadingColor {
+ background: #dcdcdc;
+ color: #555;
+}
+
+
+.TableSubHeadingColor {
+ background: #EEEEFF
+}
+
+.TableRowColor {
+ background: #FFFFFF
+}
+
+
+.NavBarCell1 {
+ background-color:#dcdcdc;
+ color:#000;
+}
+
+.NavBarCell1 a {
+ color:#333;
+}
+
+
+.NavBarCell1Rev {
+ background-color:transparent;
+}
+
+.NavBarFont1 {
+ color:#333;
+}
+
+
+.NavBarFont1Rev {
+ color:#fff;
+}
+
+.NavBarCell2 {
+ background-color:#999;
+}
+
+.NavBarCell2 a {
+ color:#fff;
+}
+
+
+
+.NavBarCell3 {
+ background-color:#dcdcdc;
+}
+
diff --git a/distribution/json4processing-0.1.7/stylesheet.css b/distribution/json4processing-0.1.7/stylesheet.css
new file mode 100644
index 000000000..4348b3814
--- /dev/null
+++ b/distribution/json4processing-0.1.7/stylesheet.css
@@ -0,0 +1,203 @@
+/* processingLibs style by andreas schlegel, sojamo. */
+
+
+* {
+ margin:0;
+ padding:0;
+ border:0;
+}
+
+
+body {
+ font-family : Verdana, Geneva, Arial, Helvetica, sans-serif;
+ font-size : 100%;
+ font-size : 0.70em;
+ font-weight : normal;
+ line-height : normal;
+}
+
+
+
+#container {
+ margin-left:64px;
+ background-color:#fff;
+}
+
+#header {
+ float:left;
+ padding-top:24px;
+ padding-bottom:48px;
+}
+
+#menu {
+ margin-top:16px;
+ float:left;
+ margin-bottom:64px;
+}
+
+
+#about,
+#download,
+#examples,
+#demos,
+#misc {
+ width:480px;
+ float:left;
+ margin-right:24px;
+}
+
+
+#resources, #info {
+ width:320px;
+ float:left;
+}
+
+
+.clear {
+ clear:both;
+}
+
+#footer {
+ margin-top:300px;
+ height:20px;
+ margin-bottom:32px;
+}
+
+
+ul {
+ list-style:none;
+ padding:0;
+ margin:0;
+}
+
+
+#menu ul li, #subMenu ul li {
+ float:left;
+ padding-right:6px;
+}
+
+
+
+
+
+
+/* Headings */
+
+h1 {
+ font-size:2em;
+ font-weight:normal;
+}
+
+
+h2, h3, h4, h5, th {
+ font-size:1.3em;
+ font-weight:normal;
+ margin-bottom:4px;
+}
+
+
+
+p {
+ font-size:1em;
+ width:90%;
+ margin-bottom:32px;
+}
+
+
+pre, code {
+ font-family:"Courier New", Courier, monospace;
+ font-size:1em;
+ line-height:normal;
+}
+
+
+
+
+hr {
+ border:0;
+ height:1px;
+ margin-bottom:24px;
+}
+
+
+a {
+ text-decoration: underline;
+ font-weight: normal;
+}
+
+
+a:hover,
+a:active {
+ text-decoration: underline;
+ font-weight: normal;
+}
+
+
+a:visited,
+a:link:visited {
+ text-decoration: underline;
+ font-weight: normal;
+}
+
+
+
+img {
+ border: 0px solid #000000;
+}
+
+
+
+
+
+/* COLORS */
+
+
+body {
+ color : #333;
+ background-color :#fff;
+}
+
+
+#header {
+ background-color:#fff;
+ color:#333;
+}
+
+
+
+h1, h2, h3, h4, h5, h6 {
+ color:#666;
+}
+
+
+pre, code {
+ color: #000000;
+}
+
+
+a,strong {
+ color: #333;
+}
+
+
+a:hover,
+a:active {
+ color: #333;
+}
+
+
+a:visited,
+a:link:visited {
+ color: #333;
+}
+
+
+#footer, #menu {
+ background-color:#fff;
+ color:#333;
+}
+
+
+#footer a, #menu a {
+ color:#333;
+}
diff --git a/examples/OpenSignal/OpenSignal.pde b/examples/OpenSignal/OpenSignal.pde
new file mode 100644
index 000000000..056fd4379
--- /dev/null
+++ b/examples/OpenSignal/OpenSignal.pde
@@ -0,0 +1,48 @@
+/*
+ * JSON 4 Processing
+ * Basic example: Parsing data from OpenSignal API
+ *
+ * Get your own API key from https://opensignal.3scale.net/login
+ */
+
+import org.json.*;
+
+String cid = "10132";
+String lac = "9015";
+String sid = "0";
+String phone_type = "GSM";
+String network_id = "24001";
+String api_key = "";
+
+PFont font;
+
+void setup(){
+ font = loadFont("Ubuntu-24.vlw");
+ textFont(font, 12);
+ fill( 0 );
+
+ // 1. Create the URL
+ String url = "http://api.opensignal.com/v2/towerinfo.json?cid="+cid+"&lac="+lac+"&sid="+sid+"&phone_type="+phone_type+"&network_id="+network_id+"&apikey="+api_key;
+
+ // 2. Get the json-formatted string
+ String[] jsonstring = loadStrings(url);
+
+ // 3. Initialize the object
+ JSON cell_tower = JSON.parse(jsonstring[0]);
+
+ println( cell_tower );
+
+ showInformation( cell_tower.getJSON("tower1") );
+}
+
+void draw(){
+}
+
+void showInformation(JSON tower){
+ translate( 5, 12 );
+ text("Cell tower", 0, 0);
+ text("LAC: " + tower.getString("lac"), 0, 12);
+ text("ID: " + tower.getString("cid"), 0, 24);
+ text("lat: " + tower.getString("est_lat"), 0, 36);
+ text("lng: " + tower.getString("est_lng"), 0, 48);
+}
\ No newline at end of file
diff --git a/examples/OpenSignal/data/Ubuntu-24.vlw b/examples/OpenSignal/data/Ubuntu-24.vlw
new file mode 100644
index 000000000..cda9da601
Binary files /dev/null and b/examples/OpenSignal/data/Ubuntu-24.vlw differ
diff --git a/examples/convert_xml_to_json/convert_xml_to_json.pde b/examples/convert_xml_to_json/convert_xml_to_json.pde
new file mode 100644
index 000000000..62777cff1
--- /dev/null
+++ b/examples/convert_xml_to_json/convert_xml_to_json.pde
@@ -0,0 +1,57 @@
+/**
+ * Loading XML Data
+ * by Daniel Shiffman.
+ * (modified to work with JSON by AGoransson)
+ *
+ * This example demonstrates how to use loadXML()
+ * to retrieve data from an XML document via a URL
+ */
+
+import org.json.*;
+// We're going to store the temperature
+int temperature = 0;
+// We're going to store text about the weather
+String weather = "";
+
+// The zip code we'll check for
+String zip = "10003";
+
+PFont font;
+
+void setup() {
+ size(600, 360);
+
+ font = createFont("Merriweather-Light.vlw", 28);
+ textFont(font);
+
+ // The URL for the XML document
+ String url = "http://xml.weather.yahoo.com/forecastrss?p=" + zip;
+
+ // Load the XML document
+ XML xml = loadXML(url);
+
+ String xmls = xml.toString();
+
+ JSON json = JSONXML.toJSON(xmls);
+
+ JSON rss = json.getJSON("rss");
+ JSON channel = rss.getJSON("channel");
+ JSON item = channel.getJSON("item");
+ JSON forecast = item.getJSON("yweather:forecast");
+
+ JSON today = forecast.getJSON(0);
+
+ // Get the attributes we want
+ temperature = today.getInt("high");
+ weather = today.getString("text");
+}
+
+void draw() {
+ background(255);
+ fill(0);
+
+ // Display all the stuff we want to display
+ text("Zip code: " + zip, width*0.15, height*0.33);
+ text("Todays high: " + temperature, width*0.15, height*0.5);
+ text("Forecast: " + weather, width*0.15, height*0.66);
+}
\ No newline at end of file
diff --git a/examples/create_json_from_file/create_json_from_file.pde b/examples/create_json_from_file/create_json_from_file.pde
new file mode 100644
index 000000000..4eb104840
--- /dev/null
+++ b/examples/create_json_from_file/create_json_from_file.pde
@@ -0,0 +1,15 @@
+/*
+ * JSON 4 Processing
+ * Basic example 5: Loading JSON from a file
+ */
+
+import org.json.*;
+
+void setup(){
+ JSON json = JSON.load(dataPath("data.json"));
+
+ println( json );
+}
+
+void draw(){
+}
\ No newline at end of file
diff --git a/examples/create_json_from_file/data/data.json b/examples/create_json_from_file/data/data.json
new file mode 100644
index 000000000..04832f095
--- /dev/null
+++ b/examples/create_json_from_file/data/data.json
@@ -0,0 +1,6 @@
+{
+ "name": "My data file",
+ "values": [
+ 1, 2, 3, 4
+ ]
+}
\ No newline at end of file
diff --git a/examples/create_jsonarray/create_jsonarray.pde b/examples/create_jsonarray/create_jsonarray.pde
index 93bd2c04f..a1a8bf18b 100644
--- a/examples/create_jsonarray/create_jsonarray.pde
+++ b/examples/create_jsonarray/create_jsonarray.pde
@@ -1,8 +1,6 @@
/*
* JSON 4 Processing
- * Basic example 2: Creating a JSON Array
- *
- * Good for sending a large set of primitive values, like sensor readings.
+ * Basic example 2: Creating a list of JSON values
*/
import org.json.*;
@@ -10,11 +8,11 @@ import org.json.*;
void setup(){
// 1. Initialize the Array
- JSONArray myJsonArray = new JSONArray();
+ JSON myJsonArray = JSON.createArray();
// 2. Add some content to the array
- myJsonArray.put( 4 );
- myJsonArray.put( 2 );
+ myJsonArray.append( 4 );
+ myJsonArray.append( 2 );
println( myJsonArray );
}
diff --git a/examples/create_jsonarray_of_objects/create_jsonarray_of_objects.pde b/examples/create_jsonarray_of_objects/create_jsonarray_of_objects.pde
index 4d6567c5e..5035b8cc6 100644
--- a/examples/create_jsonarray_of_objects/create_jsonarray_of_objects.pde
+++ b/examples/create_jsonarray_of_objects/create_jsonarray_of_objects.pde
@@ -1,8 +1,6 @@
/*
* JSON 4 Processing
- * Basic example 3: Creating a JSON Array of JSON Objects.
- *
- * Good for sending multiple complex values, such as database tables.
+ * Basic example 3: Creating a list of JSON objects
*/
import org.json.*;
@@ -10,22 +8,22 @@ import org.json.*;
void setup(){
// 1. Initialize the Array
- JSONArray myJsonUsers = new JSONArray();
+ JSON myJsonUsers = JSON.createArray();
// 2. Create the first object & add to array
- JSONObject firstUser = new JSONObject();
- firstUser.put( "name", "Andreas" );
- firstUser.put( "age", 32 );
- myJsonUsers.put( firstUser );
+ JSON firstUser = JSON.createObject();
+ firstUser.setString( "name", "Andreas" );
+ firstUser.setInt( "age", 32 );
+ myJsonUsers.append( firstUser );
// 3. Create the second object
- JSONObject secondUser = new JSONObject();
- secondUser.put( "name", "Maria" );
- secondUser.put( "age", 28 );
- myJsonUsers.put( secondUser );
+ JSON secondUser = JSON.createObject();
+ secondUser.setString( "name", "Maria" );
+ secondUser.setInt( "age", 28 );
+ myJsonUsers.append( secondUser );
println( myJsonUsers );
}
void draw(){
-}
+}
\ No newline at end of file
diff --git a/examples/create_jsonobject/create_jsonobject.pde b/examples/create_jsonobject/create_jsonobject.pde
index ba13b64f3..8150442f3 100644
--- a/examples/create_jsonobject/create_jsonobject.pde
+++ b/examples/create_jsonobject/create_jsonobject.pde
@@ -1,6 +1,6 @@
/*
* JSON 4 Processing
- * Basic example 1: Creating a JSON Object
+ * Basic example 1: Creating a JSON object
*
* Good for sending values that has a specific meaning (complex values)
*/
@@ -10,13 +10,13 @@ import org.json.*;
void setup(){
// 1. Initialize the object
- JSONObject myJsonObject = new JSONObject();
+ JSON myJsonObject = JSON.createObject();
// 2. Add some content to the object
- myJsonObject.put( "myIntegerValue", 7 );
+ myJsonObject.setInt( "myIntegerValue", 7 );
println( myJsonObject );
}
void draw(){
-}
+}
\ No newline at end of file
diff --git a/examples/create_jsonobject_from_string/create_jsonobject_from_string.pde b/examples/create_jsonobject_from_string/create_jsonobject_from_string.pde
index a47352f0a..3cda08710 100644
--- a/examples/create_jsonobject_from_string/create_jsonobject_from_string.pde
+++ b/examples/create_jsonobject_from_string/create_jsonobject_from_string.pde
@@ -1,6 +1,6 @@
/*
* JSON 4 Processing
- * Basic example 1: Creating a JSON Object from a json string
+ * Basic example 3: Parsing a JSON formatted string
*/
import org.json.*;
@@ -11,7 +11,7 @@ void setup(){
String jsonstring = "{\"myIntegerValue\":7}";
// 2. Initialize the object
- JSONObject myJsonObject = new JSONObject(jsonstring);
+ JSON myJsonObject = JSON.parse(jsonstring);
println( myJsonObject );
}
diff --git a/resources/build.properties b/resources/build.properties
index cb1cd53c9..bb57fb6a2 100644
--- a/resources/build.properties
+++ b/resources/build.properties
@@ -97,7 +97,7 @@ project.compile=normal
# set the current version of your project.
-project.version=0.1.2
+project.version=0.1.7
project.copyright=(c) 2011
project.dependencies=?
project.keywords=?
diff --git a/src/org/json/CDL.java b/src/org/json/CDL.java
index ffe2ace8b..4d82f25c0 100644
--- a/src/org/json/CDL.java
+++ b/src/org/json/CDL.java
@@ -72,7 +72,7 @@ private static String getValue(JSONTokener x) throws JSONException {
break;
}
if (c == 0 || c == '\n' || c == '\r') {
- throw x.syntaxError("Missing close quote '" + q + "'.");
+// throw x.syntaxError("Missing close quote '" + q + "'.");
}
sb.append(c);
}
@@ -92,8 +92,8 @@ private static String getValue(JSONTokener x) throws JSONException {
* @return A JSONArray of strings.
* @throws JSONException
*/
- public static JSONArray rowToJSONArray(JSONTokener x) throws JSONException {
- JSONArray ja = new JSONArray();
+ public static JSONArr rowToJSONArray(JSONTokener x) throws JSONException {
+ JSONArr ja = new JSONArr();
for (;;) {
String value = getValue(x);
char c = x.next();
@@ -110,8 +110,8 @@ public static JSONArray rowToJSONArray(JSONTokener x) throws JSONException {
if (c == '\n' || c == '\r' || c == 0) {
return ja;
}
- throw x.syntaxError("Bad character '" + c + "' (" +
- (int)c + ").");
+// throw x.syntaxError("Bad character '" + c + "' (" +
+// (int)c + ").");
}
c = x.next();
}
@@ -128,9 +128,9 @@ public static JSONArray rowToJSONArray(JSONTokener x) throws JSONException {
* @return A JSONObject combining the names and values.
* @throws JSONException
*/
- public static JSONObject rowToJSONObject(JSONArray names, JSONTokener x)
+ public static JSONObj rowToJSONObject(JSONArr names, JSONTokener x)
throws JSONException {
- JSONArray ja = rowToJSONArray(x);
+ JSONArr ja = rowToJSONArray(x);
return ja != null ? ja.toJSONObject(names) : null;
}
@@ -141,7 +141,7 @@ public static JSONObject rowToJSONObject(JSONArray names, JSONTokener x)
* @param ja A JSONArray of strings.
* @return A string ending in NEWLINE.
*/
- public static String rowToString(JSONArray ja) {
+ public static String rowToString(JSONArr ja) {
StringBuffer sb = new StringBuffer();
for (int i = 0; i < ja.length(); i += 1) {
if (i > 0) {
@@ -178,7 +178,7 @@ public static String rowToString(JSONArray ja) {
* @return A JSONArray of JSONObjects.
* @throws JSONException
*/
- public static JSONArray toJSONArray(String string) throws JSONException {
+ public static JSONArr toJSONArray(String string) throws JSONException {
return toJSONArray(new JSONTokener(string));
}
@@ -189,7 +189,7 @@ public static JSONArray toJSONArray(String string) throws JSONException {
* @return A JSONArray of JSONObjects.
* @throws JSONException
*/
- public static JSONArray toJSONArray(JSONTokener x) throws JSONException {
+ public static JSONArr toJSONArray(JSONTokener x) throws JSONException {
return toJSONArray(rowToJSONArray(x), x);
}
@@ -201,7 +201,7 @@ public static JSONArray toJSONArray(JSONTokener x) throws JSONException {
* @return A JSONArray of JSONObjects.
* @throws JSONException
*/
- public static JSONArray toJSONArray(JSONArray names, String string)
+ public static JSONArr toJSONArray(JSONArr names, String string)
throws JSONException {
return toJSONArray(names, new JSONTokener(string));
}
@@ -214,14 +214,14 @@ public static JSONArray toJSONArray(JSONArray names, String string)
* @return A JSONArray of JSONObjects.
* @throws JSONException
*/
- public static JSONArray toJSONArray(JSONArray names, JSONTokener x)
+ public static JSONArr toJSONArray(JSONArr names, JSONTokener x)
throws JSONException {
if (names == null || names.length() == 0) {
return null;
}
- JSONArray ja = new JSONArray();
+ JSONArr ja = new JSONArr();
for (;;) {
- JSONObject jo = rowToJSONObject(names, x);
+ JSONObj jo = rowToJSONObject(names, x);
if (jo == null) {
break;
}
@@ -242,10 +242,10 @@ public static JSONArray toJSONArray(JSONArray names, JSONTokener x)
* @return A comma delimited text.
* @throws JSONException
*/
- public static String toString(JSONArray ja) throws JSONException {
- JSONObject jo = ja.optJSONObject(0);
+ public static String toString(JSONArr ja) throws JSONException {
+ JSONObj jo = ja.optJSONObject(0);
if (jo != null) {
- JSONArray names = jo.names();
+ JSONArr names = jo.names();
if (names != null) {
return rowToString(names) + toString(names, ja);
}
@@ -262,14 +262,14 @@ public static String toString(JSONArray ja) throws JSONException {
* @return A comma delimited text.
* @throws JSONException
*/
- public static String toString(JSONArray names, JSONArray ja)
+ public static String toString(JSONArr names, JSONArr ja)
throws JSONException {
if (names == null || names.length() == 0) {
return null;
}
StringBuffer sb = new StringBuffer();
for (int i = 0; i < ja.length(); i += 1) {
- JSONObject jo = ja.optJSONObject(i);
+ JSONObj jo = ja.optJSONObject(i);
if (jo != null) {
sb.append(rowToString(jo.toJSONArray(names)));
}
diff --git a/src/org/json/Cookie.java b/src/org/json/Cookie.java
index a2d9c4ed9..0222ef740 100644
--- a/src/org/json/Cookie.java
+++ b/src/org/json/Cookie.java
@@ -78,10 +78,10 @@ public static String escape(String string) {
* members.
* @throws JSONException
*/
- public static JSONObject toJSONObject(String string) throws JSONException {
+ public static JSONObj toJSONObject(String string) throws JSONException {
String name;
- JSONObject jo = new JSONObject();
- Object value;
+ JSONObj jo = new JSONObj();
+ Object value = null;
JSONTokener x = new JSONTokener(string);
jo.put("name", x.nextTo('='));
x.next('=');
@@ -93,7 +93,7 @@ public static JSONObject toJSONObject(String string) throws JSONException {
if (name.equals("secure")) {
value = Boolean.TRUE;
} else {
- throw x.syntaxError("Missing '=' in cookie parameter.");
+// throw x.syntaxError("Missing '=' in cookie parameter.");
}
} else {
value = unescape(x.nextTo(';'));
@@ -115,7 +115,7 @@ public static JSONObject toJSONObject(String string) throws JSONException {
* @return A cookie specification string
* @throws JSONException
*/
- public static String toString(JSONObject jo) throws JSONException {
+ public static String toString(JSONObj jo) throws JSONException {
StringBuffer sb = new StringBuffer();
sb.append(escape(jo.getString("name")));
diff --git a/src/org/json/CookieList.java b/src/org/json/CookieList.java
index 1111135f3..70c14cd48 100644
--- a/src/org/json/CookieList.java
+++ b/src/org/json/CookieList.java
@@ -46,8 +46,8 @@ public class CookieList {
* @return A JSONObject
* @throws JSONException
*/
- public static JSONObject toJSONObject(String string) throws JSONException {
- JSONObject jo = new JSONObject();
+ public static JSONObj toJSONObject(String string) throws JSONException {
+ JSONObj jo = new JSONObj();
JSONTokener x = new JSONTokener(string);
while (x.more()) {
String name = Cookie.unescape(x.nextTo('='));
@@ -68,7 +68,7 @@ public static JSONObject toJSONObject(String string) throws JSONException {
* @return A cookie list string
* @throws JSONException
*/
- public static String toString(JSONObject jo) throws JSONException {
+ public static String toString(JSONObj jo) throws JSONException {
boolean b = false;
Iterator keys = jo.keys();
String string;
diff --git a/src/org/json/HTTP.java b/src/org/json/HTTP.java
index 037cf4f58..5db4e896a 100644
--- a/src/org/json/HTTP.java
+++ b/src/org/json/HTTP.java
@@ -68,38 +68,45 @@ public class HTTP {
* of the XML string.
* @throws JSONException
*/
- public static JSONObject toJSONObject(String string) throws JSONException {
- JSONObject jo = new JSONObject();
+ public static JSONObj toJSONObject(String string) /*throws JSONException*/ {
+ JSONObj jo = new JSONObj();
HTTPTokener x = new HTTPTokener(string);
- String token;
-
- token = x.nextToken();
- if (token.toUpperCase().startsWith("HTTP")) {
-
-// Response
-
- jo.put("HTTP-Version", token);
- jo.put("Status-Code", x.nextToken());
- jo.put("Reason-Phrase", x.nextTo('\0'));
- x.next();
-
- } else {
-
-// Request
-
- jo.put("Method", token);
- jo.put("Request-URI", x.nextToken());
- jo.put("HTTP-Version", x.nextToken());
- }
-
-// Fields
-
- while (x.more()) {
- String name = x.nextTo(':');
- x.next(':');
- jo.put(name, x.nextTo('\0'));
- x.next();
- }
+ String token = null;
+
+ try {
+ token = x.nextToken();
+
+ if (token != null && token.toUpperCase().startsWith("HTTP")) {
+
+ // Response
+
+ jo.put("HTTP-Version", token);
+ jo.put("Status-Code", x.nextToken());
+ jo.put("Reason-Phrase", x.nextTo('\0'));
+ x.next();
+
+ } else {
+
+ // Request
+
+ jo.put("Method", token);
+ jo.put("Request-URI", x.nextToken());
+ jo.put("HTTP-Version", x.nextToken());
+ }
+
+ // Fields
+
+ while (x.more()) {
+ String name = x.nextTo(':');
+ x.next(':');
+ jo.put(name, x.nextTo('\0'));
+ x.next();
+ }
+
+ } catch (JSONException e) {
+ e.printStackTrace();
+ }
+
return jo;
}
@@ -124,7 +131,7 @@ public static JSONObject toJSONObject(String string) throws JSONException {
* @throws JSONException if the object does not contain enough
* information.
*/
- public static String toString(JSONObject jo) throws JSONException {
+ public static String toString(JSONObj jo) /*throws JSONException*/ {
Iterator keys = jo.keys();
String string;
StringBuffer sb = new StringBuffer();
@@ -143,14 +150,18 @@ public static String toString(JSONObject jo) throws JSONException {
sb.append(' ');
sb.append(jo.getString("HTTP-Version"));
} else {
- throw new JSONException("Not enough material for an HTTP header.");
+ // throw new JSONException("Not enough material for an HTTP header.");
}
sb.append(CRLF);
while (keys.hasNext()) {
string = keys.next().toString();
- if (!string.equals("HTTP-Version") && !string.equals("Status-Code") &&
- !string.equals("Reason-Phrase") && !string.equals("Method") &&
- !string.equals("Request-URI") && !jo.isNull(string)) {
+ if (!"HTTP-Version".equals(string) && !"Status-Code".equals(string) &&
+ !"Reason-Phrase".equals(string) && !"Method".equals(string) &&
+ !"Request-URI".equals(string) && !jo.isNull(string)) {
+ // if (!string.equals("HTTP-Version") && !string.equals("Status-Code")
+ // &&
+ // !string.equals("Reason-Phrase") && !string.equals("Method") &&
+ // !string.equals("Request-URI") && !jo.isNull(string)) {
sb.append(string);
sb.append(": ");
sb.append(jo.getString(string));
diff --git a/src/org/json/HTTPTokener.java b/src/org/json/HTTPTokener.java
index 86fed61d7..8f6703520 100644
--- a/src/org/json/HTTPTokener.java
+++ b/src/org/json/HTTPTokener.java
@@ -58,7 +58,7 @@ public String nextToken() throws JSONException {
for (;;) {
c = next();
if (c < ' ') {
- throw syntaxError("Unterminated string.");
+// throw syntaxError("Unterminated string.");
}
if (c == q) {
return sb.toString();
diff --git a/src/org/json/JSON.java b/src/org/json/JSON.java
new file mode 100644
index 000000000..8ef651540
--- /dev/null
+++ b/src/org/json/JSON.java
@@ -0,0 +1,3616 @@
+package org.json;
+
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.StringWriter;
+import java.io.Writer;
+import java.lang.reflect.Array;
+import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+/**
+ * This is a "mashup" test for combining the two JSON types, the goal is to make
+ * it work similarly to how the processing XML library works.
+ *
+ * loadJSON(); should be able of returning both types of objects, and to do that
+ * without having the typecast you need to combine the two classes somehow.
+ *
+ * The way you use this is calling JSON.loadJSON("filename"); (or similar) and
+ * then the class will maintain the type of object it is (either array or
+ * object) and simply forward the requests the user does to the correct class...
+ * of course making sure that the type is of correct class! You shouldn't be
+ * able of calling ".get(index)" on an JSONObject for example... it should then
+ * notify the user by a simple text message to the console.
+ *
+ * This library started from the JSONObject and JSONArray classes by Douglas
+ * Crockford, since then it has been heavily modified and also includes changes
+ * from the JSONArray and JSONObject classes from Processing core.
+ *
+ * @author Andreas Goransson
+ *
+ */
+public class JSON {
+ /*
+ * Defines the type of object
+ */
+ protected enum JSONType {
+ OBJECT, ARRAY, NULL
+ };
+
+ protected JSONType type;
+
+ protected JSONObject obj;
+ protected JSONArray arr;
+
+ protected JSON(){
+ // Empty, used for inner classes
+ }
+
+ protected JSON(Object array){
+ this();
+ if (array.getClass().isArray()) {
+ int length = Array.getLength(array);
+ for (int i = 0; i < length; i += 1) {
+ arr.innerAppend(JSONObject.wrap(Array.get(array, i)));
+ }
+ } else {
+ // throw new JSONException(
+ // "JSONArray initial value should be a string or collection or array.");
+ System.out
+ .println("JSONArray initial value should be a string or collection or array.");
+ }
+ }
+
+ /**
+ * Constructor for JSONTokeners.
+ *
+ * @param tokener
+ */
+ protected JSON(JSONTokener tokener) {
+
+ char nextChar = tokener.nextClean();
+ tokener.back();
+
+ if (nextChar == '{') {
+ try {
+ obj = new JSONObject(tokener);
+ this.type = JSONType.OBJECT;
+ return;
+ } catch (Exception e) {
+ e.printStackTrace();
+ throw new RuntimeException("Failed to create JSONObject");
+ }
+ }else if (nextChar == '[') {
+ try {
+ arr = new JSONArray(tokener);
+ this.type = JSONType.ARRAY;
+ return;
+ } catch (Exception e) {
+ throw new RuntimeException("Failed to create JSONArray");
+ }
+ }else{
+ throw new RuntimeException("Text is not JSON formatted");
+ }
+ }
+
+ public JSONType getType(){
+ return type;
+ }
+
+ public JSON accumulate( String key, Object value ) {
+ if( type == JSONType.OBJECT ){
+ return obj.accumulate(key, value );
+ }else{
+ throw new RuntimeException("Not a JSONObject");
+ }
+ }
+
+ public JSON accumulate( Object value ) {
+ if( type == JSONType.ARRAY ){
+ return arr.accumulate( value );
+ }else{
+ throw new RuntimeException("Not a JSONArray");
+ }
+ }
+
+ protected Object opt(String key) {
+ if( type == JSONType.OBJECT ) {
+ return obj.innerOpt(key);
+ } else {
+ throw new RuntimeException("Not a JSONObject, perhaps you meant opt(int)?");
+ }
+ }
+
+ protected Object opt(int index) {
+ if( type == JSONType.ARRAY ) {
+ return arr.innerOpt(index);
+ } else {
+ throw new RuntimeException("Not a JSONArray, perhaps you meant opt(String)?");
+ }
+ }
+
+ public static JSON createObject(){
+ return new JSONObject();
+ }
+
+ public static JSON createArray(){
+ return new JSONArray();
+ }
+
+ /**
+ * Open a json file
+ *
+ * @param json filename
+ *
+ * @return JSON (array or object)
+ */
+ public static JSON load(String filename) {
+ InputStream input = null;
+ try {
+ input = new FileInputStream(filename);
+ } catch (FileNotFoundException e1) {
+ throw new RuntimeException("Failed to find file " + filename);
+ }
+
+ JSONTokener tokener = new JSONTokener(input);
+
+ char next = tokener.nextClean();
+ tokener.back();
+
+ if (next == '{' || next == '[') {
+ try {
+ return new JSON(tokener);
+ } catch (Exception e) {
+ throw new RuntimeException("Failed to create JSON");
+ }
+ }
+
+ throw new RuntimeException("File is not JSON formatted");
+ }
+
+ /**
+ * Parse a JSON string
+ *
+ * @param data json formatted string
+ *
+ * @return JSON (array or object)
+ */
+ public static JSON parse(String data){
+ JSONTokener tokener = new JSONTokener(data);
+
+ char next = tokener.nextClean();
+ tokener.back();
+
+ if (next == '{' || next == '[') {
+ try {
+ return new JSON(tokener);
+ } catch (Exception e) {
+ throw new RuntimeException("Failed to create JSON");
+ }
+ }
+
+ throw new RuntimeException("Text is not JSON formatted");
+ }
+
+ protected Object get(String key){
+ if( type == JSONType.OBJECT )
+ return obj.innerGet(key);
+ else
+ throw new RuntimeException("Not a JSONObject, try using get(int)");
+ }
+
+ protected Object get(int index){
+ if( type == JSONType.ARRAY )
+ return arr.get(index);
+ else
+ throw new RuntimeException("Not a JSONArray, try using get(String)");
+ }
+
+ protected JSON put(String key, Object value){
+ if( type == JSONType.OBJECT )
+ return obj.innerPut(key, value);
+ else
+ throw new RuntimeException("Not a JSONObject, try using get(int)");
+ }
+
+ public int length(){
+ if( type == JSONType.ARRAY ){
+ return arr.size();
+ }else if (type == JSONType.OBJECT){
+ return obj.size();
+ }else{
+ throw new RuntimeException("Not a JSON Type.");
+ }
+ }
+
+ // JSONObject methods
+
+ public Iterator keys() {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject.");
+ }else{
+ return obj.keys();
+ }
+ }
+
+ public String getString(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getString(int) instead.");
+ }else{
+ return obj.getInnerString(key);
+ }
+ }
+
+ public JSON setString(String key, String value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(String) instead.");
+ }else{
+ return obj.setInnerString(key, value);
+ }
+ }
+
+ public int getInt(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getInt(int) instead.");
+ }else{
+ return obj.getInnerInt(key);
+ }
+ }
+
+ public JSON setInt(String key, int value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(int) instead.");
+ }else{
+ return obj.setInnerInt(key, value);
+ }
+ }
+
+ public float getFloat(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getFloat(int) instead.");
+ }else{
+ return obj.getInnerFloat(key);
+ }
+ }
+
+ public JSON setFloat(String key, float value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(float) instead.");
+ }else{
+ return obj.setInnerFloat(key, value);
+ }
+ }
+
+ public double getDouble(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getDouble(int) instead.");
+ }else{
+ return obj.getInnerDouble(key);
+ }
+ }
+
+ public JSON setDouble(String key, double value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(double) instead.");
+ }else{
+ return obj.setInnerDouble(key, value);
+ }
+ }
+
+ public boolean getBoolean(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getBoolean(int) instead.");
+ }else{
+ return obj.getInnerBoolean(key);
+ }
+ }
+
+ public JSON setBoolean(String key, boolean value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(boolean) instead.");
+ }else{
+ return obj.setInnerBoolean(key, value);
+ }
+ }
+
+ public JSONObject getObject(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getObject(int) instead.");
+ }else{
+ return obj.getInnerJSONObject(key);
+ }
+ }
+
+ public JSON setObject(String key, JSONObject value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(JSONObject) instead.");
+ }else{
+ return obj.setInnerObject(key, value);
+ }
+ }
+
+ public JSONArray getArray(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getArray(int) instead.");
+ }else{
+ return obj.getInnerJSONArray(key);
+ }
+ }
+
+ public JSON setArray(String key, JSONArray value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(JSONArray) instead.");
+ }else{
+ return obj.setInnerArray(key, value);
+ }
+ }
+
+ public JSON getJSON(String key) {
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using getJSON(int) instead.");
+ }else{
+ return obj.getInnerJSON(key);
+ }
+ }
+
+ public JSON setJSON(String key, JSON value){
+ if( type != JSONType.OBJECT ){
+ throw new RuntimeException("Not a JSONObject, try using append(JSON) instead.");
+ }else{
+ return obj.setInnerJSON(key, value);
+ }
+ }
+
+ //JSONArray methods
+
+ public String getString(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getString(String) instead.");
+ }else{
+ return arr.getInnerString(index);
+ }
+ }
+
+ public JSON append(String value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setString(String, String) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ public int getInt(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getInt(String) instead.");
+ }else{
+ return arr.getInnerInt(index);
+ }
+ }
+
+ public JSON append(int value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setInt(String, int) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ public float getFloat(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getFloat(String) instead.");
+ }else{
+ return arr.getInnerFloat(index);
+ }
+ }
+
+ public JSON append(float value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setFloat(String, float) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ public double getDouble(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getDouble(String) instead.");
+ }else{
+ return arr.getInnerDouble(index);
+ }
+ }
+
+ public JSON append(double value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setDouble(String, double) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ public boolean getBoolean(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getBoolean(String) instead.");
+ }else{
+ return arr.getInnerBoolean(index);
+ }
+ }
+
+ public JSON append(boolean value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setBoolean(String, boolean) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ public JSONArray getArray(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getArray(String) instead.");
+ }else{
+ return arr.getInnerArray(index);
+ }
+ }
+
+ public JSON append(JSONArray value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setArray(String, JSONArray) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ public JSONObject getObject(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getObject(String) instead.");
+ }else{
+ return arr.getInnerObject(index);
+ }
+ }
+
+ public JSON append(JSONObject value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setObject(String, JSONObject) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ public JSON getJSON(int index){
+ if( type != JSONType.ARRAY ){
+ throw new RuntimeException("Not a JSONArray, try using getJSON(String) instead.");
+ }else{
+ return arr.getInnerJSON(index);
+ }
+ }
+
+ public JSON append(JSON value){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setJSON(String, JSON) instead.");
+ } else {
+ return arr.innerAppend(value);
+ }
+ }
+
+ protected JSON append(Object object){
+ if( type != JSONType.ARRAY){
+ throw new RuntimeException("Not a JSONArray, try using setJSON(String, JSON) instead.");
+ } else {
+ return arr.innerAppend(object);
+ }
+ }
+
+ @Override
+ public String toString() {
+ if( type == JSONType.OBJECT){
+ return obj.toString();
+ }else if (type == JSONType.ARRAY){
+ return arr.toString();
+ }else{
+ throw new RuntimeException("Not an acceptable JSON type.");
+ }
+ }
+
+ /**
+ * JSONObject.NULL is equivalent to the value that JavaScript calls null,
+ * whilst Java's null is equivalent to the value that JavaScript calls
+ * undefined.
+ */
+ private static final class Null extends JSON {
+
+ /**
+ * There is only intended to be a single instance of the NULL object, so
+ * the clone method returns itself.
+ *
+ * @return NULL.
+ */
+ @Override
+ protected final Object clone() {
+ return this;
+ }
+
+ /**
+ * A Null object is equal to the null value and to itself.
+ *
+ * @param object
+ * An object to test for nullness.
+ * @return true if the object parameter is the JSONObject.NULL object or
+ * null.
+ */
+ @Override
+ public boolean equals(Object object) {
+ return object == null || object == this;
+ }
+
+ /**
+ * Get the "null" string value.
+ *
+ * @return The string "null".
+ */
+ @Override
+ public String toString() {
+ return "null";
+ }
+
+ @Override
+ public int hashCode() {
+ // TODO Auto-generated method stub
+ return super.hashCode();
+ }
+ }
+
+ /**
+ * It is sometimes more convenient and less ambiguous to have a
+ * NULL object than to use Java's null value.
+ * JSONObject.NULL.equals(null) returns true.
+ * JSONObject.NULL.toString() returns "null".
+ */
+ public static final Object NULL = new Null();
+
+ /**
+ * 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();
+ *
+ * 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:
+ *
+ *
An extra , (comma) may appear just
+ * before the closing brace.
+ *
Strings may be quoted with ' (single
+ * quote).
+ *
Strings do not need to be quoted at all if they do not begin with a quote
+ * or single quote, and if they do not contain leading or trailing spaces, and
+ * if they do not contain any of these characters:
+ * { } [ ] / \ : , = ; # and if they do not look like numbers and
+ * if they are not the reserved words true, false, or
+ * null.
+ *
Keys can be followed by = or => as well as by
+ * :.
+ *
Values can be followed by ; (semicolon) as
+ * well as by , (comma).
+ *
+ *
+ * @author JSON.org
+ * @version 2012-12-01
+ */
+ static class JSONObject extends JSON {
+ /**
+ * The maximum number of keys in the key pool.
+ */
+ private static final int keyPoolSize = 100;
+
+ /**
+ * Key pooling is like string interning, but without permanently tying up
+ * memory. To help conserve memory, storage of duplicated key strings in
+ * JSONObjects will be avoided by using a key pool to manage unique key
+ * string objects. This is used by JSONObject.put(string, object).
+ */
+ static HashMap keyPool = new HashMap(keyPoolSize);
+
+
+ // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
+
+
+// /**
+// * JSONObject.NULL is equivalent to the value that JavaScript calls null,
+// * whilst Java's null is equivalent to the value that JavaScript calls
+// * undefined.
+// */
+// private static final class Null {
+//
+// /**
+// * There is only intended to be a single instance of the NULL object,
+// * so the clone method returns itself.
+// * @return NULL.
+// */
+// @Override
+// protected final Object clone() {
+// return this;
+// }
+//
+// /**
+// * A Null object is equal to the null value and to itself.
+// * @param object An object to test for nullness.
+// * @return true if the object parameter is the JSONObject.NULL object
+// * or null.
+// */
+// @Override
+// public boolean equals(Object object) {
+// return object == null || object == this;
+// }
+//
+// /**
+// * Get the "null" string value.
+// * @return The string "null".
+// */
+// @Override
+// public String toString() {
+// return "null";
+// }
+//
+// @Override
+// public int hashCode() {
+// // TODO Auto-generated method stub
+// return super.hashCode();
+// }
+// }
+
+
+ // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
+
+
+ /**
+ * The map where the JSONObject's properties are kept.
+ */
+ // private final Map map;
+ private final HashMap map;
+
+
+// /**
+// * It is sometimes more convenient and less ambiguous to have a
+// * NULL object than to use Java's null value.
+// * JSONObject.NULL.equals(null) returns true.
+// * JSONObject.NULL.toString() returns "null".
+// */
+// public static final Object NULL = new Null();
+
+
+ /**
+ * Construct an empty JSONObject.
+ */
+ public JSONObject() {
+ this.map = new HashMap();
+
+ this.type = JSONType.OBJECT;
+ obj = this;
+ }
+
+
+ // /**
+ // * Construct a JSONObject from a subset of another JSONObject.
+ // * An array of strings is used to identify the keys that should be copied.
+ // * Missing keys are ignored.
+ // * @param jo A JSONObject.
+ // * @param names An array of strings.
+ // * @throws JSONException
+ // * @exception JSONException If a value is a non-finite number or if a name is duplicated.
+ // */
+ // public JSONObject(JSONObject jo, String[] names) {
+// this();
+// for (int i = 0; i < names.length; i += 1) {
+// try {
+// this.putOnce(names[i], jo.opt(names[i]));
+// } catch (Exception ignore) {
+// }
+// }
+ // }
+
+
+ /**
+ * Construct a JSONObject from a JSONTokener.
+ * @param x A JSONTokener object containing the source string.
+ * @throws JSONException If there is a syntax error in the source string
+ * or a duplicated key.
+ */
+ protected JSONObject(JSONTokener x) {
+ this();
+ char c;
+ String key;
+
+ if (x.nextClean() != '{') {
+ throw new RuntimeException("A JSONObject text must begin with '{'");
+ }
+ for (;;) {
+ c = x.nextClean();
+ switch (c) {
+ case 0:
+ throw new RuntimeException("A JSONObject text must end with '}'");
+ case '}':
+ return;
+ default:
+ x.back();
+ key = x.nextValue().toString();
+ }
+
+ // The key is followed by ':'. We will also tolerate '=' or '=>'.
+
+ c = x.nextClean();
+ if (c == '=') {
+ if (x.next() != '>') {
+ x.back();
+ }
+ } else if (c != ':') {
+ throw new RuntimeException("Expected a ':' after a key");
+ }
+ this.putOnce(key, x.nextValue());
+
+ // Pairs are separated by ','. We will also tolerate ';'.
+ switch (x.nextClean()) {
+ case ';':
+ case ',':
+ if (x.nextClean() == '}') {
+ return;
+ }
+ x.back();
+ break;
+ case '}':
+ return;
+ default:
+ throw new RuntimeException("Expected a ',' or '}'");
+ }
+ }
+ }
+
+
+ /**
+ * Construct a JSONObject from a Map.
+ *
+ * @param map A map object that can be used to initialize the contents of
+ * the JSONObject.
+ * @throws JSONException
+ */
+ protected JSONObject(HashMap map) {
+ this.map = new HashMap();
+ if (map != null) {
+ Iterator i = map.entrySet().iterator();
+ while (i.hasNext()) {
+ Map.Entry e = (Map.Entry) i.next();
+ Object value = e.getValue();
+ if (value != null) {
+ map.put((String) e.getKey(), wrap(value));
+ }
+ }
+ }
+ }
+
+
+ /**
+ * Construct a JSONObject from an Object using bean getters.
+ * It reflects on all of the public methods of the object.
+ * For each of the methods with no parameters and a name starting
+ * with "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".
+ *
+ * @param bean An object that has getter methods that should be used
+ * to make a JSONObject.
+ */
+ protected JSONObject(Object bean) {
+ this();
+ this.populateMap(bean);
+ }
+
+
+ // holding off on this method until we decide on how to handle reflection
+ // /**
+ // * Construct a JSONObject from an Object, using reflection to find the
+ // * public members. The resulting JSONObject's keys will be the strings
+ // * from the names array, and the values will be the field values associated
+ // * with those keys in the object. If a key is not found or not visible,
+ // * then it will not be copied into the new JSONObject.
+ // * @param object An object that has fields that should be used to make a
+ // * JSONObject.
+ // * @param names An array of strings, the names of the fields to be obtained
+ // * from the object.
+ // */
+ // public JSONObject(Object object, String names[]) {
+// this();
+// Class c = object.getClass();
+// for (int i = 0; i < names.length; i += 1) {
+// String name = names[i];
+// try {
+// this.putOpt(name, c.getField(name).get(object));
+// } catch (Exception ignore) {
+// }
+// }
+ // }
+
+
+ /**
+ * Construct a JSONObject from a source JSON text string.
+ * This is the most commonly used JSONObject constructor.
+ * @param source A string beginning
+ * with { (left brace) and ending
+ * with } (right brace).
+ * @exception JSONException If there is a syntax error in the source
+ * string or a duplicated key.
+ */
+ static public JSONObject parse(String source) {
+ return new JSONObject(new JSONTokener(source));
+ }
+
+
+ // /**
+ // * Construct a JSONObject from a ResourceBundle.
+ // * @param baseName The ResourceBundle base name.
+ // * @param locale The Locale to load the ResourceBundle for.
+ // * @throws JSONException If any JSONExceptions are detected.
+ // */
+ // public JSON(String baseName, Locale locale) {
+// this();
+// ResourceBundle bundle = ResourceBundle.getBundle(baseName, locale,
+// Thread.currentThread().getContextClassLoader());
+ //
+// // Iterate through the keys in the bundle.
+ //
+// Enumeration keys = bundle.getKeys();
+// while (keys.hasMoreElements()) {
+// Object key = keys.nextElement();
+// if (key instanceof String) {
+ //
+// // Go through the path, ensuring that there is a nested JSONObject for each
+// // segment except the last. Add the value using the last segment's name into
+// // the deepest nested JSONObject.
+ //
+// String[] path = ((String)key).split("\\.");
+// int last = path.length - 1;
+// JSON target = this;
+// for (int i = 0; i < last; i += 1) {
+// String segment = path[i];
+// JSON nextTarget = target.optJSONObject(segment);
+// if (nextTarget == null) {
+// nextTarget = new JSON();
+// target.put(segment, nextTarget);
+// }
+// target = nextTarget;
+// }
+// target.put(path[last], bundle.getString((String)key));
+// }
+// }
+ // }
+
+
+ /**
+ * Accumulate values under a key. It is similar to the put method except
+ * that if there is already an object stored under the key then a
+ * JSONArray is stored under the key to hold all of the accumulated values.
+ * If there is already a JSONArray, then the new value is appended to it.
+ * In contrast, the put method replaces the previous value.
+ *
+ * If only one value is accumulated that is not a JSONArray, then the
+ * result will be the same as using put. But if multiple values are
+ * accumulated, then the result will be like append.
+ * @param key A key string.
+ * @param value An object to be accumulated under the key.
+ * @return this.
+ * @throws JSONException If the value is an invalid number
+ * or if the key is null.
+ */
+ public JSON/*Object*/ accumulate( String key, Object value ) /*throws JSONException*/ {
+ testValidity(value);
+ Object object = this.opt(key);
+ if (object == null) {
+ this.put(key, value instanceof JSONArray ? new JSONArray().innerAppend/*put*/(value) : value);
+ } else if (object instanceof JSONArray) {
+ ((JSONArray)object).innerAppend/*put*/(value);
+ } else {
+ this.put(key, new JSONArray().innerAppend/*put*/(object).innerAppend/*put*/(value));
+ }
+ return this;
+ }
+
+
+ // /**
+ // * Append values to the array under a key. If the key does not exist in the
+ // * JSONObject, then the key is put in the JSONObject with its value being a
+ // * JSONArray containing the value parameter. If the key was already
+ // * associated with a JSONArray, then the value parameter is appended to it.
+ // * @param key A key string.
+ // * @param value An object to be accumulated under the key.
+ // * @return this.
+ // * @throws JSONException If the key is null or if the current value
+ // * associated with the key is not a JSONArray.
+ // */
+ // public JSONObject append(String key, Object value) throws JSONException {
+// testValidity(value);
+// Object object = this.opt(key);
+// if (object == null) {
+// this.put(key, new JSONArray().put(value));
+// } else if (object instanceof JSONArray) {
+// this.put(key, ((JSONArray)object).put(value));
+// } else {
+// throw new JSONException("JSONObject[" + key +
+// "] is not a JSONArray.");
+// }
+// return this;
+ // }
+
+
+ /**
+ * Produce a string from a double. The string "null" will be returned if
+ * the number is not finite.
+ * @param d A double.
+ * @return A String.
+ */
+ static protected String doubleToString(double d) {
+ if (Double.isInfinite(d) || Double.isNaN(d)) {
+ return "null";
+ }
+
+ // Shave off trailing zeros and decimal point, if possible.
+
+ String string = Double.toString(d);
+ if (string.indexOf('.') > 0 && string.indexOf('e') < 0 &&
+ string.indexOf('E') < 0) {
+ while (string.endsWith("0")) {
+ string = string.substring(0, string.length() - 1);
+ }
+ if (string.endsWith(".")) {
+ string = string.substring(0, string.length() - 1);
+ }
+ }
+ return string;
+ }
+
+
+ /**
+ * Get the value object associated with a key.
+ *
+ * @param key A key string.
+ * @return The object associated with the key.
+ * @throws JSONException if the key is not found.
+ */
+ private Object innerGet(String key) {
+ if (key == null) {
+ throw new RuntimeException("Null key.");
+ }
+ Object object = this.innerOpt(key);
+ if (object == null) {
+ throw new RuntimeException("JSONObject[" + quote(key) + "] not found.");
+ }
+ return object;
+ }
+
+
+ /**
+ * Get the string associated with a key.
+ *
+ * @param key A key string.
+ * @return A string which is the value.
+ * @throws JSONException if there is no string value for the key.
+ */
+ public String getInnerString(String key) {
+ Object object = this.innerGet(key);
+ if (object instanceof String) {
+ return (String)object;
+ }
+ throw new RuntimeException("JSONObject[" + quote(key) + "] not a string.");
+ }
+
+
+ /**
+ * Get the int value associated with a key.
+ *
+ * @param key A key string.
+ * @return The integer value.
+ * @throws JSONException if the key is not found or if the value cannot
+ * be converted to an integer.
+ */
+ public int getInnerInt(String key) {
+ Object object = this.innerGet(key);
+ try {
+ return object instanceof Number
+ ? ((Number)object).intValue()
+ : Integer.parseInt((String)object);
+ } catch (Exception e) {
+ throw new RuntimeException("JSONObject[" + quote(key) + "] is not an int.");
+ }
+ }
+
+
+ /**
+ * Get the long value associated with a key.
+ *
+ * @param key A key string.
+ * @return The long value.
+ * @throws JSONException if the key is not found or if the value cannot
+ * be converted to a long.
+ */
+ public long getInnerLong(String key) {
+ Object object = this.innerGet(key);
+ try {
+ return object instanceof Number
+ ? ((Number)object).longValue()
+ : Long.parseLong((String)object);
+ } catch (Exception e) {
+ throw new RuntimeException("JSONObject[" + quote(key) + "] is not a long.", e);
+ }
+ }
+
+
+ public float getInnerFloat(String key) {
+ return (float) getInnerDouble(key);
+ }
+
+
+ /**
+ * Get the double value associated with a key.
+ * @param key A key string.
+ * @return The numeric value.
+ * @throws JSONException if the key is not found or
+ * if the value is not a Number object and cannot be converted to a number.
+ */
+ public double getInnerDouble(String key) {
+ Object object = this.innerGet(key);
+ try {
+ return object instanceof Number
+ ? ((Number)object).doubleValue()
+ : Double.parseDouble((String)object);
+ } catch (Exception e) {
+ throw new RuntimeException("JSONObject[" + quote(key) + "] is not a number.");
+ }
+ }
+
+
+ /**
+ * Get the boolean value associated with a key.
+ *
+ * @param key A key string.
+ * @return The truth.
+ * @throws JSONException
+ * if the value is not a Boolean or the String "true" or "false".
+ */
+ public boolean getInnerBoolean(String key) {
+ Object object = this.innerGet(key);
+ if (object.equals(Boolean.FALSE) ||
+ (object instanceof String &&
+ ((String)object).equalsIgnoreCase("false"))) {
+ return false;
+ } else if (object.equals(Boolean.TRUE) ||
+ (object instanceof String &&
+ ((String)object).equalsIgnoreCase("true"))) {
+ return true;
+ }
+ throw new RuntimeException("JSONObject[" + quote(key) + "] is not a Boolean.");
+ }
+
+
+ /**
+ * Get the JSONArray value associated with a key.
+ *
+ * @param key A key string.
+ * @return A JSONArray which is the value.
+ * @throws JSONException if the key is not found or
+ * if the value is not a JSONArray.
+ */
+ public JSONArray getInnerJSONArray(String key) {
+ Object object = this.innerGet(key);
+ if (object instanceof JSONArray) {
+ return (JSONArray)object;
+ }
+ throw new RuntimeException("JSONObject[" + quote(key) + "] is not a JSONArray.");
+ }
+
+
+ /**
+ * Get the JSONObject value associated with a key.
+ *
+ * @param key A key string.
+ * @return A JSONObject which is the value.
+ * @throws JSONException if the key is not found or
+ * if the value is not a JSONObject.
+ */
+ public JSONObject getInnerJSONObject(String key) {
+ Object object = this.innerGet(key);
+ if (object instanceof JSONObject) {
+ return (JSONObject)object;
+ }
+ throw new RuntimeException("JSONObject[" + quote(key) + "] is not a JSONObject.");
+ }
+
+
+ public JSON getInnerJSON(String key) {
+ Object object = this.innerGet(key);
+ if (object instanceof JSON) {
+ return (JSON)object;
+ }
+ throw new RuntimeException("JSONObject[" + quote(key) + "] is not a JSONObject.");
+ }
+
+ // /**
+ // * Get an array of field names from a JSONObject.
+ // *
+ // * @return An array of field names, or null if there are no names.
+ // */
+ // public static String[] getNames(JSONObject jo) {
+// int length = jo.length();
+// if (length == 0) {
+// return null;
+// }
+// Iterator iterator = jo.keys();
+// String[] names = new String[length];
+// int i = 0;
+// while (iterator.hasNext()) {
+// names[i] = (String)iterator.next();
+// i += 1;
+// }
+// return names;
+ // }
+ //
+ //
+ // /**
+ // * Get an array of field names from an Object.
+ // *
+ // * @return An array of field names, or null if there are no names.
+ // */
+ // public static String[] getNames(Object object) {
+// if (object == null) {
+// return null;
+// }
+// Class klass = object.getClass();
+// Field[] fields = klass.getFields();
+// int length = fields.length;
+// if (length == 0) {
+// return null;
+// }
+// String[] names = new String[length];
+// for (int i = 0; i < length; i += 1) {
+// names[i] = fields[i].getName();
+// }
+// return names;
+ // }
+
+
+ /**
+ * Determine if the JSONObject contains a specific key.
+ * @param key A key string.
+ * @return true if the key exists in the JSONObject.
+ */
+ public boolean hasKey(String key) {
+ return this.map.containsKey(key);
+ }
+
+
+ // /**
+ // * Increment a property of a JSONObject. If there is no such property,
+ // * create one with a value of 1. If there is such a property, and if
+ // * it is an Integer, Long, Double, or Float, then add one to it.
+ // * @param key A key string.
+ // * @return this.
+ // * @throws JSONException If there is already a property with this name
+ // * that is not an Integer, Long, Double, or Float.
+ // */
+ // public JSON increment(String key) {
+// Object value = this.opt(key);
+// if (value == null) {
+// this.put(key, 1);
+// } else if (value instanceof Integer) {
+// this.put(key, ((Integer)value).intValue() + 1);
+// } else if (value instanceof Long) {
+// this.put(key, ((Long)value).longValue() + 1);
+// } else if (value instanceof Double) {
+// this.put(key, ((Double)value).doubleValue() + 1);
+// } else if (value instanceof Float) {
+// this.put(key, ((Float)value).floatValue() + 1);
+// } else {
+// throw new RuntimeException("Unable to increment [" + quote(key) + "].");
+// }
+// return this;
+ // }
+
+
+ /**
+ * Determine if the value associated with the key is null or if there is
+ * no value.
+ * @param key A key string.
+ * @return true if there is no value associated with the key or if
+ * the value is the JSONObject.NULL object.
+ */
+ protected boolean isNull(String key) {
+ return /*JSONObject.*/NULL.equals(this.innerOpt(key));
+ }
+
+
+ /**
+ * Get an enumeration of the keys of the JSONObject.
+ *
+ * @return An iterator of the keys.
+ */
+ public Iterator keys() {
+// return this.keySet().iterator();
+ return map.keySet().iterator();
+ }
+
+
+ // /**
+ // * Get a set of keys of the JSONObject.
+ // *
+ // * @return A keySet.
+ // */
+ // public Set keySet() {
+// return this.map.keySet();
+ // }
+
+
+ /**
+ * Get the number of keys stored in the JSONObject.
+ *
+ * @return The number of keys in the JSONObject.
+ */
+ public int size() {
+ return this.map.size();
+ }
+
+
+ // /**
+ // * Produce a JSONArray containing the names of the elements of this
+ // * JSONObject.
+ // * @return A JSONArray containing the key strings, or null if the JSONObject
+ // * is empty.
+ // */
+ // public JSONArray names() {
+// JSONArray ja = new JSONArray();
+// Iterator keys = this.keys();
+// while (keys.hasNext()) {
+// ja.append(keys.next());
+// }
+// return ja.size() == 0 ? null : ja;
+ // }
+
+
+ /**
+ * Produce a string from a Number.
+ * @param number A Number
+ * @return A String.
+ * @throws JSONException If n is a non-finite number.
+ */
+ private static String numberToString(Number number) {
+ if (number == null) {
+ throw new RuntimeException("Null pointer");
+ }
+ testValidity(number);
+
+ // Shave off trailing zeros and decimal point, if possible.
+
+ String string = number.toString();
+ if (string.indexOf('.') > 0 && string.indexOf('e') < 0 &&
+ string.indexOf('E') < 0) {
+ while (string.endsWith("0")) {
+ string = string.substring(0, string.length() - 1);
+ }
+ if (string.endsWith(".")) {
+ string = string.substring(0, string.length() - 1);
+ }
+ }
+ return string;
+ }
+
+
+ /**
+ * Get an optional value associated with a key.
+ * @param key A key string.
+ * @return An object which is the value, or null if there is no value.
+ */
+ private Object innerOpt(String key) {
+ return key == null ? null : this.map.get(key);
+ }
+
+
+ // /**
+ // * Get an optional boolean associated with a key.
+ // * It returns false if there is no such key, or if the value is not
+ // * Boolean.TRUE or the String "true".
+ // *
+ // * @param key A key string.
+ // * @return The truth.
+ // */
+ // private boolean optBoolean(String key) {
+// return this.optBoolean(key, false);
+ // }
+
+
+ // /**
+ // * Get an optional boolean associated with a key.
+ // * It returns the defaultValue if there is no such key, or if it is not
+ // * a Boolean or the String "true" or "false" (case insensitive).
+ // *
+ // * @param key A key string.
+ // * @param defaultValue The default.
+ // * @return The truth.
+ // */
+ // private boolean optBoolean(String key, boolean defaultValue) {
+// try {
+// return this.getBoolean(key);
+// } catch (Exception e) {
+// return defaultValue;
+// }
+ // }
+
+
+ // /**
+ // * Get an optional double associated with a key,
+ // * or NaN if there is no such key or if its value is not a number.
+ // * If the value is a string, an attempt will be made to evaluate it as
+ // * a number.
+ // *
+ // * @param key A string which is the key.
+ // * @return An object which is the value.
+ // */
+ // private double optDouble(String key) {
+// return this.optDouble(key, Double.NaN);
+ // }
+
+
+ // /**
+ // * 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.
+ // * If the value is a string, an attempt will be made to evaluate it as
+ // * a number.
+ // *
+ // * @param key A key string.
+ // * @param defaultValue The default.
+ // * @return An object which is the value.
+ // */
+ // private double optDouble(String key, double defaultValue) {
+// try {
+// return this.getDouble(key);
+// } catch (Exception e) {
+// return defaultValue;
+// }
+ // }
+
+
+ // /**
+ // * 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.
+ // * If the value is a string, an attempt will be made to evaluate it as
+ // * a number.
+ // *
+ // * @param key A key string.
+ // * @return An object which is the value.
+ // */
+ // private int optInt(String key) {
+// return this.optInt(key, 0);
+ // }
+
+
+ // /**
+ // * 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.
+ // * If the value is a string, an attempt will be made to evaluate it as
+ // * a number.
+ // *
+ // * @param key A key string.
+ // * @param defaultValue The default.
+ // * @return An object which is the value.
+ // */
+ // private int optInt(String key, int defaultValue) {
+// try {
+// return this.getInt(key);
+// } catch (Exception e) {
+// return defaultValue;
+// }
+ // }
+
+
+ // /**
+ // * Get an optional JSONArray associated with a key.
+ // * It returns null if there is no such key, or if its value is not a
+ // * JSONArray.
+ // *
+ // * @param key A key string.
+ // * @return A JSONArray which is the value.
+ // */
+ // private JSONArray optJSONArray(String key) {
+// Object o = this.opt(key);
+// return o instanceof JSONArray ? (JSONArray)o : null;
+ // }
+
+
+ // /**
+ // * Get an optional JSONObject associated with a key.
+ // * It returns null if there is no such key, or if its value is not a
+ // * JSONObject.
+ // *
+ // * @param key A key string.
+ // * @return A JSONObject which is the value.
+ // */
+ // private JSONObject optJSONObject(String key) {
+// Object object = this.opt(key);
+// return object instanceof JSONObject ? (JSONObject)object : null;
+ // }
+
+
+ // /**
+ // * 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.
+ // * If the value is a string, an attempt will be made to evaluate it as
+ // * a number.
+ // *
+ // * @param key A key string.
+ // * @return An object which is the value.
+ // */
+ // public long optLong(String key) {
+// return this.optLong(key, 0);
+ // }
+
+
+ // /**
+ // * 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.
+ // * If the value is a string, an attempt will be made to evaluate it as
+ // * a number.
+ // *
+ // * @param key A key string.
+ // * @param defaultValue The default.
+ // * @return An object which is the value.
+ // */
+ // public long optLong(String key, long defaultValue) {
+// try {
+// return this.getLong(key);
+// } catch (Exception e) {
+// return defaultValue;
+// }
+ // }
+
+
+ // /**
+ // * Get an optional string associated with a key.
+ // * It returns an empty string if there is no such key. If the value is not
+ // * a string and is not null, then it is converted to a string.
+ // *
+ // * @param key A key string.
+ // * @return A string which is the value.
+ // */
+ // public String optString(String key) {
+// return this.optString(key, "");
+ // }
+
+
+ // /**
+ // * Get an optional string associated with a key.
+ // * It returns the defaultValue if there is no such key.
+ // *
+ // * @param key A key string.
+ // * @param defaultValue The default.
+ // * @return A string which is the value.
+ // */
+ // public String optString(String key, String defaultValue) {
+// Object object = this.opt(key);
+// return NULL.equals(object) ? defaultValue : object.toString();
+ // }
+
+
+ private void populateMap(Object bean) {
+ Class klass = bean.getClass();
+
+ // If klass is a System class then set includeSuperClass to false.
+
+ boolean includeSuperClass = klass.getClassLoader() != null;
+
+ Method[] methods = includeSuperClass
+ ? klass.getMethods()
+ : klass.getDeclaredMethods();
+ for (int i = 0; i < methods.length; i += 1) {
+ try {
+ Method method = methods[i];
+ if (Modifier.isPublic(method.getModifiers())) {
+ String name = method.getName();
+ String key = "";
+ if (name.startsWith("get")) {
+ if ("getClass".equals(name) ||
+ "getDeclaringClass".equals(name)) {
+ key = "";
+ } else {
+ key = name.substring(3);
+ }
+ } else if (name.startsWith("is")) {
+ key = name.substring(2);
+ }
+ if (key.length() > 0 &&
+ Character.isUpperCase(key.charAt(0)) &&
+ method.getParameterTypes().length == 0) {
+ if (key.length() == 1) {
+ key = key.toLowerCase();
+ } else if (!Character.isUpperCase(key.charAt(1))) {
+ key = key.substring(0, 1).toLowerCase() +
+ key.substring(1);
+ }
+
+ Object result = method.invoke(bean, (Object[])null);
+ if (result != null) {
+ this.map.put(key, wrap(result));
+ }
+ }
+ }
+ } catch (Exception ignore) {
+ }
+ }
+ }
+
+
+ public JSONObject setInnerString(String key, String value) {
+ return innerPut(key, value);
+ }
+
+
+ /**
+ * Put a key/int pair in the JSONObject.
+ *
+ * @param key A key string.
+ * @param value An int which is the value.
+ * @return this.
+ * @throws JSONException If the key is null.
+ */
+ public JSONObject setInnerInt(String key, int value) {
+ this.innerPut(key, new Integer(value));
+ return this;
+ }
+
+
+ /**
+ * Put a key/long pair in the JSONObject.
+ *
+ * @param key A key string.
+ * @param value A long which is the value.
+ * @return this.
+ * @throws JSONException If the key is null.
+ */
+ public JSONObject setInnerLong(String key, long value) {
+ this.innerPut(key, new Long(value));
+ return this;
+ }
+
+
+ public JSONObject setInnerFloat(String key, float value) {
+ this.innerPut(key, new Double(value));
+ return this;
+ }
+
+
+ /**
+ * Put a key/double pair in the JSONObject.
+ *
+ * @param key A key string.
+ * @param value A double which is the value.
+ * @return this.
+ * @throws JSONException If the key is null or if the number is invalid.
+ */
+ public JSONObject setInnerDouble(String key, double value) {
+ this.innerPut(key, new Double(value));
+ return this;
+ }
+
+
+ /**
+ * Put a key/boolean pair in the JSONObject.
+ *
+ * @param key A key string.
+ * @param value A boolean which is the value.
+ * @return this.
+ * @throws JSONException If the key is null.
+ */
+ public JSONObject setInnerBoolean(String key, boolean value) {
+ this.innerPut(key, value ? Boolean.TRUE : Boolean.FALSE);
+ return this;
+ }
+
+
+ public JSONObject setInnerObject(String key, JSONObject/*String*/ value) {
+ return innerPut(key, value);
+ }
+
+
+ public JSONObject setInnerArray(String key, JSONArray/*String*/ value) {
+ return innerPut(key, value);
+ }
+
+
+ public JSON setInnerJSON(String key, JSON value) {
+ return innerPut(key, value);
+ }
+
+ // /**
+ // * Put a key/value pair in the JSONObject, where the value will be a
+ // * JSONArray which is produced from a Collection.
+ // * @param key A key string.
+ // * @param value A Collection value.
+ // * @return this.
+ // * @throws JSONException
+ // */
+ // public JSONObject put(String key, Collection value) {
+// this.put(key, new JSONArray(value));
+// return this;
+ // }
+
+
+ // /**
+ // * Put a key/value pair in the JSONObject, where the value will be a
+ // * JSONObject which is produced from a Map.
+ // * @param key A key string.
+ // * @param value A Map value.
+ // * @return this.
+ // * @throws JSONException
+ // */
+ // //public JSONObject put(String key, HashMap value) {
+ // public JSONObject put(String key, Map value) {
+// this.put(key, new JSONObject(value));
+// return this;
+ // }
+
+
+ /**
+ * Put a key/value pair in the JSONObject. If the value is null,
+ * then the key will be removed from the JSONObject if it is present.
+ * @param key A key string.
+ * @param 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.
+ * @return this.
+ * @throws JSONException If the value is non-finite number
+ * or if the key is null.
+ */
+ private JSONObject innerPut(String key, Object value) {
+ String pooled;
+ if (key == null) {
+ throw new RuntimeException("Null key.");
+ }
+ if (value != null) {
+ testValidity(value);
+ pooled = (String)keyPool.get(key);
+ if (pooled == null) {
+ if (keyPool.size() >= keyPoolSize) {
+ keyPool = new HashMap(keyPoolSize);
+ }
+ keyPool.put(key, key);
+ } else {
+ key = pooled;
+ }
+ this.map.put(key, value);
+ } else {
+ this.remove(key);
+ }
+ return this;
+ }
+
+
+ /**
+ * 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.
+ * @param key
+ * @param value
+ * @return his.
+ * @throws JSONException if the key is a duplicate
+ */
+ private JSONObject putOnce(String key, Object value) {
+ if (key != null && value != null) {
+ if (this.innerOpt(key) != null) {
+ throw new RuntimeException("Duplicate key \"" + key + "\"");
+ }
+ this.innerPut(key, value);
+ }
+ return this;
+ }
+
+
+ // /**
+ // * Put a key/value pair in the JSONObject, but only if the
+ // * key and the value are both non-null.
+ // * @param key A key string.
+ // * @param 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.
+ // * @return this.
+ // * @throws JSONException If the value is a non-finite number.
+ // */
+ // public JSONObject putOpt(String key, Object value) {
+// if (key != null && value != null) {
+// this.put(key, value);
+// }
+// return this;
+ // }
+
+
+ /**
+ * Produce a string in double quotes with backslash sequences in all the
+ * right places. A backslash will be inserted within = '\u0080' && c < '\u00a0')
+ || (c >= '\u2000' && c < '\u2100')) {
+ w.write("\\u");
+ hhhh = Integer.toHexString(c);
+ w.write("0000", 0, 4 - hhhh.length());
+ w.write(hhhh);
+ } else {
+ w.write(c);
+ }
+ }
+ }
+ w.write('"');
+ return w;
+ }
+
+
+ /**
+ * Remove a name and its value, if present.
+ * @param key The name to be removed.
+ * @return The value that was associated with the name,
+ * or null if there was no value.
+ */
+ public Object remove(String key) {
+ return this.map.remove(key);
+ }
+
+
+ /**
+ * Try to convert a string into a number, boolean, or null. If the string
+ * can't be converted, return the string.
+ * @param string A String.
+ * @return A simple JSON value.
+ */
+ static protected Object stringToValue(String string) {
+ Double d;
+ if (string.equals("")) {
+ return string;
+ }
+ if (string.equalsIgnoreCase("true")) {
+ return Boolean.TRUE;
+ }
+ if (string.equalsIgnoreCase("false")) {
+ return Boolean.FALSE;
+ }
+ if (string.equalsIgnoreCase("null")) {
+ return /*JSONObject.*/NULL;
+ }
+
+ /*
+ * If it might be a number, try converting it.
+ * If a number cannot be produced, then the value will just
+ * be a string. Note that the plus and implied string
+ * conventions are non-standard. A JSON parser may accept
+ * non-JSON forms as long as it accepts all correct JSON forms.
+ */
+
+ char b = string.charAt(0);
+ if ((b >= '0' && b <= '9') || b == '.' || b == '-' || b == '+') {
+ try {
+ if (string.indexOf('.') > -1 ||
+ string.indexOf('e') > -1 || string.indexOf('E') > -1) {
+ d = Double.valueOf(string);
+ if (!d.isInfinite() && !d.isNaN()) {
+ return d;
+ }
+ } else {
+ Long myLong = new Long(string);
+ if (myLong.longValue() == myLong.intValue()) {
+ return new Integer(myLong.intValue());
+ } else {
+ return myLong;
+ }
+ }
+ } catch (Exception ignore) {
+ }
+ }
+ return string;
+ }
+
+
+ /**
+ * Throw an exception if the object is a NaN or infinite number.
+ * @param o The object to test.
+ * @throws JSONException If o is a non-finite number.
+ */
+ static protected void testValidity(Object o) {
+ if (o != null) {
+ if (o instanceof Double) {
+ if (((Double)o).isInfinite() || ((Double)o).isNaN()) {
+ throw new RuntimeException(
+ "JSON does not allow non-finite numbers.");
+ }
+ } else if (o instanceof Float) {
+ if (((Float)o).isInfinite() || ((Float)o).isNaN()) {
+ throw new RuntimeException(
+ "JSON does not allow non-finite numbers.");
+ }
+ }
+ }
+ }
+
+
+ // /**
+ // * Produce a JSONArray containing the values of the members of this
+ // * JSONObject.
+ // * @param names A JSONArray containing a list of key strings. This
+ // * determines the sequence of the values in the result.
+ // * @return A JSONArray of values.
+ // * @throws JSONException If any of the values are non-finite numbers.
+ // */
+ // public JSONArray toJSONArray(JSONArray names) {
+// if (names == null || names.size() == 0) {
+// return null;
+// }
+// JSONArray ja = new JSONArray();
+// for (int i = 0; i < names.size(); i += 1) {
+// ja.append(this.opt(names.getString(i)));
+// }
+// return ja;
+ // }
+
+
+ /**
+ * Return the JSON data formatted with two spaces for indents.
+ * Chosen to do this since it's the most common case (e.g. with println()).
+ * Same as format(2). Use the format() function for more options.
+ */
+ @Override
+ public String toString() {
+ try {
+ return format(2);
+ } catch (Exception e) {
+ return null;
+ }
+ }
+
+
+ /**
+ * Make a prettyprinted JSON text of this JSONObject.
+ *
+ * Warning: This method assumes that the data structure is acyclical.
+ * @param indentFactor The number of spaces to add to each level of
+ * indentation.
+ * @return a printable, displayable, portable, transmittable
+ * representation of the object, beginning
+ * with { (left brace) and ending
+ * with } (right brace).
+ * @throws JSONException If the object contains an invalid number.
+ */
+ public String format(int indentFactor) {
+ StringWriter w = new StringWriter();
+ synchronized (w.getBuffer()) {
+ return this.write(w, indentFactor, 0).toString();
+ }
+ }
+
+ /**
+ * Make a JSON text of an Object value. If the object has an
+ * value.toJSONString() method, then that method will be used to produce
+ * the JSON text. The method is required to produce a strictly
+ * conforming text. If the object does not contain a toJSONString
+ * method (which is the most common case), then a text will be
+ * produced by other means. If the value is an array or Collection,
+ * then a JSONArray will be made from it and its toJSONString method
+ * will be called. If the value is a MAP, then a JSONObject will be made
+ * from it and its toJSONString method will be called. Otherwise, the
+ * value's toString method will be called, and the result will be quoted.
+ *
+ *
+ * Warning: This method assumes that the data structure is acyclical.
+ * @param value The value to be serialized.
+ * @return a printable, displayable, transmittable
+ * representation of the object, beginning
+ * with { (left brace) and ending
+ * with } (right brace).
+ * @throws JSONException If the value is or contains an invalid number.
+ */
+ static protected String valueToString(Object value) {
+ if (value == null || value.equals(null)) {
+ return "null";
+ }
+// if (value instanceof JSONString) {
+// Object object;
+// try {
+// object = ((JSONString)value).toJSONString();
+// } catch (Exception e) {
+// throw new RuntimeException(e);
+// }
+// if (object instanceof String) {
+// return (String)object;
+// }
+// throw new RuntimeException("Bad value from toJSONString: " + object);
+// }
+ if (value instanceof Number) {
+ return numberToString((Number) value);
+ }
+ if (value instanceof Boolean || value instanceof JSONObject ||
+ value instanceof JSONArray) {
+ return value.toString();
+ }
+ if (value instanceof Map) {
+ return new JSONObject((Map)value).toString();
+ }
+ if (value instanceof Collection) {
+ return new JSONArray((Collection)value).toString();
+ }
+ if (value.getClass().isArray()) {
+ return new JSONArray(value).toString();
+ }
+ return quote(value.toString());
+ }
+
+ /**
+ * Wrap an object, if necessary. If the object is null, return the NULL
+ * object. If it is an array or collection, wrap it in a JSONArray. If
+ * it is a map, wrap it in a JSONObject. If it is a standard property
+ * (Double, String, et al) then it is already wrapped. Otherwise, if it
+ * comes from one of the java packages, turn it into a string. And if
+ * it doesn't, try to wrap it in a JSONObject. If the wrapping fails,
+ * then null is returned.
+ *
+ * @param object The object to wrap
+ * @return The wrapped value
+ */
+ static protected Object wrap(Object object) {
+ try {
+ if (object == null) {
+ return NULL;
+ }
+ if (object instanceof JSONObject || object instanceof JSONArray ||
+ NULL.equals(object) || /*object instanceof JSONString ||*/
+ object instanceof Byte || object instanceof Character ||
+ object instanceof Short || object instanceof Integer ||
+ object instanceof Long || object instanceof Boolean ||
+ object instanceof Float || object instanceof Double ||
+ object instanceof String) {
+ return object;
+ }
+
+ if (object instanceof Collection) {
+ return new JSONArray((Collection)object);
+ }
+ if (object.getClass().isArray()) {
+ return new JSONArray(object);
+ }
+ if (object instanceof Map) {
+ return new JSONObject((Map)object);
+ }
+ Package objectPackage = object.getClass().getPackage();
+ String objectPackageName = objectPackage != null
+ ? objectPackage.getName()
+ : "";
+ if (
+ objectPackageName.startsWith("java.") ||
+ objectPackageName.startsWith("javax.") ||
+ object.getClass().getClassLoader() == null
+ ) {
+ return object.toString();
+ }
+ return new JSONObject(object);
+ } catch(Exception exception) {
+ return null;
+ }
+ }
+
+
+ /**
+ * Write the contents of the JSONObject as JSON text to a writer.
+ * For compactness, no whitespace is added.
+ *
+ * Warning: This method assumes that the data structure is acyclical.
+ *
+ * @return The writer.
+ * @throws JSONException
+ */
+ protected Writer write(Writer writer) {
+ return this.write(writer, 0, 0);
+ }
+
+
+ static final Writer writeValue(Writer writer, Object value,
+ int indentFactor, int indent) throws IOException {
+ if (value == null || value.equals(null)) {
+ writer.write("null");
+ } else if (value instanceof JSONObject) {
+ ((JSONObject) value).write(writer, indentFactor, indent);
+ } else if (value instanceof JSONArray) {
+ ((JSONArray) value).write(writer, indentFactor, indent);
+ } else if (value instanceof Map) {
+ new JSONObject((Map) value).write(writer, indentFactor, indent);
+ } else if (value instanceof Collection) {
+ new JSONArray((Collection) value).write(writer, indentFactor,
+ indent);
+ } else if (value.getClass().isArray()) {
+ new JSONArray(value).write(writer, indentFactor, indent);
+ } else if (value instanceof Number) {
+ writer.write(numberToString((Number) value));
+ } else if (value instanceof Boolean) {
+ writer.write(value.toString());
+ /*
+ } else if (value instanceof JSONString) {
+ Object o;
+ try {
+ o = ((JSONString) value).toJSONString();
+ } catch (Exception e) {
+ throw new RuntimeException(e);
+ }
+ writer.write(o != null ? o.toString() : quote(value.toString()));
+ */
+ } else {
+ quote(value.toString(), writer);
+ }
+ return writer;
+ }
+
+
+ static final void indent(Writer writer, int indent) throws IOException {
+ for (int i = 0; i < indent; i += 1) {
+ writer.write(' ');
+ }
+ }
+
+ /**
+ * Write the contents of the JSONObject as JSON text to a writer. For
+ * compactness, no whitespace is added.
+ *
+ * Warning: This method assumes that the data structure is acyclical.
+ *
+ * @return The writer.
+ * @throws JSONException
+ */
+ protected Writer write(Writer writer, int indentFactor, int indent) {
+ try {
+ boolean commanate = false;
+ final int length = this.size();
+ Iterator keys = this.keys();
+ writer.write('{');
+
+ int actualFactor = (indentFactor == -1) ? 0 : indentFactor;
+
+ if (length == 1) {
+ Object key = keys.next();
+ writer.write(quote(key.toString()));
+ writer.write(':');
+ if (actualFactor > 0) {
+ writer.write(' ');
+ }
+ writeValue(writer, this.map.get(key), actualFactor, indent);
+ } else if (length != 0) {
+ final int newindent = indent + actualFactor;
+ while (keys.hasNext()) {
+ Object key = keys.next();
+ if (commanate) {
+ writer.write(',');
+ }
+ if (indentFactor != -1) {
+ writer.write('\n');
+ }
+ indent(writer, newindent);
+ writer.write(quote(key.toString()));
+ writer.write(':');
+ if (actualFactor > 0) {
+ writer.write(' ');
+ }
+ writeValue(writer, this.map.get(key), actualFactor,
+ newindent);
+ commanate = true;
+ }
+ if (indentFactor != -1) {
+ writer.write('\n');
+ }
+ indent(writer, indent);
+ }
+ writer.write('}');
+ return writer;
+ } catch (IOException exception) {
+ throw new RuntimeException(exception);
+ }
+ }
+
+
+ // // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
+ //
+ //
+ // class JSONException extends RuntimeException {
+ //
+// public JSONException(String message) {
+// super(message);
+// }
+ //
+// public JSONException(Throwable throwable) {
+// super(throwable);
+// }
+ // }
+
+
+ // . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
+
+
+ // /**
+ // * Get the hex value of a character (base16).
+ // * @param c A character between '0' and '9' or between 'A' and 'F' or
+ // * between 'a' and 'f'.
+ // * @return An int between 0 and 15, or -1 if c was not a hex digit.
+ // */
+ // static protected int dehexchar(char c) {
+// if (c >= '0' && c <= '9') {
+// return c - '0';
+// }
+// if (c >= 'A' && c <= 'F') {
+// return c - ('A' - 10);
+// }
+// if (c >= 'a' && c <= 'f') {
+// return c - ('a' - 10);
+// }
+// return -1;
+ // }
+
+
+ // static class JSONTokener {
+// private long character;
+// private boolean eof;
+// private long index;
+// private long line;
+// private char previous;
+// private Reader reader;
+// private boolean usePrevious;
+ //
+ //
+// /**
+// * Construct a JSONTokener from a Reader.
+// *
+// * @param reader A reader.
+// */
+// public JSONTokener(Reader reader) {
+// this.reader = reader.markSupported()
+// ? reader
+// : new BufferedReader(reader);
+// this.eof = false;
+// this.usePrevious = false;
+// this.previous = 0;
+// this.index = 0;
+// this.character = 1;
+// this.line = 1;
+// }
+ //
+ //
+// /**
+// * Construct a JSONTokener from an InputStream.
+// */
+// public JSONTokener(InputStream inputStream) {
+// this(new InputStreamReader(inputStream));
+// }
+ //
+ //
+// /**
+// * Construct a JSONTokener from a string.
+// *
+// * @param s A source string.
+// */
+// public JSONTokener(String s) {
+// this(new StringReader(s));
+// }
+ //
+ //
+// /**
+// * Back up one character. This provides a sort of lookahead capability,
+// * so that you can test for a digit or letter before attempting to parse
+// * the next number or identifier.
+// */
+// public void back() {
+// if (this.usePrevious || this.index <= 0) {
+// throw new RuntimeException("Stepping back two steps is not supported");
+// }
+// this.index -= 1;
+// this.character -= 1;
+// this.usePrevious = true;
+// this.eof = false;
+// }
+ //
+ //
+// public boolean end() {
+// return this.eof && !this.usePrevious;
+// }
+ //
+ //
+// /**
+// * Determine if the source string still contains characters that next()
+// * can consume.
+// * @return true if not yet at the end of the source.
+// */
+// public boolean more() {
+// this.next();
+// if (this.end()) {
+// return false;
+// }
+// this.back();
+// return true;
+// }
+ //
+ //
+// /**
+// * Get the next character in the source string.
+// *
+// * @return The next character, or 0 if past the end of the source string.
+// */
+// public char next() {
+// int c;
+// if (this.usePrevious) {
+// this.usePrevious = false;
+// c = this.previous;
+// } else {
+// try {
+// c = this.reader.read();
+// } catch (IOException exception) {
+// throw new RuntimeException(exception);
+// }
+ //
+// if (c <= 0) { // End of stream
+// this.eof = true;
+// c = 0;
+// }
+// }
+// this.index += 1;
+// if (this.previous == '\r') {
+// this.line += 1;
+// this.character = c == '\n' ? 0 : 1;
+// } else if (c == '\n') {
+// this.line += 1;
+// this.character = 0;
+// } else {
+// this.character += 1;
+// }
+// this.previous = (char) c;
+// return this.previous;
+// }
+ //
+ //
+// /**
+// * Consume the next character, and check that it matches a specified
+// * character.
+// * @param c The character to match.
+// * @return The character.
+// * @throws JSONException if the character does not match.
+// */
+// public char next(char c) {
+// char n = this.next();
+// if (n != c) {
+// throw new RuntimeException("Expected '" + c + "' and instead saw '" + n + "'");
+// }
+// return n;
+// }
+ //
+ //
+// /**
+// * Get the next n characters.
+// *
+// * @param n The number of characters to take.
+// * @return A string of n characters.
+// * @throws JSONException
+// * Substring bounds error if there are not
+// * n characters remaining in the source string.
+// */
+// public String next(int n) {
+// if (n == 0) {
+// return "";
+// }
+ //
+// char[] chars = new char[n];
+// int pos = 0;
+ //
+// while (pos < n) {
+// chars[pos] = this.next();
+// if (this.end()) {
+// throw new RuntimeException("Substring bounds error");
+// }
+// pos += 1;
+// }
+// return new String(chars);
+// }
+ //
+ //
+// /**
+// * Get the next char in the string, skipping whitespace.
+// * @throws JSONException
+// * @return A character, or 0 if there are no more characters.
+// */
+// public char nextClean() {
+// for (;;) {
+// char c = this.next();
+// if (c == 0 || c > ' ') {
+// return c;
+// }
+// }
+// }
+ //
+ //
+// /**
+// * Return the characters up to the next close quote character.
+// * Backslash processing is done. The formal JSON format does not
+// * allow strings in single quotes, but an implementation is allowed to
+// * accept them.
+// * @param quote The quoting character, either
+// * " (double quote) or
+// * ' (single quote).
+// * @return A String.
+// * @throws JSONException Unterminated string.
+// */
+// public String nextString(char quote) {
+// char c;
+// StringBuffer sb = new StringBuffer();
+// for (;;) {
+// c = this.next();
+// switch (c) {
+// case 0:
+// case '\n':
+// case '\r':
+// throw new RuntimeException("Unterminated string");
+// case '\\':
+// c = this.next();
+// switch (c) {
+// case 'b':
+// sb.append('\b');
+// break;
+// case 't':
+// sb.append('\t');
+// break;
+// case 'n':
+// sb.append('\n');
+// break;
+// case 'f':
+// sb.append('\f');
+// break;
+// case 'r':
+// sb.append('\r');
+// break;
+// case 'u':
+// sb.append((char)Integer.parseInt(this.next(4), 16));
+// break;
+// case '"':
+// case '\'':
+// case '\\':
+// case '/':
+// sb.append(c);
+// break;
+// default:
+// throw new RuntimeException("Illegal escape.");
+// }
+// break;
+// default:
+// if (c == quote) {
+// return sb.toString();
+// }
+// sb.append(c);
+// }
+// }
+// }
+ //
+ //
+// /**
+// * Get the text up but not including the specified character or the
+// * end of line, whichever comes first.
+// * @param delimiter A delimiter character.
+// * @return A string.
+// */
+// public String nextTo(char delimiter) {
+// StringBuffer sb = new StringBuffer();
+// for (;;) {
+// char c = this.next();
+// if (c == delimiter || c == 0 || c == '\n' || c == '\r') {
+// if (c != 0) {
+// this.back();
+// }
+// return sb.toString().trim();
+// }
+// sb.append(c);
+// }
+// }
+ //
+ //
+// /**
+// * Get the text up but not including one of the specified delimiter
+// * characters or the end of line, whichever comes first.
+// * @param delimiters A set of delimiter characters.
+// * @return A string, trimmed.
+// */
+// public String nextTo(String delimiters) {
+// char c;
+// StringBuffer sb = new StringBuffer();
+// for (;;) {
+// c = this.next();
+// if (delimiters.indexOf(c) >= 0 || c == 0 ||
+// c == '\n' || c == '\r') {
+// if (c != 0) {
+// this.back();
+// }
+// return sb.toString().trim();
+// }
+// sb.append(c);
+// }
+// }
+ //
+ //
+// /**
+// * Get the next value. The value can be a Boolean, Double, Integer,
+// * JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.
+// * @throws JSONException If syntax error.
+// *
+// * @return An object.
+// */
+// public Object nextValue() {
+// char c = this.nextClean();
+// String string;
+ //
+// switch (c) {
+// case '"':
+// case '\'':
+// return this.nextString(c);
+// case '{':
+// this.back();
+// return new JSONObject(this);
+// case '[':
+// this.back();
+// return new JSONArray(this);
+// }
+ //
+// /*
+// * Handle unquoted text. This could be the values true, false, or
+// * null, or it can be a number. An implementation (such as this one)
+// * is allowed to also accept non-standard forms.
+// *
+// * Accumulate characters until we reach the end of the text or a
+// * formatting character.
+// */
+ //
+// StringBuffer sb = new StringBuffer();
+// while (c >= ' ' && ",:]}/\\\"[{;=#".indexOf(c) < 0) {
+// sb.append(c);
+// c = this.next();
+// }
+// this.back();
+ //
+// string = sb.toString().trim();
+// if ("".equals(string)) {
+// throw new RuntimeException("Missing value");
+// }
+// return JSONObject.stringToValue(string);
+// }
+ //
+ //
+// /**
+// * Skip characters until the next character is the requested character.
+// * If the requested character is not found, no characters are skipped.
+// * @param to A character to skip to.
+// * @return The requested character, or zero if the requested character
+// * is not found.
+// */
+// public char skipTo(char to) {
+// char c;
+// try {
+// long startIndex = this.index;
+// long startCharacter = this.character;
+// long startLine = this.line;
+// this.reader.mark(1000000);
+// do {
+// c = this.next();
+// if (c == 0) {
+// this.reader.reset();
+// this.index = startIndex;
+// this.character = startCharacter;
+// this.line = startLine;
+// return c;
+// }
+// } while (c != to);
+// } catch (IOException exc) {
+// throw new RuntimeException(exc);
+// }
+ //
+// this.back();
+// return c;
+// }
+ //
+ //
+// /**
+// * Make a printable string of this JSONTokener.
+// *
+// * @return " at {index} [character {character} line {line}]"
+// */
+// @Override
+// public String toString() {
+// return " at " + this.index + " [character " + this.character + " line " +
+// this.line + "]";
+// }
+ // }
+ }
+
+ /*
+ Copyright (c) 2002 JSON.org
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ The Software shall be used for Good, not Evil.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+ */
+
+ /**
+ * A JSONArray is an ordered sequence of values. Its external text form is a
+ * string wrapped in square brackets with commas separating the values. The
+ * internal form is an object having get and opt
+ * methods for accessing the values by index, and put methods for
+ * adding or replacing values. The values can be any of these types:
+ * Boolean, JSONArray, JSONObject,
+ * Number, String, or the
+ * JSONObject.NULL object.
+ *
+ * The constructor can convert a JSON text into a Java object. The
+ * toString method converts to JSON text.
+ *
+ * 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 texts produced by the toString methods strictly conform to
+ * JSON syntax rules. The constructors are more forgiving in the texts they will
+ * accept:
+ *
+ *
An extra , (comma) may appear just
+ * before the closing bracket.
+ *
The null value will be inserted when there is ,
+ * (comma) elision.
+ *
Strings may be quoted with ' (single
+ * quote).
+ *
Strings do not need to be quoted at all if they do not begin with a quote
+ * or single quote, and if they do not contain leading or trailing spaces, and
+ * if they do not contain any of these characters:
+ * { } [ ] / \ : , = ; # and if they do not look like numbers and
+ * if they are not the reserved words true, false, or
+ * null.
+ *
Values can be separated by ; (semicolon) as
+ * well as by , (comma).
+ *
+ *
+ * @author JSON.org
+ * @version 2012-11-13
+ */
+ static class JSONArray extends JSON {
+
+
+ /**
+ * The arrayList where the JSONArray's properties are kept.
+ */
+ private final ArrayList
org.json.CDL
+