diff --git a/json/HTTP.java b/json/HTTP.java new file mode 100644 index 000000000..a7f3c75c2 --- /dev/null +++ b/json/HTTP.java @@ -0,0 +1,201 @@ +package ninja.bytecode.shuriken.json; + + +/* +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. +*/ + +import java.util.Iterator; + +/** + * Convert an HTTP header to a JSONObject and back. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class HTTP +{ + + /** Carriage return/line feed. */ + public static final String CRLF = "\r\n"; + + /** + * Convert an HTTP header string into a JSONObject. It can be a request + * header or a response header. A request header will contain + * + *
+	 * {
+	 *    Method: "POST" (for example),
+	 *    "Request-URI": "/" (for example),
+	 *    "HTTP-Version": "HTTP/1.1" (for example)
+	 * }
+	 * 
+ * + * A response header will contain + * + *
+	 * {
+	 *    "HTTP-Version": "HTTP/1.1" (for example),
+	 *    "Status-Code": "200" (for example),
+	 *    "Reason-Phrase": "OK" (for example)
+	 * }
+	 * 
+ * + * In addition, the other parameters in the header will be captured, using + * the HTTP field names as JSON names, so that + * + *
+	 *    Date: Sun, 26 May 2002 18:06:04 GMT
+	 *    Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
+	 *    Cache-Control: no-cache
+	 * 
+ * + * become + * + *
+	 * {...
+	 *    Date: "Sun, 26 May 2002 18:06:04 GMT",
+	 *    Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
+	 *    "Cache-Control": "no-cache",
+	 * ...}
+	 * 
+ * + * It does no further checking or conversion. It does not parse dates. It + * does not do '%' transforms on URLs. + * + * @param string + * An HTTP header string. + * @return A JSONObject containing the elements and attributes of the XML + * string. + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException + { + JSONObject jo = new JSONObject(); + 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(); + } + return jo; + } + + /** + * Convert a JSONObject into an HTTP header. A request header must contain + * + *
+	 * {
+	 *    Method: "POST" (for example),
+	 *    "Request-URI": "/" (for example),
+	 *    "HTTP-Version": "HTTP/1.1" (for example)
+	 * }
+	 * 
+ * + * A response header must contain + * + *
+	 * {
+	 *    "HTTP-Version": "HTTP/1.1" (for example),
+	 *    "Status-Code": "200" (for example),
+	 *    "Reason-Phrase": "OK" (for example)
+	 * }
+	 * 
+ * + * Any other members of the JSONObject will be output as HTTP fields. The + * result will end with two CRLF pairs. + * + * @param jo + * A JSONObject + * @return An HTTP header string. + * @throws JSONException + * if the object does not contain enough information. + */ + public static String toString(JSONObject jo) throws JSONException + { + Iterator keys = jo.keys(); + String string; + StringBuilder sb = new StringBuilder(); + if(jo.has("Status-Code") && jo.has("Reason-Phrase")) + { + sb.append(jo.getString("HTTP-Version")); + sb.append(' '); + sb.append(jo.getString("Status-Code")); + sb.append(' '); + sb.append(jo.getString("Reason-Phrase")); + } else if(jo.has("Method") && jo.has("Request-URI")) + { + sb.append(jo.getString("Method")); + sb.append(' '); + sb.append('"'); + sb.append(jo.getString("Request-URI")); + sb.append('"'); + sb.append(' '); + sb.append(jo.getString("HTTP-Version")); + } else + { + throw new JSONException("Not enough material for an HTTP header."); + } + sb.append(CRLF); + while(keys.hasNext()) + { + string = keys.next(); + if(!"HTTP-Version".equals(string) && !"Status-Code".equals(string) && !"Reason-Phrase".equals(string) && !"Method".equals(string) && !"Request-URI".equals(string) && !jo.isNull(string)) + { + sb.append(string); + sb.append(": "); + sb.append(jo.getString(string)); + sb.append(CRLF); + } + } + sb.append(CRLF); + return sb.toString(); + } +} diff --git a/json/HTTPTokener.java b/json/HTTPTokener.java new file mode 100644 index 000000000..f5f956986 --- /dev/null +++ b/json/HTTPTokener.java @@ -0,0 +1,91 @@ +package ninja.bytecode.shuriken.json; + + +/* +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. +*/ + +/** + * The HTTPTokener extends the JSONTokener to provide additional methods for the + * parsing of HTTP headers. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class HTTPTokener extends JSONTokener +{ + + /** + * Construct an HTTPTokener from a string. + * + * @param string + * A source string. + */ + public HTTPTokener(String string) + { + super(string); + } + + /** + * Get the next token or string. This is used in parsing HTTP headers. + * + * @throws JSONException + * @return A String. + */ + public String nextToken() throws JSONException + { + char c; + char q; + StringBuilder sb = new StringBuilder(); + do + { + c = next(); + } while(Character.isWhitespace(c)); + if(c == '"' || c == '\'') + { + q = c; + for(;;) + { + c = next(); + if(c < ' ') + { + throw syntaxError("Unterminated string."); + } + if(c == q) + { + return sb.toString(); + } + sb.append(c); + } + } + for(;;) + { + if(c == 0 || Character.isWhitespace(c)) + { + return sb.toString(); + } + sb.append(c); + c = next(); + } + } +} diff --git a/json/JSONArray.java b/json/JSONArray.java new file mode 100644 index 000000000..93aa08be5 --- /dev/null +++ b/json/JSONArray.java @@ -0,0 +1,1252 @@ +package ninja.bytecode.shuriken.json; + + +/* + 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. + */ + +import java.io.IOException; +import java.io.StringWriter; +import java.io.Writer; +import java.lang.reflect.Array; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Iterator; +import java.util.Map; + +/** + * 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: + *

+ * + * @author JSON.org + * @version 2015-07-22 + */ +public class JSONArray implements Iterable +{ + + /** + * The arrayList where the JSONArray's properties are kept. + */ + private final ArrayList myArrayList; + + /** + * Construct an empty JSONArray. + */ + public JSONArray() + { + this.myArrayList = new ArrayList(); + } + + /** + * Construct a JSONArray from a JSONTokener. + * + * @param x + * A JSONTokener + * @throws JSONException + * If there is a syntax error. + */ + public JSONArray(JSONTokener x) throws JSONException + { + this(); + if(x.nextClean() != '[') + { + throw x.syntaxError("A JSONArray text must start with '['"); + } + if(x.nextClean() != ']') + { + x.back(); + for(;;) + { + if(x.nextClean() == ',') + { + x.back(); + this.myArrayList.add(JSONObject.NULL); + } else + { + x.back(); + this.myArrayList.add(x.nextValue()); + } + switch(x.nextClean()) + { + case ',': + if(x.nextClean() == ']') + { + return; + } + x.back(); + break; + case ']': + return; + default: + throw x.syntaxError("Expected a ',' or ']'"); + } + } + } + } + + /** + * Construct a JSONArray from a source JSON text. + * + * @param source + * A string that begins with [ (left + * bracket) and ends with ]   + * (right bracket). + * @throws JSONException + * If there is a syntax error. + */ + public JSONArray(String source) throws JSONException + { + this(new JSONTokener(source)); + } + + /** + * Construct a JSONArray from a Collection. + * + * @param collection + * A Collection. + */ + public JSONArray(Collection collection) + { + this.myArrayList = new ArrayList(); + if(collection != null) + { + Iterator iter = collection.iterator(); + while(iter.hasNext()) + { + this.myArrayList.add(JSONObject.wrap(iter.next())); + } + } + } + + /** + * Construct a JSONArray from an array + * + * @throws JSONException + * If not an array. + */ + public JSONArray(Object array) throws JSONException + { + this(); + if(array.getClass().isArray()) + { + int length = Array.getLength(array); + for(int i = 0; i < length; i += 1) + { + this.put(JSONObject.wrap(Array.get(array, i))); + } + } else + { + throw new JSONException("JSONArray initial value should be a string or collection or array."); + } + } + + @Override + public Iterator iterator() + { + return myArrayList.iterator(); + } + + /** + * Get the object value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return An object value. + * @throws JSONException + * If there is no value for the index. + */ + public Object get(int index) throws JSONException + { + Object object = this.opt(index); + if(object == null) + { + throw new JSONException("JSONArray[" + index + "] not found."); + } + return object; + } + + /** + * Get the boolean value associated with an index. The string values "true" + * and "false" are converted to boolean. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The truth. + * @throws JSONException + * If there is no value for the index or if the value is not + * convertible to boolean. + */ + public boolean getBoolean(int index) throws JSONException + { + Object object = this.get(index); + 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 JSONException("JSONArray[" + index + "] is not a boolean."); + } + + /** + * Get the double value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value cannot be converted + * to a number. + */ + public double getDouble(int index) throws JSONException + { + Object object = this.get(index); + try + { + return object instanceof Number ? ((Number) object).doubleValue() : Double.parseDouble((String) object); + } catch(Exception e) + { + throw new JSONException("JSONArray[" + index + "] is not a number."); + } + } + + /** + * Get the enum value associated with an index. + * + * @param clazz + * The type of enum to retrieve. + * @param index + * The index must be between 0 and length() - 1. + * @return The enum value at the index location + * @throws JSONException + * if the key is not found or if the value cannot be converted + * to an enum. + */ + public > E getEnum(Class clazz, int index) throws JSONException + { + E val = optEnum(clazz, index); + if(val == null) + { + // JSONException should really take a throwable argument. + // If it did, I would re-implement this with the Enum.valueOf + // method and place any thrown exception in the JSONException + throw new JSONException("JSONObject[" + JSONObject.quote(Integer.toString(index)) + "] is not an enum of type " + JSONObject.quote(clazz.getSimpleName()) + "."); + } + return val; + } + + /** + * Get the BigDecimal value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value cannot be converted + * to a BigDecimal. + */ + public BigDecimal getBigDecimal(int index) throws JSONException + { + Object object = this.get(index); + try + { + return new BigDecimal(object.toString()); + } catch(Exception e) + { + throw new JSONException("JSONArray[" + index + "] could not convert to BigDecimal."); + } + } + + /** + * Get the BigInteger value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value cannot be converted + * to a BigInteger. + */ + public BigInteger getBigInteger(int index) throws JSONException + { + Object object = this.get(index); + try + { + return new BigInteger(object.toString()); + } catch(Exception e) + { + throw new JSONException("JSONArray[" + index + "] could not convert to BigInteger."); + } + } + + /** + * Get the int value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value is not a number. + */ + public int getInt(int index) throws JSONException + { + Object object = this.get(index); + try + { + return object instanceof Number ? ((Number) object).intValue() : Integer.parseInt((String) object); + } catch(Exception e) + { + throw new JSONException("JSONArray[" + index + "] is not a number."); + } + } + + /** + * Get the JSONArray associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A JSONArray value. + * @throws JSONException + * If there is no value for the index. or if the value is not a + * JSONArray + */ + public JSONArray getJSONArray(int index) throws JSONException + { + Object object = this.get(index); + if(object instanceof JSONArray) + { + return (JSONArray) object; + } + throw new JSONException("JSONArray[" + index + "] is not a JSONArray."); + } + + /** + * Get the JSONObject associated with an index. + * + * @param index + * subscript + * @return A JSONObject value. + * @throws JSONException + * If there is no value for the index or if the value is not a + * JSONObject + */ + public JSONObject getJSONObject(int index) throws JSONException + { + Object object = this.get(index); + if(object instanceof JSONObject) + { + return (JSONObject) object; + } + throw new JSONException("JSONArray[" + index + "] is not a JSONObject."); + } + + /** + * Get the long value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value cannot be converted + * to a number. + */ + public long getLong(int index) throws JSONException + { + Object object = this.get(index); + try + { + return object instanceof Number ? ((Number) object).longValue() : Long.parseLong((String) object); + } catch(Exception e) + { + throw new JSONException("JSONArray[" + index + "] is not a number."); + } + } + + /** + * Get the string associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A string value. + * @throws JSONException + * If there is no string value for the index. + */ + public String getString(int index) throws JSONException + { + Object object = this.get(index); + if(object instanceof String) + { + return (String) object; + } + throw new JSONException("JSONArray[" + index + "] not a string."); + } + + /** + * Determine if the value is null. + * + * @param index + * The index must be between 0 and length() - 1. + * @return true if the value at the index is null, or if there is no value. + */ + public boolean isNull(int index) + { + return JSONObject.NULL.equals(this.opt(index)); + } + + /** + * 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. + * + * @param separator + * A string that will be inserted between the elements. + * @return a string. + * @throws JSONException + * If the array contains an invalid number. + */ + public String join(String separator) throws JSONException + { + int len = this.length(); + StringBuilder sb = new StringBuilder(); + + for(int i = 0; i < len; i += 1) + { + if(i > 0) + { + sb.append(separator); + } + sb.append(JSONObject.valueToString(this.myArrayList.get(i))); + } + return sb.toString(); + } + + /** + * Get the number of elements in the JSONArray, included nulls. + * + * @return The length (or size). + */ + public int length() + { + return this.myArrayList.size(); + } + + /** + * Get the optional object value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return An object value, or null if there is no object at that index. + */ + public Object opt(int index) + { + return (index < 0 || index >= this.length()) ? null : this.myArrayList.get(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". + * + * @param index + * The index must be between 0 and length() - 1. + * @return The truth. + */ + public boolean optBoolean(int index) + { + return this.optBoolean(index, false); + } + + /** + * 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). + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * A boolean default. + * @return The truth. + */ + public boolean optBoolean(int index, boolean defaultValue) + { + try + { + return this.getBoolean(index); + } catch(Exception e) + { + return defaultValue; + } + } + + /** + * 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + */ + public double optDouble(int index) + { + return this.optDouble(index, Double.NaN); + } + + /** + * 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. + * + * @param index + * subscript + * @param defaultValue + * The default value. + * @return The value. + */ + public double optDouble(int index, double defaultValue) + { + try + { + return this.getDouble(index); + } catch(Exception e) + { + return defaultValue; + } + } + + /** + * 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + */ + public int optInt(int index) + { + return this.optInt(index, 0); + } + + /** + * 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return The value. + */ + public int optInt(int index, int defaultValue) + { + try + { + return this.getInt(index); + } catch(Exception e) + { + return defaultValue; + } + } + + /** + * Get the enum value associated with a key. + * + * @param clazz + * The type of enum to retrieve. + * @param index + * The index must be between 0 and length() - 1. + * @return The enum value at the index location or null if not found + */ + public > E optEnum(Class clazz, int index) + { + return this.optEnum(clazz, index, null); + } + + /** + * Get the enum value associated with a key. + * + * @param clazz + * The type of enum to retrieve. + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default in case the value is not found + * @return The enum value at the index location or defaultValue if the value + * is not found or cannot be assigned to clazz + */ + public > E optEnum(Class clazz, int index, E defaultValue) + { + try + { + Object val = this.opt(index); + if(JSONObject.NULL.equals(val)) + { + return defaultValue; + } + if(clazz.isAssignableFrom(val.getClass())) + { + // we just checked it! + @SuppressWarnings("unchecked") + E myE = (E) val; + return myE; + } + return Enum.valueOf(clazz, val.toString()); + } + + catch(IllegalArgumentException e) + { + return defaultValue; + } + + catch(NullPointerException e) + { + return defaultValue; + } + } + + /** + * Get the optional BigInteger 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return The value. + */ + public BigInteger optBigInteger(int index, BigInteger defaultValue) + { + try + { + return this.getBigInteger(index); + } catch(Exception e) + { + return defaultValue; + } + } + + /** + * Get the optional BigDecimal 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return The value. + */ + public BigDecimal optBigDecimal(int index, BigDecimal defaultValue) + { + try + { + return this.getBigDecimal(index); + } catch(Exception e) + { + return defaultValue; + } + } + + /** + * Get the optional JSONArray associated with an index. + * + * @param index + * subscript + * @return A JSONArray value, or null if the index has no value, or if the + * value is not a JSONArray. + */ + public JSONArray optJSONArray(int index) + { + Object o = this.opt(index); + return o instanceof JSONArray ? (JSONArray) o : null; + } + + /** + * 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A JSONObject value. + */ + public JSONObject optJSONObject(int index) + { + Object o = this.opt(index); + return o instanceof JSONObject ? (JSONObject) o : null; + } + + /** + * 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + */ + public long optLong(int index) + { + return this.optLong(index, 0); + } + + /** + * 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return The value. + */ + public long optLong(int index, long defaultValue) + { + try + { + return this.getLong(index); + } catch(Exception e) + { + return defaultValue; + } + } + + /** + * 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. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A String value. + */ + public String optString(int index) + { + return this.optString(index, ""); + } + + /** + * Get the optional string associated with an index. The defaultValue is + * returned if the key is not found. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return A String value. + */ + public String optString(int index, String defaultValue) + { + Object object = this.opt(index); + return JSONObject.NULL.equals(object) ? defaultValue : object.toString(); + } + + /** + * Append a boolean value. This increases the array's length by one. + * + * @param value + * A boolean value. + * @return this. + */ + public JSONArray put(boolean value) + { + this.put(value ? Boolean.TRUE : Boolean.FALSE); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONArray which + * is produced from a Collection. + * + * @param value + * A Collection value. + * @return this. + */ + public JSONArray put(Collection value) + { + this.put(new JSONArray(value)); + return this; + } + + /** + * Append a double value. This increases the array's length by one. + * + * @param value + * A double value. + * @throws JSONException + * if the value is not finite. + * @return this. + */ + public JSONArray put(double value) throws JSONException + { + Double d = new Double(value); + JSONObject.testValidity(d); + this.put(d); + return this; + } + + /** + * Append an int value. This increases the array's length by one. + * + * @param value + * An int value. + * @return this. + */ + public JSONArray put(int value) + { + this.put(new Integer(value)); + return this; + } + + /** + * Append an long value. This increases the array's length by one. + * + * @param value + * A long value. + * @return this. + */ + public JSONArray put(long value) + { + this.put(new Long(value)); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONObject which + * is produced from a Map. + * + * @param value + * A Map value. + * @return this. + */ + public JSONArray put(Map value) + { + this.put(new JSONObject(value)); + return this; + } + + /** + * Append an object value. This increases the array's length by one. + * + * @param value + * An object value. The value should be a Boolean, Double, + * Integer, JSONArray, JSONObject, Long, or String, or the + * JSONObject.NULL object. + * @return this. + */ + public JSONArray put(Object value) + { + this.myArrayList.add(value); + return this; + } + + /** + * 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. + * + * @param index + * The subscript. + * @param value + * A boolean value. + * @return this. + * @throws JSONException + * If the index is negative. + */ + public JSONArray put(int index, boolean value) throws JSONException + { + this.put(index, value ? Boolean.TRUE : Boolean.FALSE); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONArray which + * is produced from a Collection. + * + * @param index + * The subscript. + * @param value + * A Collection value. + * @return this. + * @throws JSONException + * If the index is negative or if the value is not finite. + */ + public JSONArray put(int index, Collection value) throws JSONException + { + this.put(index, new JSONArray(value)); + return this; + } + + /** + * 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. + * + * @param index + * The subscript. + * @param value + * A double value. + * @return this. + * @throws JSONException + * If the index is negative or if the value is not finite. + */ + public JSONArray put(int index, double value) throws JSONException + { + this.put(index, new Double(value)); + return this; + } + + /** + * 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. + * + * @param index + * The subscript. + * @param value + * An int value. + * @return this. + * @throws JSONException + * If the index is negative. + */ + public JSONArray put(int index, int value) throws JSONException + { + this.put(index, new Integer(value)); + return this; + } + + /** + * 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. + * + * @param index + * The subscript. + * @param value + * A long value. + * @return this. + * @throws JSONException + * If the index is negative. + */ + public JSONArray put(int index, long value) throws JSONException + { + this.put(index, new Long(value)); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONObject that + * is produced from a Map. + * + * @param index + * The subscript. + * @param value + * The Map value. + * @return this. + * @throws JSONException + * If the index is negative or if the the value is an invalid + * number. + */ + public JSONArray put(int index, Map value) throws JSONException + { + this.put(index, new JSONObject(value)); + return this; + } + + /** + * 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. + * + * @param index + * The subscript. + * @param 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. + * @return this. + * @throws JSONException + * If the index is negative or if the the value is an invalid + * number. + */ + public JSONArray put(int index, Object value) throws JSONException + { + JSONObject.testValidity(value); + if(index < 0) + { + throw new JSONException("JSONArray[" + index + "] not found."); + } + if(index < this.length()) + { + this.myArrayList.set(index, value); + } else + { + while(index != this.length()) + { + this.put(JSONObject.NULL); + } + this.put(value); + } + return this; + } + + /** + * Remove an index and close the hole. + * + * @param index + * The index of the element to be removed. + * @return The value that was associated with the index, or null if there + * was no value. + */ + public Object remove(int index) + { + return index >= 0 && index < this.length() ? this.myArrayList.remove(index) : null; + } + + /** + * Determine if two JSONArrays are similar. They must contain similar + * sequences. + * + * @param other + * The other JSONArray + * @return true if they are equal + */ + public boolean similar(Object other) + { + if(!(other instanceof JSONArray)) + { + return false; + } + int len = this.length(); + if(len != ((JSONArray) other).length()) + { + return false; + } + for(int i = 0; i < len; i += 1) + { + Object valueThis = this.get(i); + Object valueOther = ((JSONArray) other).get(i); + if(valueThis instanceof JSONObject) + { + if(!((JSONObject) valueThis).similar(valueOther)) + { + return false; + } + } else if(valueThis instanceof JSONArray) + { + if(!((JSONArray) valueThis).similar(valueOther)) + { + return false; + } + } else if(!valueThis.equals(valueOther)) + { + return false; + } + } + return true; + } + + /** + * Produce a JSONObject by combining a JSONArray of names with the values of + * this JSONArray. + * + * @param names + * A JSONArray containing a list of key strings. These will be + * paired with the values. + * @return A JSONObject, or null if there are no names or if this JSONArray + * has no values. + * @throws JSONException + * If any of the names are null. + */ + public JSONObject toJSONObject(JSONArray names) throws JSONException + { + if(names == null || names.length() == 0 || this.length() == 0) + { + return null; + } + JSONObject jo = new JSONObject(); + for(int i = 0; i < names.length(); i += 1) + { + jo.put(names.getString(i), this.opt(i)); + } + return jo; + } + + /** + * 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. + * + * @return a printable, displayable, transmittable representation of the + * array. + */ + @Override + public String toString() + { + try + { + return this.toString(0); + } catch(Exception e) + { + return null; + } + } + + /** + * Make a prettyprinted JSON text of this JSONArray. 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, transmittable representation of the + * object, beginning with [ (left + * bracket) and ending with ]   + * (right bracket). + * @throws JSONException + */ + public String toString(int indentFactor) throws JSONException + { + StringWriter sw = new StringWriter(); + synchronized(sw.getBuffer()) + { + return this.write(sw, indentFactor, 0).toString(); + } + } + + /** + * Write the contents of the JSONArray 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 + */ + public Writer write(Writer writer) throws JSONException + { + return this.write(writer, 0, 0); + } + + /** + * Write the contents of the JSONArray as JSON text to a writer. For + * compactness, no whitespace is added. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @param indentFactor + * The number of spaces to add to each level of indentation. + * @param indent + * The indention of the top level. + * @return The writer. + * @throws JSONException + */ + Writer write(Writer writer, int indentFactor, int indent) throws JSONException + { + try + { + boolean commanate = false; + int length = this.length(); + writer.write('['); + + if(length == 1) + { + JSONObject.writeValue(writer, this.myArrayList.get(0), indentFactor, indent); + } else if(length != 0) + { + final int newindent = indent + indentFactor; + + for(int i = 0; i < length; i += 1) + { + if(commanate) + { + writer.write(','); + } + if(indentFactor > 0) + { + writer.write('\n'); + } + JSONObject.indent(writer, newindent); + JSONObject.writeValue(writer, this.myArrayList.get(i), indentFactor, newindent); + commanate = true; + } + if(indentFactor > 0) + { + writer.write('\n'); + } + JSONObject.indent(writer, indent); + } + writer.write(']'); + return writer; + } catch(IOException e) + { + throw new JSONException(e); + } + } +} diff --git a/json/JSONException.java b/json/JSONException.java new file mode 100644 index 000000000..0b370bb22 --- /dev/null +++ b/json/JSONException.java @@ -0,0 +1,50 @@ +package ninja.bytecode.shuriken.json; + + +/** + * The JSONException is thrown by the JSON.org classes when things are amiss. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class JSONException extends RuntimeException +{ + private static final long serialVersionUID = 0; + private Throwable cause; + + /** + * Constructs a JSONException with an explanatory message. + * + * @param message + * Detail about the reason for the exception. + */ + public JSONException(String message) + { + super(message); + } + + /** + * Constructs a new JSONException with the specified cause. + * + * @param cause + * The cause. + */ + public JSONException(Throwable cause) + { + super(cause.getMessage()); + this.cause = cause; + } + + /** + * Returns the cause of this exception or null if the cause is nonexistent + * or unknown. + * + * @return the cause of this exception or null if the cause is nonexistent + * or unknown. + */ + @Override + public Throwable getCause() + { + return this.cause; + } +} diff --git a/json/JSONML.java b/json/JSONML.java new file mode 100644 index 000000000..f96163583 --- /dev/null +++ b/json/JSONML.java @@ -0,0 +1,555 @@ +package ninja.bytecode.shuriken.json; + + +/* +Copyright (c) 2008 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. +*/ + +import java.util.Iterator; + +/** + * 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. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class JSONML +{ + + /** + * Parse XML values and store them in a JSONArray. + * + * @param x + * The XMLTokener containing the source string. + * @param arrayForm + * true if array form, false if object form. + * @param ja + * The JSONArray that is containing the current tag or null if we + * are at the outermost level. + * @return A JSONArray if the value is the outermost tag, otherwise null. + * @throws JSONException + */ + private static Object parse(XMLTokener x, boolean arrayForm, JSONArray ja) throws JSONException + { + String attribute; + char c; + String closeTag = null; + int i; + JSONArray newja = null; + JSONObject newjo = null; + Object token; + String tagName = null; + + // Test for and skip past these forms: + // + // + // + // + + while(true) + { + if(!x.more()) + { + throw x.syntaxError("Bad XML"); + } + token = x.nextContent(); + if(token == XML.LT) + { + token = x.nextToken(); + if(token instanceof Character) + { + if(token == XML.SLASH) + { + + // Close tag "); + } else + { + x.back(); + } + } else if(c == '[') + { + token = x.nextToken(); + if(token.equals("CDATA") && x.next() == '[') + { + if(ja != null) + { + ja.put(x.nextCDATA()); + } + } else + { + throw x.syntaxError("Expected 'CDATA['"); + } + } else + { + i = 1; + do + { + token = x.nextMeta(); + if(token == null) + { + throw x.syntaxError("Missing '>' after ' 0); + } + } else if(token == XML.QUEST) + { + + // "); + } else + { + throw x.syntaxError("Misshaped tag"); + } + + // Open tag < + + } else + { + if(!(token instanceof String)) + { + throw x.syntaxError("Bad tagName '" + token + "'."); + } + tagName = (String) token; + newja = new JSONArray(); + newjo = new JSONObject(); + if(arrayForm) + { + newja.put(tagName); + if(ja != null) + { + ja.put(newja); + } + } else + { + newjo.put("tagName", tagName); + if(ja != null) + { + ja.put(newjo); + } + } + token = null; + for(;;) + { + if(token == null) + { + token = x.nextToken(); + } + if(token == null) + { + throw x.syntaxError("Misshaped tag"); + } + if(!(token instanceof String)) + { + break; + } + + // attribute = value + + attribute = (String) token; + if(!arrayForm && ("tagName".equals(attribute) || "childNode".equals(attribute))) + { + throw x.syntaxError("Reserved attribute."); + } + token = x.nextToken(); + if(token == XML.EQ) + { + token = x.nextToken(); + if(!(token instanceof String)) + { + throw x.syntaxError("Missing value"); + } + newjo.accumulate(attribute, XML.stringToValue((String) token)); + token = null; + } else + { + newjo.accumulate(attribute, ""); + } + } + if(arrayForm && newjo.length() > 0) + { + newja.put(newjo); + } + + // Empty tag <.../> + + if(token == XML.SLASH) + { + if(x.nextToken() != XML.GT) + { + throw x.syntaxError("Misshaped tag"); + } + if(ja == null) + { + if(arrayForm) + { + return newja; + } else + { + return newjo; + } + } + + // Content, between <...> and + + } else + { + if(token != XML.GT) + { + throw x.syntaxError("Misshaped tag"); + } + closeTag = (String) parse(x, arrayForm, newja); + if(closeTag != null) + { + if(!closeTag.equals(tagName)) + { + throw x.syntaxError("Mismatched '" + tagName + "' and '" + closeTag + "'"); + } + tagName = null; + if(!arrayForm && newja.length() > 0) + { + newjo.put("childNodes", newja); + } + if(ja == null) + { + if(arrayForm) + { + return newja; + } else + { + return newjo; + } + } + } + } + } + } else + { + if(ja != null) + { + ja.put(token instanceof String ? XML.stringToValue((String) token) : token); + } + } + } + } + + /** + * 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. + * + * @param string + * The source string. + * @return A JSONArray containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONArray toJSONArray(String string) throws JSONException + { + return toJSONArray(new XMLTokener(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. + * + * @param x + * An XMLTokener. + * @return A JSONArray containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONArray toJSONArray(XMLTokener x) throws JSONException + { + return (JSONArray) parse(x, true, null); + } + + /** + * 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. + * + * @param x + * An XMLTokener of the XML source text. + * @return A JSONObject containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONObject toJSONObject(XMLTokener x) throws JSONException + { + return (JSONObject) parse(x, false, null); + } + + /** + * 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. + * + * @param string + * The XML source text. + * @return A JSONObject containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException + { + return toJSONObject(new XMLTokener(string)); + } + + /** + * Reverse the JSONML transformation, making an XML text from a JSONArray. + * + * @param ja + * A JSONArray. + * @return An XML string. + * @throws JSONException + */ + public static String toString(JSONArray ja) throws JSONException + { + int i; + JSONObject jo; + String key; + Iterator keys; + int length; + Object object; + StringBuilder sb = new StringBuilder(); + String tagName; + String value; + + // Emit = length) + { + sb.append('/'); + sb.append('>'); + } else + { + sb.append('>'); + do + { + object = ja.get(i); + i += 1; + if(object != null) + { + if(object instanceof String) + { + sb.append(XML.escape(object.toString())); + } else if(object instanceof JSONObject) + { + sb.append(toString((JSONObject) object)); + } else if(object instanceof JSONArray) + { + sb.append(toString((JSONArray) object)); + } else + { + sb.append(object.toString()); + } + } + } while(i < length); + sb.append('<'); + sb.append('/'); + sb.append(tagName); + sb.append('>'); + } + return sb.toString(); + } + + /** + * 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. + * + * @param jo + * A JSONObject. + * @return An XML string. + * @throws JSONException + */ + public static String toString(JSONObject jo) throws JSONException + { + StringBuilder sb = new StringBuilder(); + int i; + JSONArray ja; + String key; + Iterator keys; + int length; + Object object; + String tagName; + String value; + + // Emit '); + } else + { + sb.append('>'); + length = ja.length(); + for(i = 0; i < length; i += 1) + { + object = ja.get(i); + if(object != null) + { + if(object instanceof String) + { + sb.append(XML.escape(object.toString())); + } else if(object instanceof JSONObject) + { + sb.append(toString((JSONObject) object)); + } else if(object instanceof JSONArray) + { + sb.append(toString((JSONArray) object)); + } else + { + sb.append(object.toString()); + } + } + } + sb.append('<'); + sb.append('/'); + sb.append(tagName); + sb.append('>'); + } + return sb.toString(); + } +} diff --git a/json/JSONObject.java b/json/JSONObject.java new file mode 100644 index 000000000..767cfc3cb --- /dev/null +++ b/json/JSONObject.java @@ -0,0 +1,2072 @@ +package ninja.bytecode.shuriken.json; + + +/* + 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. + */ + +import java.io.IOException; +import java.io.StringWriter; +import java.io.Writer; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.Collection; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Locale; +import java.util.Map; +import java.util.Map.Entry; +import java.util.ResourceBundle; +import java.util.Set; + +/** + * 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.
  • + *
+ * + * @author JSON.org + * @version 2015-07-22 + */ +public class JSONObject +{ + /** + * 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". + */ + public String toString() + { + return "null"; + } + } + + /** + * The map where the JSONObject's properties are kept. + */ + private final Map 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(); + } + + /** + * 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. + */ + public JSONObject(JSONTokener x) throws JSONException + { + this(); + char c; + String key; + + if(x.nextClean() != '{') + { + throw x.syntaxError("A JSONObject text must begin with '{'"); + } + for(;;) + { + c = x.nextClean(); + switch(c) + { + case 0: + throw x.syntaxError("A JSONObject text must end with '}'"); + case '}': + return; + default: + x.back(); + key = x.nextValue().toString(); + } + + // The key is followed by ':'. + + c = x.nextClean(); + if(c != ':') + { + throw x.syntaxError("Expected a ':' after a key"); + } + this.putOnce(key, x.nextValue()); + + // Pairs are separated by ','. + + switch(x.nextClean()) + { + case ';': + case ',': + if(x.nextClean() == '}') + { + return; + } + x.back(); + break; + case '}': + return; + default: + throw x.syntaxError("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 + */ + public JSONObject(Map map) + { + this.map = new HashMap(); + if(map != null) + { + Iterator> i = map.entrySet().iterator(); + while(i.hasNext()) + { + Entry entry = i.next(); + Object value = entry.getValue(); + if(value != null) + { + this.map.put(entry.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. + */ + public JSONObject(Object bean) + { + this(); + this.populateMap(bean); + } + + /** + * 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. + */ + public JSONObject(String source) throws JSONException + { + this(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 JSONObject(String baseName, Locale locale) throws JSONException + { + 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 != null) + { + + // 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; + JSONObject target = this; + for(int i = 0; i < last; i += 1) + { + String segment = path[i]; + JSONObject nextTarget = target.optJSONObject(segment); + if(nextTarget == null) + { + nextTarget = new JSONObject(); + 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 JSONObject 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().put(value) : value); + } else if(object instanceof JSONArray) + { + ((JSONArray) object).put(value); + } else + { + this.put(key, new JSONArray().put(object).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. + */ + public static 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. + */ + public Object get(String key) throws JSONException + { + if(key == null) + { + throw new JSONException("Null key."); + } + Object object = this.opt(key); + if(object == null) + { + throw new JSONException("JSONObject[" + quote(key) + "] not found."); + } + return object; + } + + /** + * Get the enum value associated with a key. + * + * @param clazz + * The type of enum to retrieve. + * @param key + * A key string. + * @return The enum value associated with the key + * @throws JSONException + * if the key is not found or if the value cannot be converted + * to an enum. + */ + public > E getEnum(Class clazz, String key) throws JSONException + { + E val = optEnum(clazz, key); + if(val == null) + { + // JSONException should really take a throwable argument. + // If it did, I would re-implement this with the Enum.valueOf + // method and place any thrown exception in the JSONException + throw new JSONException("JSONObject[" + quote(key) + "] is not an enum of type " + quote(clazz.getSimpleName()) + "."); + } + return val; + } + + /** + * 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 getBoolean(String key) throws JSONException + { + Object object = this.get(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 JSONException("JSONObject[" + quote(key) + "] is not a Boolean."); + } + + /** + * Get the BigInteger 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 cannot be converted + * to BigInteger. + */ + public BigInteger getBigInteger(String key) throws JSONException + { + Object object = this.get(key); + try + { + return new BigInteger(object.toString()); + } catch(Exception e) + { + throw new JSONException("JSONObject[" + quote(key) + "] could not be converted to BigInteger."); + } + } + + /** + * Get the BigDecimal 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 cannot be converted + * to BigDecimal. + */ + public BigDecimal getBigDecimal(String key) throws JSONException + { + Object object = this.get(key); + try + { + return new BigDecimal(object.toString()); + } catch(Exception e) + { + throw new JSONException("JSONObject[" + quote(key) + "] could not be converted to BigDecimal."); + } + } + + /** + * 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 getDouble(String key) throws JSONException + { + Object object = this.get(key); + try + { + return object instanceof Number ? ((Number) object).doubleValue() : Double.parseDouble((String) object); + } catch(Exception e) + { + throw new JSONException("JSONObject[" + quote(key) + "] is not a number."); + } + } + + /** + * 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 getInt(String key) throws JSONException + { + Object object = this.get(key); + try + { + return object instanceof Number ? ((Number) object).intValue() : Integer.parseInt((String) object); + } catch(Exception e) + { + throw new JSONException("JSONObject[" + quote(key) + "] is not an int."); + } + } + + /** + * 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 getJSONArray(String key) throws JSONException + { + Object object = this.get(key); + if(object instanceof JSONArray) + { + return (JSONArray) object; + } + throw new JSONException("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 getJSONObject(String key) throws JSONException + { + Object object = this.get(key); + if(object instanceof JSONObject) + { + return (JSONObject) object; + } + throw new JSONException("JSONObject[" + quote(key) + "] is not a JSONObject."); + } + + /** + * 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 getLong(String key) throws JSONException + { + Object object = this.get(key); + try + { + return object instanceof Number ? ((Number) object).longValue() : Long.parseLong((String) object); + } catch(Exception e) + { + throw new JSONException("JSONObject[" + quote(key) + "] is not a long."); + } + } + + /** + * 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] = 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; + } + + /** + * 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 getString(String key) throws JSONException + { + Object object = this.get(key); + if(object instanceof String) + { + return (String) object; + } + throw new JSONException("JSONObject[" + quote(key) + "] not a string."); + } + + /** + * Determine if the JSONObject contains a specific key. + * + * @param key + * A key string. + * @return true if the key exists in the JSONObject. + */ + public boolean has(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 JSONObject increment(String key) throws JSONException + { + Object value = this.opt(key); + if(value == null) + { + this.put(key, 1); + } else if(value instanceof BigInteger) + { + this.put(key, ((BigInteger) value).add(BigInteger.ONE)); + } else if(value instanceof BigDecimal) + { + this.put(key, ((BigDecimal) value).add(BigDecimal.ONE)); + } else if(value instanceof Integer) + { + this.put(key, (Integer) value + 1); + } else if(value instanceof Long) + { + this.put(key, (Long) value + 1); + } else if(value instanceof Double) + { + this.put(key, (Double) value + 1); + } else if(value instanceof Float) + { + this.put(key, (Float) value + 1); + } else + { + throw new JSONException("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. + */ + public boolean isNull(String key) + { + return JSONObject.NULL.equals(this.opt(key)); + } + + /** + * Get an enumeration of the keys of the JSONObject. + * + * @return An iterator of the keys. + */ + public Iterator keys() + { + return this.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 length() + { + 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.put(keys.next()); + } + return ja.length() == 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. + */ + public static String numberToString(Number number) throws JSONException + { + if(number == null) + { + throw new JSONException("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. + */ + public Object opt(String key) + { + return key == null ? null : this.map.get(key); + } + + /** + * Get the enum value associated with a key. + * + * @param clazz + * The type of enum to retrieve. + * @param key + * A key string. + * @return The enum value associated with the key or null if not found + */ + public > E optEnum(Class clazz, String key) + { + return this.optEnum(clazz, key, null); + } + + /** + * Get the enum value associated with a key. + * + * @param clazz + * The type of enum to retrieve. + * @param key + * A key string. + * @param defaultValue + * The default in case the value is not found + * @return The enum value associated with the key or defaultValue if the + * value is not found or cannot be assigned to clazz + */ + public > E optEnum(Class clazz, String key, E defaultValue) + { + try + { + Object val = this.opt(key); + if(NULL.equals(val)) + { + return defaultValue; + } + if(clazz.isAssignableFrom(val.getClass())) + { + // we just checked it! + @SuppressWarnings("unchecked") + E myE = (E) val; + return myE; + } + return Enum.valueOf(clazz, val.toString()); + } + + catch(IllegalArgumentException e) + { + return defaultValue; + } + + catch(NullPointerException e) + { + return defaultValue; + } + } + + /** + * 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. + */ + public 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. + */ + public 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. + */ + public double optDouble(String key) + { + return this.optDouble(key, Double.NaN); + } + + /** + * Get an optional BigInteger associated with a key, or the defaultValue if + * there is no such key or if its value is not a number. 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 BigInteger optBigInteger(String key, BigInteger defaultValue) + { + try + { + return this.getBigInteger(key); + } catch(Exception e) + { + return defaultValue; + } + } + + /** + * Get an optional BigDecimal associated with a key, or the defaultValue if + * there is no such key or if its value is not a number. 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 BigDecimal optBigDecimal(String key, BigDecimal defaultValue) + { + try + { + return this.getBigDecimal(key); + } catch(Exception e) + { + return 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. + * + * @param key + * A key string. + * @param defaultValue + * The default. + * @return An object which is the value. + */ + public 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. + */ + public 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. + */ + public 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. + */ + public 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. + */ + public 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) + { + } + } + } + + /** + * 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 put(String key, boolean value) throws JSONException + { + this.put(key, value ? Boolean.TRUE : Boolean.FALSE); + return this; + } + + /** + * 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) throws JSONException + { + this.put(key, new JSONArray(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 put(String key, double value) throws JSONException + { + this.put(key, new Double(value)); + return this; + } + + /** + * 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 put(String key, int value) throws JSONException + { + this.put(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 put(String key, long value) throws JSONException + { + this.put(key, new Long(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, Map value) throws JSONException + { + 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. + */ + public JSONObject put(String key, Object value) throws JSONException + { + if(key == null) + { + throw new NullPointerException("Null key."); + } + if(value != null) + { + testValidity(value); + 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 + * string + * @param value + * object + * @return this. + * @throws JSONException + * if the key is a duplicate + */ + public JSONObject putOnce(String key, Object value) throws JSONException + { + if(key != null && value != null) + { + if(this.opt(key) != null) + { + throw new JSONException("Duplicate key \"" + key + "\""); + } + this.put(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) throws JSONException + { + 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); + } + + /** + * Determine if two JSONObjects are similar. They must contain the same set + * of names which must be associated with similar values. + * + * @param other + * The other JSONObject + * @return true if they are equal + */ + public boolean similar(Object other) + { + try + { + if(!(other instanceof JSONObject)) + { + return false; + } + Set set = this.keySet(); + if(!set.equals(((JSONObject) other).keySet())) + { + return false; + } + Iterator iterator = set.iterator(); + while(iterator.hasNext()) + { + String name = iterator.next(); + Object valueThis = this.get(name); + Object valueOther = ((JSONObject) other).get(name); + if(valueThis instanceof JSONObject) + { + if(!((JSONObject) valueThis).similar(valueOther)) + { + return false; + } + } else if(valueThis instanceof JSONArray) + { + if(!((JSONArray) valueThis).similar(valueOther)) + { + return false; + } + } else if(!valueThis.equals(valueOther)) + { + return false; + } + } + return true; + } catch(Throwable exception) + { + return false; + } + } + + /** + * 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. + */ + public static 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. + */ + + char b = string.charAt(0); + if((b >= '0' && b <= '9') || 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(string.equals(myLong.toString())) + { + if(myLong == myLong.intValue()) + { + return 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. + */ + public static void testValidity(Object o) throws JSONException + { + if(o != null) + { + if(o instanceof Double) + { + if(((Double) o).isInfinite() || ((Double) o).isNaN()) + { + throw new JSONException("JSON does not allow non-finite numbers."); + } + } else if(o instanceof Float) + { + if(((Float) o).isInfinite() || ((Float) o).isNaN()) + { + throw new JSONException("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) throws JSONException + { + if(names == null || names.length() == 0) + { + return null; + } + JSONArray ja = new JSONArray(); + for(int i = 0; i < names.length(); i += 1) + { + ja.put(this.opt(names.getString(i))); + } + return ja; + } + + /** + * 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. + * + * @return a printable, displayable, portable, transmittable representation + * of the object, beginning with { (left + * brace) and ending with } (right + * brace). + */ + public String toString() + { + try + { + return this.toString(0); + } 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 toString(int indentFactor) throws JSONException + { + 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. + */ + public static String valueToString(Object value) throws JSONException + { + if(value == null || value.equals(null)) + { + return "null"; + } + if(value instanceof JSONString) + { + Object object; + try + { + object = ((JSONString) value).toJSONString(); + } catch(Exception e) + { + throw new JSONException(e); + } + if(object instanceof String) + { + return (String) object; + } + throw new JSONException("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) + { + @SuppressWarnings("unchecked") + Map map = (Map) value; + return new JSONObject(map).toString(); + } + if(value instanceof Collection) + { + @SuppressWarnings("unchecked") + Collection coll = (Collection) value; + return new JSONArray(coll).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 + */ + public static 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 || object instanceof BigInteger || object instanceof BigDecimal) + { + return object; + } + + if(object instanceof Collection) + { + @SuppressWarnings("unchecked") + Collection coll = (Collection) object; + return new JSONArray(coll); + } + if(object.getClass().isArray()) + { + return new JSONArray(object); + } + if(object instanceof Map) + { + @SuppressWarnings("unchecked") + Map map = (Map) object; + return new JSONObject(map); + } + 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 + */ + public Writer write(Writer writer) throws JSONException + { + return this.write(writer, 0, 0); + } + + static final Writer writeValue(Writer writer, Object value, int indentFactor, int indent) throws JSONException, 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) + { + @SuppressWarnings("unchecked") + Map map = (Map) value; + new JSONObject(map).write(writer, indentFactor, indent); + } else if(value instanceof Collection) + { + @SuppressWarnings("unchecked") + Collection coll = (Collection) value; + new JSONArray(coll).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 JSONException(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 + */ + Writer write(Writer writer, int indentFactor, int indent) throws JSONException + { + try + { + boolean commanate = false; + final int length = this.length(); + Iterator keys = this.keys(); + writer.write('{'); + + if(length == 1) + { + Object key = keys.next(); + writer.write(quote(key.toString())); + writer.write(':'); + if(indentFactor > 0) + { + writer.write(' '); + } + writeValue(writer, this.map.get(key), indentFactor, indent); + } else if(length != 0) + { + final int newindent = indent + indentFactor; + while(keys.hasNext()) + { + Object key = keys.next(); + if(commanate) + { + writer.write(','); + } + if(indentFactor > 0) + { + writer.write('\n'); + } + indent(writer, newindent); + writer.write(quote(key.toString())); + writer.write(':'); + if(indentFactor > 0) + { + writer.write(' '); + } + writeValue(writer, this.map.get(key), indentFactor, newindent); + commanate = true; + } + if(indentFactor > 0) + { + writer.write('\n'); + } + indent(writer, indent); + } + writer.write('}'); + return writer; + } catch(IOException exception) + { + throw new JSONException(exception); + } + } +} diff --git a/json/JSONString.java b/json/JSONString.java new file mode 100644 index 000000000..2d586aa8b --- /dev/null +++ b/json/JSONString.java @@ -0,0 +1,21 @@ +package ninja.bytecode.shuriken.json; + + +/** + * 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. + */ +public interface JSONString +{ + /** + * The toJSONString method allows a class to produce its own + * JSON serialization. + * + * @return A strictly syntactically correct JSON text. + */ + public String toJSONString(); +} diff --git a/json/JSONStringer.java b/json/JSONStringer.java new file mode 100644 index 000000000..0ab4a4d29 --- /dev/null +++ b/json/JSONStringer.java @@ -0,0 +1,86 @@ +package ninja.bytecode.shuriken.json; + + +/* +Copyright (c) 2006 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. +*/ + +import java.io.StringWriter; + +/** + * 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, + * + *

+ * myString = new JSONStringer().object().key("JSON").value("Hello, World!").endObject().toString();
+ * 
+ * + * which produces the string + * + *
+ * {"JSON":"Hello, World!"}
+ * 
+ *

+ * 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. + * + * @author JSON.org + * @version 2008-09-18 + */ +public class JSONStringer extends JSONWriter +{ + /** + * Make a fresh JSONStringer. It can be used to build one JSON text. + */ + public JSONStringer() + { + super(new StringWriter()); + } + + /** + * 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). + * + * @return The JSON text. + */ + public String toString() + { + return this.mode == 'd' ? this.writer.toString() : null; + } +} diff --git a/json/JSONTokener.java b/json/JSONTokener.java new file mode 100644 index 000000000..e3f49f50a --- /dev/null +++ b/json/JSONTokener.java @@ -0,0 +1,504 @@ +package ninja.bytecode.shuriken.json; + + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.StringReader; + +/* +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 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 + * @version 2014-05-03 + */ +public 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. + * + * @param inputStream + * The source. + */ + public JSONTokener(InputStream inputStream) throws JSONException + { + 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() throws JSONException + { + if(this.usePrevious || this.index <= 0) + { + throw new JSONException("Stepping back two steps is not supported"); + } + this.index -= 1; + this.character -= 1; + this.usePrevious = true; + this.eof = false; + } + + /** + * 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. + */ + public static 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; + } + + 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() throws JSONException + { + 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() throws JSONException + { + int c; + if(this.usePrevious) + { + this.usePrevious = false; + c = this.previous; + } else + { + try + { + c = this.reader.read(); + } catch(IOException exception) + { + throw new JSONException(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) throws JSONException + { + char n = this.next(); + if(n != c) + { + throw this.syntaxError("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) throws JSONException + { + if(n == 0) + { + return ""; + } + + char[] chars = new char[n]; + int pos = 0; + + while(pos < n) + { + chars[pos] = this.next(); + if(this.end()) + { + throw this.syntaxError("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() throws JSONException + { + 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) throws JSONException + { + char c; + StringBuilder sb = new StringBuilder(); + for(;;) + { + c = this.next(); + switch(c) + { + case 0: + case '\n': + case '\r': + throw this.syntaxError("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 this.syntaxError("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) throws JSONException + { + StringBuilder sb = new StringBuilder(); + 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) throws JSONException + { + char c; + StringBuilder sb = new StringBuilder(); + 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() throws JSONException + { + 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. + */ + + StringBuilder sb = new StringBuilder(); + while(c >= ' ' && ",:]}/\\\"[{;=#".indexOf(c) < 0) + { + sb.append(c); + c = this.next(); + } + this.back(); + + string = sb.toString().trim(); + if("".equals(string)) + { + throw this.syntaxError("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) throws JSONException + { + 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 exception) + { + throw new JSONException(exception); + } + this.back(); + return c; + } + + /** + * Make a JSONException to signal a syntax error. + * + * @param message + * The error message. + * @return A JSONException object, suitable for throwing + */ + public JSONException syntaxError(String message) + { + return new JSONException(message + this.toString()); + } + + /** + * Make a printable string of this JSONTokener. + * + * @return " at {index} [character {character} line {line}]" + */ + public String toString() + { + return " at " + this.index + " [character " + this.character + " line " + this.line + "]"; + } +} diff --git a/json/JSONWriter.java b/json/JSONWriter.java new file mode 100644 index 000000000..1b3139754 --- /dev/null +++ b/json/JSONWriter.java @@ -0,0 +1,388 @@ +package ninja.bytecode.shuriken.json; + + +import java.io.IOException; +import java.io.Writer; + +/* +Copyright (c) 2006 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. +*/ + +/** + * 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, + * + *

+ * new JSONWriter(myWriter).object().key("JSON").value("Hello, World!").endObject();
+ * 
+ * + * which writes + * + *
+ * {"JSON":"Hello, World!"}
+ * 
+ *

+ * 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 + * @version 2011-11-24 + */ +public class JSONWriter +{ + private static final int maxdepth = 200; + + /** + * The comma flag determines if a comma should be output before the next + * value. + */ + private boolean comma; + + /** + * The current mode. Values: 'a' (array), 'd' (done), 'i' (initial), 'k' + * (key), 'o' (object). + */ + protected char mode; + + /** + * The object/array stack. + */ + private final JSONObject stack[]; + + /** + * The stack top index. A value of 0 indicates that the stack is empty. + */ + private int top; + + /** + * The writer that will receive the output. + */ + protected Writer writer; + + /** + * Make a fresh JSONWriter. It can be used to build one JSON text. + */ + public JSONWriter(Writer w) + { + this.comma = false; + this.mode = 'i'; + this.stack = new JSONObject[maxdepth]; + this.top = 0; + this.writer = w; + } + + /** + * Append a value. + * + * @param string + * A string value. + * @return this + * @throws JSONException + * If the value is out of sequence. + */ + private JSONWriter append(String string) throws JSONException + { + if(string == null) + { + throw new JSONException("Null pointer"); + } + if(this.mode == 'o' || this.mode == 'a') + { + try + { + if(this.comma && this.mode == 'a') + { + this.writer.write(','); + } + this.writer.write(string); + } catch(IOException e) + { + throw new JSONException(e); + } + if(this.mode == 'o') + { + this.mode = 'k'; + } + this.comma = true; + return this; + } + throw new JSONException("Value out of sequence."); + } + + /** + * 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. + * + * @return 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 JSONWriter array() throws JSONException + { + if(this.mode == 'i' || this.mode == 'o' || this.mode == 'a') + { + this.push(null); + this.append("["); + this.comma = false; + return this; + } + throw new JSONException("Misplaced array."); + } + + /** + * End something. + * + * @param mode + * Mode + * @param c + * Closing character + * @return this + * @throws JSONException + * If unbalanced. + */ + private JSONWriter end(char mode, char c) throws JSONException + { + if(this.mode != mode) + { + throw new JSONException(mode == 'a' ? "Misplaced endArray." : "Misplaced endObject."); + } + this.pop(mode); + try + { + this.writer.write(c); + } catch(IOException e) + { + throw new JSONException(e); + } + this.comma = true; + return this; + } + + /** + * End an array. This method most be called to balance calls to + * array. + * + * @return this + * @throws JSONException + * If incorrectly nested. + */ + public JSONWriter endArray() throws JSONException + { + return this.end('a', ']'); + } + + /** + * End an object. This method most be called to balance calls to + * object. + * + * @return this + * @throws JSONException + * If incorrectly nested. + */ + public JSONWriter endObject() throws JSONException + { + return this.end('k', '}'); + } + + /** + * Append a key. The key will be associated with the next value. In an + * object, every value must be preceded by a key. + * + * @param string + * A key string. + * @return this + * @throws JSONException + * If the key is out of place. For example, keys do not belong + * in arrays or if the key is null. + */ + public JSONWriter key(String string) throws JSONException + { + if(string == null) + { + throw new JSONException("Null key."); + } + if(this.mode == 'k') + { + try + { + this.stack[this.top - 1].putOnce(string, Boolean.TRUE); + if(this.comma) + { + this.writer.write(','); + } + this.writer.write(JSONObject.quote(string)); + this.writer.write(':'); + this.comma = false; + this.mode = 'o'; + return this; + } catch(IOException e) + { + throw new JSONException(e); + } + } + throw new JSONException("Misplaced key."); + } + + /** + * 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. + * + * @return 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 JSONWriter object() throws JSONException + { + if(this.mode == 'i') + { + this.mode = 'o'; + } + if(this.mode == 'o' || this.mode == 'a') + { + this.append("{"); + this.push(new JSONObject()); + this.comma = false; + return this; + } + throw new JSONException("Misplaced object."); + + } + + /** + * Pop an array or object scope. + * + * @param c + * The scope to close. + * @throws JSONException + * If nesting is wrong. + */ + private void pop(char c) throws JSONException + { + if(this.top <= 0) + { + throw new JSONException("Nesting error."); + } + char m = this.stack[this.top - 1] == null ? 'a' : 'k'; + if(m != c) + { + throw new JSONException("Nesting error."); + } + this.top -= 1; + this.mode = this.top == 0 ? 'd' : this.stack[this.top - 1] == null ? 'a' : 'k'; + } + + /** + * Push an array or object scope. + * + * @param jo + * The scope to open. + * @throws JSONException + * If nesting is too deep. + */ + private void push(JSONObject jo) throws JSONException + { + if(this.top >= maxdepth) + { + throw new JSONException("Nesting too deep."); + } + this.stack[this.top] = jo; + this.mode = jo == null ? 'a' : 'k'; + this.top += 1; + } + + /** + * Append either the value true or the value false + * . + * + * @param b + * A boolean. + * @return this + * @throws JSONException + */ + public JSONWriter value(boolean b) throws JSONException + { + return this.append(b ? "true" : "false"); + } + + /** + * Append a double value. + * + * @param d + * A double. + * @return this + * @throws JSONException + * If the number is not finite. + */ + public JSONWriter value(double d) throws JSONException + { + return this.value(new Double(d)); + } + + /** + * Append a long value. + * + * @param l + * A long. + * @return this + * @throws JSONException + */ + public JSONWriter value(long l) throws JSONException + { + return this.append(Long.toString(l)); + } + + /** + * Append an object value. + * + * @param object + * The object to append. It can be null, or a Boolean, Number, + * String, JSONObject, or JSONArray, or an object that implements + * JSONString. + * @return this + * @throws JSONException + * If the value is out of sequence. + */ + public JSONWriter value(Object object) throws JSONException + { + return this.append(JSONObject.valueToString(object)); + } +} diff --git a/json/XML.java b/json/XML.java new file mode 100644 index 000000000..26669dcda --- /dev/null +++ b/json/XML.java @@ -0,0 +1,584 @@ +package ninja.bytecode.shuriken.json; + + +/* +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. +*/ + +import java.util.Iterator; + +/** + * This provides static methods to convert an XML text into a JSONObject, and to + * covert a JSONObject into an XML text. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class XML +{ + + /** The Character '&'. */ + public static final Character AMP = '&'; + + /** The Character '''. */ + public static final Character APOS = '\''; + + /** The Character '!'. */ + public static final Character BANG = '!'; + + /** The Character '='. */ + public static final Character EQ = '='; + + /** The Character '>'. */ + public static final Character GT = '>'; + + /** The Character '<'. */ + public static final Character LT = '<'; + + /** The Character '?'. */ + public static final Character QUEST = '?'; + + /** The Character '"'. */ + public static final Character QUOT = '"'; + + /** The Character '/'. */ + public static final Character SLASH = '/'; + + /** + * Replace special characters with XML escapes: + * + *

+	 * & (ampersand) is replaced by &amp;
+	 * < (less than) is replaced by &lt;
+	 * > (greater than) is replaced by &gt;
+	 * " (double quote) is replaced by &quot;
+	 * 
+ * + * @param string + * The string to be escaped. + * @return The escaped string. + */ + public static String escape(String string) + { + StringBuilder sb = new StringBuilder(string.length()); + for(int i = 0, length = string.length(); i < length; i++) + { + char c = string.charAt(i); + switch(c) + { + case '&': + sb.append("&"); + break; + case '<': + sb.append("<"); + break; + case '>': + sb.append(">"); + break; + case '"': + sb.append("""); + break; + case '\'': + sb.append("'"); + break; + default: + sb.append(c); + } + } + return sb.toString(); + } + + /** + * Throw an exception if the string contains whitespace. Whitespace is not + * allowed in tagNames and attributes. + * + * @param string + * A string. + * @throws JSONException + */ + public static void noSpace(String string) throws JSONException + { + int i, length = string.length(); + if(length == 0) + { + throw new JSONException("Empty string."); + } + for(i = 0; i < length; i += 1) + { + if(Character.isWhitespace(string.charAt(i))) + { + throw new JSONException("'" + string + "' contains a space character."); + } + } + } + + /** + * Scan the content following the named tag, attaching it to the context. + * + * @param x + * The XMLTokener containing the source string. + * @param context + * The JSONObject that will include the new material. + * @param name + * The tag name. + * @return true if the close tag is processed. + * @throws JSONException + */ + private static boolean parse(XMLTokener x, JSONObject context, String name) throws JSONException + { + char c; + int i; + JSONObject jsonobject = null; + String string; + String tagName; + Object token; + + // Test for and skip past these forms: + // + // + // + // + // Report errors for these forms: + // <> + // <= + // << + + token = x.nextToken(); + + // "); + return false; + } + x.back(); + } else if(c == '[') + { + token = x.nextToken(); + if("CDATA".equals(token)) + { + if(x.next() == '[') + { + string = x.nextCDATA(); + if(string.length() > 0) + { + context.accumulate("content", string); + } + return false; + } + } + throw x.syntaxError("Expected 'CDATA['"); + } + i = 1; + do + { + token = x.nextMeta(); + if(token == null) + { + throw x.syntaxError("Missing '>' after ' 0); + return false; + } else if(token == QUEST) + { + + // "); + return false; + } else if(token == SLASH) + { + + // Close tag + + } else if(token == SLASH) + { + if(x.nextToken() != GT) + { + throw x.syntaxError("Misshaped tag"); + } + if(jsonobject.length() > 0) + { + context.accumulate(tagName, jsonobject); + } else + { + context.accumulate(tagName, ""); + } + return false; + + // Content, between <...> and + + } else if(token == GT) + { + for(;;) + { + token = x.nextContent(); + if(token == null) + { + if(tagName != null) + { + throw x.syntaxError("Unclosed tag " + tagName); + } + return false; + } else if(token instanceof String) + { + string = (String) token; + if(string.length() > 0) + { + jsonobject.accumulate("content", XML.stringToValue(string)); + } + + // Nested element + + } else if(token == LT) + { + if(parse(x, jsonobject, tagName)) + { + if(jsonobject.length() == 0) + { + context.accumulate(tagName, ""); + } else if(jsonobject.length() == 1 && jsonobject.opt("content") != null) + { + context.accumulate(tagName, jsonobject.opt("content")); + } else + { + context.accumulate(tagName, jsonobject); + } + return false; + } + } + } + } else + { + throw x.syntaxError("Misshaped tag"); + } + } + } + } + + /** + * 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. + * + * @param string + * A String. + * @return A simple JSON value. + */ + public static Object stringToValue(String string) + { + if("true".equalsIgnoreCase(string)) + { + return Boolean.TRUE; + } + if("false".equalsIgnoreCase(string)) + { + return Boolean.FALSE; + } + if("null".equalsIgnoreCase(string)) + { + return JSONObject.NULL; + } + + // If it might be a number, try converting it, first as a Long, and then + // as a + // Double. If that doesn't work, return the string. + + try + { + char initial = string.charAt(0); + if(initial == '-' || (initial >= '0' && initial <= '9')) + { + Long value = new Long(string); + if(value.toString().equals(string)) + { + return value; + } + } + } catch(Exception ignore) + { + try + { + Double value = new Double(string); + if(value.toString().equals(string)) + { + return value; + } + } catch(Exception ignoreAlso) + { + } + } + return 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. + * + * @param string + * The source string. + * @return A JSONObject containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException + { + JSONObject jo = new JSONObject(); + XMLTokener x = new XMLTokener(string); + while(x.more() && x.skipPast("<")) + { + parse(x, jo, null); + } + return jo; + } + + /** + * Convert a JSONObject into a well-formed, element-normal XML string. + * + * @param object + * A JSONObject. + * @return A string. + * @throws JSONException + */ + public static String toString(Object object) throws JSONException + { + return toString(object, null); + } + + /** + * Convert a JSONObject into a well-formed, element-normal XML string. + * + * @param object + * A JSONObject. + * @param tagName + * The optional name of the enclosing tag. + * @return A string. + * @throws JSONException + */ + public static String toString(Object object, String tagName) throws JSONException + { + StringBuilder sb = new StringBuilder(); + int i; + JSONArray ja; + JSONObject jo; + String key; + Iterator keys; + int length; + String string; + Object value; + if(object instanceof JSONObject) + { + + // Emit + + if(tagName != null) + { + sb.append('<'); + sb.append(tagName); + sb.append('>'); + } + + // Loop thru the keys. + + jo = (JSONObject) object; + keys = jo.keys(); + while(keys.hasNext()) + { + key = keys.next(); + value = jo.opt(key); + if(value == null) + { + value = ""; + } + string = value instanceof String ? (String) value : null; + + // Emit content in body + + if("content".equals(key)) + { + if(value instanceof JSONArray) + { + ja = (JSONArray) value; + length = ja.length(); + for(i = 0; i < length; i += 1) + { + if(i > 0) + { + sb.append('\n'); + } + sb.append(escape(ja.get(i).toString())); + } + } else + { + sb.append(escape(value.toString())); + } + + // Emit an array of similar keys + + } else if(value instanceof JSONArray) + { + ja = (JSONArray) value; + length = ja.length(); + for(i = 0; i < length; i += 1) + { + value = ja.get(i); + if(value instanceof JSONArray) + { + sb.append('<'); + sb.append(key); + sb.append('>'); + sb.append(toString(value)); + sb.append("'); + } else + { + sb.append(toString(value, key)); + } + } + } else if("".equals(value)) + { + sb.append('<'); + sb.append(key); + sb.append("/>"); + + // Emit a new tag + + } else + { + sb.append(toString(value, key)); + } + } + if(tagName != null) + { + + // Emit the close tag + + sb.append("'); + } + return sb.toString(); + + // XML does not have good support for arrays. If an array appears in + // a place + // where XML is lacking, synthesize an element. + + } else + { + if(object.getClass().isArray()) + { + object = new JSONArray(object); + } + if(object instanceof JSONArray) + { + ja = (JSONArray) object; + length = ja.length(); + for(i = 0; i < length; i += 1) + { + sb.append(toString(ja.opt(i), tagName == null ? "array" : tagName)); + } + return sb.toString(); + } else + { + string = (object == null) ? "null" : escape(object.toString()); + return (tagName == null) ? "\"" + string + "\"" : (string.length() == 0) ? "<" + tagName + "/>" : "<" + tagName + ">" + string + ""; + } + } + } +} diff --git a/json/XMLTokener.java b/json/XMLTokener.java new file mode 100644 index 000000000..c69618146 --- /dev/null +++ b/json/XMLTokener.java @@ -0,0 +1,425 @@ +package ninja.bytecode.shuriken.json; + + +/* +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. +*/ + +/** + * The XMLTokener extends the JSONTokener to provide additional methods for the + * parsing of XML texts. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class XMLTokener extends JSONTokener +{ + + /** + * The table of entity values. It initially contains Character values for + * amp, apos, gt, lt, quot. + */ + public static final java.util.HashMap entity; + + static + { + entity = new java.util.HashMap(8); + entity.put("amp", XML.AMP); + entity.put("apos", XML.APOS); + entity.put("gt", XML.GT); + entity.put("lt", XML.LT); + entity.put("quot", XML.QUOT); + } + + /** + * Construct an XMLTokener from a string. + * + * @param s + * A source string. + */ + public XMLTokener(String s) + { + super(s); + } + + /** + * Get the text in the CDATA block. + * + * @return The string up to the ]]>. + * @throws JSONException + * If the ]]> is not found. + */ + public String nextCDATA() throws JSONException + { + char c; + int i; + StringBuilder sb = new StringBuilder(); + for(;;) + { + c = next(); + if(end()) + { + throw syntaxError("Unclosed CDATA"); + } + sb.append(c); + i = sb.length() - 3; + if(i >= 0 && sb.charAt(i) == ']' && sb.charAt(i + 1) == ']' && sb.charAt(i + 2) == '>') + { + sb.setLength(i); + return sb.toString(); + } + } + } + + /** + * 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. + * + * @return A string, or a '<' Character, or null if there is no more source + * text. + * @throws JSONException + */ + public Object nextContent() throws JSONException + { + char c; + StringBuilder sb; + do + { + c = next(); + } while(Character.isWhitespace(c)); + if(c == 0) + { + return null; + } + if(c == '<') + { + return XML.LT; + } + sb = new StringBuilder(); + for(;;) + { + if(c == '<' || c == 0) + { + back(); + return sb.toString().trim(); + } + if(c == '&') + { + sb.append(nextEntity(c)); + } else + { + sb.append(c); + } + c = next(); + } + } + + /** + * Return the next entity. These entities are translated to Characters: + * & ' > < ". + * + * @param ampersand + * An ampersand character. + * @return A Character or an entity String if the entity is not recognized. + * @throws JSONException + * If missing ';' in XML entity. + */ + public Object nextEntity(char ampersand) throws JSONException + { + StringBuilder sb = new StringBuilder(); + for(;;) + { + char c = next(); + if(Character.isLetterOrDigit(c) || c == '#') + { + sb.append(Character.toLowerCase(c)); + } else if(c == ';') + { + break; + } else + { + throw syntaxError("Missing ';' in XML entity: &" + sb); + } + } + String string = sb.toString(); + Object object = entity.get(string); + return object != null ? object : ampersand + string + ";"; + } + + /** + * Returns the next XML meta token. This is used for skipping over + * and structures. + * + * @return 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 Object nextMeta() throws JSONException + { + char c; + char q; + do + { + c = next(); + } while(Character.isWhitespace(c)); + switch(c) + { + case 0: + throw syntaxError("Misshaped meta tag"); + case '<': + return XML.LT; + case '>': + return XML.GT; + case '/': + return XML.SLASH; + case '=': + return XML.EQ; + case '!': + return XML.BANG; + case '?': + return XML.QUEST; + case '"': + case '\'': + q = c; + for(;;) + { + c = next(); + if(c == 0) + { + throw syntaxError("Unterminated string"); + } + if(c == q) + { + return Boolean.TRUE; + } + } + default: + for(;;) + { + c = next(); + if(Character.isWhitespace(c)) + { + return Boolean.TRUE; + } + switch(c) + { + case 0: + case '<': + case '>': + case '/': + case '=': + case '!': + case '?': + case '"': + case '\'': + back(); + return Boolean.TRUE; + } + } + } + } + + /** + * 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. + * + * @return a String or a Character. + * @throws JSONException + * If the XML is not well formed. + */ + public Object nextToken() throws JSONException + { + char c; + char q; + StringBuilder sb; + do + { + c = next(); + } while(Character.isWhitespace(c)); + switch(c) + { + case 0: + throw syntaxError("Misshaped element"); + case '<': + throw syntaxError("Misplaced '<'"); + case '>': + return XML.GT; + case '/': + return XML.SLASH; + case '=': + return XML.EQ; + case '!': + return XML.BANG; + case '?': + return XML.QUEST; + + // Quoted string + + case '"': + case '\'': + q = c; + sb = new StringBuilder(); + for(;;) + { + c = next(); + if(c == 0) + { + throw syntaxError("Unterminated string"); + } + if(c == q) + { + return sb.toString(); + } + if(c == '&') + { + sb.append(nextEntity(c)); + } else + { + sb.append(c); + } + } + default: + + // Name + + sb = new StringBuilder(); + for(;;) + { + sb.append(c); + c = next(); + if(Character.isWhitespace(c)) + { + return sb.toString(); + } + switch(c) + { + case 0: + return sb.toString(); + case '>': + case '/': + case '=': + case '!': + case '?': + case '[': + case ']': + back(); + return sb.toString(); + case '<': + case '"': + case '\'': + throw syntaxError("Bad character in a name"); + } + } + } + } + + /** + * Skip characters until past the requested string. If it is not found, we + * are left at the end of the source with a result of false. + * + * @param to + * A string to skip past. + * @throws JSONException + */ + public boolean skipPast(String to) throws JSONException + { + boolean b; + char c; + int i; + int j; + int offset = 0; + int length = to.length(); + char[] circle = new char[length]; + + /* + * First fill the circle buffer with as many characters as are in the to + * string. If we reach an early end, bail. + */ + + for(i = 0; i < length; i += 1) + { + c = next(); + if(c == 0) + { + return false; + } + circle[i] = c; + } + + /* We will loop, possibly for all of the remaining characters. */ + + for(;;) + { + j = offset; + b = true; + + /* Compare the circle buffer with the to string. */ + + for(i = 0; i < length; i += 1) + { + if(circle[j] != to.charAt(i)) + { + b = false; + break; + } + j += 1; + if(j >= length) + { + j -= length; + } + } + + /* If we exit the loop with b intact, then victory is ours. */ + + if(b) + { + return true; + } + + /* + * Get the next character. If there isn't one, then defeat is ours. + */ + + c = next(); + if(c == 0) + { + return false; + } + /* + * Shove the character in the circle buffer and advance the circle + * offset. The offset is mod n. + */ + circle[offset] = c; + offset += 1; + if(offset >= length) + { + offset -= length; + } + } + } +}