| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
* 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: *
* 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. *
* Methods that are static, return void, * have parameters, or are "bridge" methods, are ignored. *
* 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". *
* The {@link JSONPropertyName} annotation can be used on a bean getter to * override key name used in the JSONObject. For example, using the object * above with the getName method, if we annotated it with: *
* @JSONPropertyName("FullName")
* public String getName() { return this.name; }
*
* The resulting JSON object would contain "FullName": "Larry Fine"
* * Similarly, the {@link JSONPropertyName} annotation can be used on non- * get and is methods. We can also override key * name used in the JSONObject as seen below even though the field would normally * be ignored: *
* @JSONPropertyName("FullName")
* public String fullName() { return this.name; }
*
* The resulting JSON object would contain "FullName": "Larry Fine"
* * The {@link JSONPropertyIgnore} annotation can be used to force the bean property * to not be serialized into JSON. If both {@link JSONPropertyIgnore} and * {@link JSONPropertyName} are defined on the same method, a depth comparison is * performed and the one closest to the concrete class being serialized is used. * If both annotations are at the same level, then the {@link JSONPropertyIgnore} * annotation takes precedent and the field is not serialized. * For example, the following declaration would prevent the getName * method from being serialized: *
* @JSONPropertyName("FullName")
* @JSONPropertyIgnore
* public String getName() { return this.name; }
*
* * * @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(names.length); 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)); } } } /** * Constructor to specify an initial capacity of the internal map. Useful for library * internal calls where we know, or at least can best guess, how big this JSONObject * will be. * * @param initialCapacity initial capacity of the internal map. */ protected JSONObject(int initialCapacity){ this.map = new HashMap(initialCapacity); } /** * 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 non-finite number. * @throws NullPointerException * 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 value is non-finite number or if the current value associated with * the key is not a JSONArray. * @throws NullPointerException * If the key is null. */ 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.", e); } } /** * 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); if (object instanceof BigDecimal) { return (BigDecimal)object; } try { return new BigDecimal(object.toString()); } catch (Exception e) { throw new JSONException("JSONObject[" + quote(key) + "] could not be converted to BigDecimal.", e); } } /** * 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(object.toString()); } catch (Exception e) { throw new JSONException("JSONObject[" + quote(key) + "] is not a number.", e); } } /** * Get the float 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 float getFloat(String key) throws JSONException { Object object = this.get(key); try { return object instanceof Number ? ((Number) object).floatValue() : Float.parseFloat(object.toString()); } catch (Exception e) { throw new JSONException("JSONObject[" + quote(key) + "] is not a number.", e); } } /** * Get the Number 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 Number getNumber(String key) throws JSONException { Object object = this.get(key); try { if (object instanceof Number) { return (Number)object; } return stringToNumber(object.toString()); } catch (Exception e) { throw new JSONException("JSONObject[" + quote(key) + "] is not a number.", e); } } /** * 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.", e); } } /** * 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.", e); } } /** * 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) { if (jo.isEmpty()) { return null; } return jo.keySet().toArray(new String[jo.length()]); } /** * 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).intValue() + 1); } else if (value instanceof Long) { this.put(key, ((Long) value).longValue() + 1L); } else if (value instanceof Double) { this.put(key, ((Double) value).doubleValue() + 1.0d); } else if (value instanceof Float) { this.put(key, ((Float) value).floatValue() + 1.0f); } 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. Modifying this key Set will also * modify the JSONObject. Use with caution. * * @see Set#iterator() * * @return An iterator of the keys. */ public Iterator keys() { return this.keySet().iterator(); } /** * Get a set of keys of the JSONObject. Modifying this key Set will also modify the * JSONObject. Use with caution. * * @see Map#keySet() * * @return A keySet. */ public Set keySet() { return this.map.keySet(); } /** * Get a set of entries of the JSONObject. These are raw values and may not * match what is returned by the JSONObject get* and opt* functions. Modifying * the returned EntrySet or the Entry objects contained therein will modify the * backing JSONObject. This does not return a clone or a read-only view. * * Use with caution. * * @see Map#entrySet() * * @return An Entry Set */ protected Set entrySet() { return this.map.entrySet(); } /** * Get the number of keys stored in the JSONObject. * * @return The number of keys in the JSONObject. */ public int length() { return this.map.size(); } /** * Check if JSONObject is empty. * * @return true if JSONObject is empty, otherwise false. */ public boolean isEmpty() { return map.isEmpty(); } /** * 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() { if(this.map.isEmpty()) { return null; } return new JSONArray(this.map.keySet()); } /** * 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) { Object val = this.opt(key); if (NULL.equals(val)) { return defaultValue; } if (val instanceof Boolean){ return ((Boolean) val).booleanValue(); } try { // we'll use the get anyway because it does string conversion. return this.getBoolean(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) { Object val = this.opt(key); if (NULL.equals(val)) { return defaultValue; } if (val instanceof BigDecimal){ return (BigDecimal) val; } if (val instanceof BigInteger){ return new BigDecimal((BigInteger) val); } if (val instanceof Double || val instanceof Float){ return new BigDecimal(((Number) val).doubleValue()); } if (val instanceof Long || val instanceof Integer || val instanceof Short || val instanceof Byte){ return new BigDecimal(((Number) val).longValue()); } // don't check if it's a string in case of unchecked Number subclasses try { return new BigDecimal(val.toString()); } catch (Exception e) { return defaultValue; } } /** * Get an optional BigInteger associated with a key, or the defaultValue if * there is no such key or if its value is not a number. 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) { Object val = this.opt(key); if (NULL.equals(val)) { return defaultValue; } if (val instanceof BigInteger){ return (BigInteger) val; } if (val instanceof BigDecimal){ return ((BigDecimal) val).toBigInteger(); } if (val instanceof Double || val instanceof Float){ return new BigDecimal(((Number) val).doubleValue()).toBigInteger(); } if (val instanceof Long || val instanceof Integer || val instanceof Short || val instanceof Byte){ return BigInteger.valueOf(((Number) val).longValue()); } // don't check if it's a string in case of unchecked Number subclasses try { // the other opt functions handle implicit conversions, i.e. // jo.put("double",1.1d); // jo.optInt("double"); -- will return 1, not an error // this conversion to BigDecimal then to BigInteger is to maintain // that type cast support that may truncate the decimal. final String valStr = val.toString(); if(isDecimalNotation(valStr)) { return new BigDecimal(valStr).toBigInteger(); } return new BigInteger(valStr); } 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 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) { Object val = this.opt(key); if (NULL.equals(val)) { return defaultValue; } if (val instanceof Number){ return ((Number) val).doubleValue(); } if (val instanceof String) { try { return Double.parseDouble((String) val); } catch (Exception e) { return defaultValue; } } 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 key * A key string. * @return The value. */ public float optFloat(String key) { return this.optFloat(key, Float.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 key * A key string. * @param defaultValue * The default value. * @return The value. */ public float optFloat(String key, float defaultValue) { Object val = this.opt(key); if (JSONObject.NULL.equals(val)) { return defaultValue; } if (val instanceof Number){ return ((Number) val).floatValue(); } if (val instanceof String) { try { return Float.parseFloat((String) val); } catch (Exception e) { return defaultValue; } } 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) { Object val = this.opt(key); if (NULL.equals(val)) { return defaultValue; } if (val instanceof Number){ return ((Number) val).intValue(); } if (val instanceof String) { try { return new BigDecimal((String) val).intValue(); } catch (Exception e) { return defaultValue; } } 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) { Object val = this.opt(key); if (NULL.equals(val)) { return defaultValue; } if (val instanceof Number){ return ((Number) val).longValue(); } if (val instanceof String) { try { return new BigDecimal((String) val).longValue(); } catch (Exception e) { return defaultValue; } } return defaultValue; } /** * Get an optional {@link Number} value associated with a key, or null * if there is no such key or if the value is not a number. If the value is a string, * an attempt will be made to evaluate it as a number ({@link BigDecimal}). This method * would be used in cases where type coercion of the number value is unwanted. * * @param key * A key string. * @return An object which is the value. */ public Number optNumber(String key) { return this.optNumber(key, null); } /** * Get an optional {@link Number} value associated with a key, or the default if there * is no such key or if the value is not a number. If the value is a string, * an attempt will be made to evaluate it as a number. This method * would be used in cases where type coercion of the number value is unwanted. * * @param key * A key string. * @param defaultValue * The default. * @return An object which is the value. */ public Number optNumber(String key, Number defaultValue) { Object val = this.opt(key); if (NULL.equals(val)) { return defaultValue; } if (val instanceof Number){ return (Number) val; } if (val instanceof String) { try { return stringToNumber((String) val); } catch (Exception e) { return defaultValue; } } 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(); } /** * Populates the internal map of the JSONObject with the bean properties. The * bean can not be recursive. * * @see JSONObject#JSONObject(Object) * * @param bean * the bean */ 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 (final Method method : methods) { final int modifiers = method.getModifiers(); if (Modifier.isPublic(modifiers) && !Modifier.isStatic(modifiers) && method.getParameterTypes().length == 0 && !method.isBridge() && method.getReturnType() != Void.TYPE && isValidMethodName(method.getName())) { final String key = getKeyNameFromMethod(method); if (key != null && !key.isEmpty()) { try { final Object result = method.invoke(bean); if (result != null) { this.map.put(key, wrap(result)); // we don't use the result anywhere outside of wrap // if it's a resource we should be sure to close it // after calling toString if (result instanceof Closeable) { try { ((Closeable) result).close(); } catch (IOException ignore) { } } } } catch (IllegalAccessException ignore) { } catch (IllegalArgumentException ignore) { } catch (InvocationTargetException ignore) { } } } } } private boolean isValidMethodName(String name) { return !"getClass".equals(name) && !"getDeclaringClass".equals(name); } private String getKeyNameFromMethod(Method method) { final int ignoreDepth = getAnnotationDepth(method, JSONPropertyIgnore.class); if (ignoreDepth > 0) { final int forcedNameDepth = getAnnotationDepth(method, JSONPropertyName.class); if (forcedNameDepth < 0 || ignoreDepth 3) { key = name.substring(3); } else if (name.startsWith("is") && name.length() > 2) { key = name.substring(2); } else { return null; } // if the first letter in the key is not uppercase, then skip. // This is to maintain backwards compatibility before PR406 // (https://github.com/stleary/JSON-java/pull/406/) if (Character.isLowerCase(key.charAt(0))) { return null; } if (key.length() == 1) { key = key.toLowerCase(Locale.ROOT); } else if (!Character.isUpperCase(key.charAt(1))) { key = key.substring(0, 1).toLowerCase(Locale.ROOT) + key.substring(1); } return key; } /** * Searches the class hierarchy to see if the method or it's super * implementations and interfaces has the annotation. * * @param * type of the annotation * * @param m * method to check * @param annotationClass * annotation to look for * @return the {@link Annotation} if the annotation exists on the current method * or one of it's super class definitions */ private static A getAnnotation(final Method m, final Class annotationClass) { // if we have invalid data the result is null if (m == null || annotationClass == null) { return null; } if (m.isAnnotationPresent(annotationClass)) { return m.getAnnotation(annotationClass); } // if we've already reached the Object class, return null; Class c = m.getDeclaringClass(); if (c.getSuperclass() == null) { return null; } // check directly implemented interfaces for the method being checked for (Class i : c.getInterfaces()) { try { Method im = i.getMethod(m.getName(), m.getParameterTypes()); return getAnnotation(im, annotationClass); } catch (final SecurityException ex) { continue; } catch (final NoSuchMethodException ex) { continue; } } try { return getAnnotation( c.getSuperclass().getMethod(m.getName(), m.getParameterTypes()), annotationClass); } catch (final SecurityException ex) { return null; } catch (final NoSuchMethodException ex) { return null; } } /** * Searches the class hierarchy to see if the method or it's super * implementations and interfaces has the annotation. Returns the depth of the * annotation in the hierarchy. * * @param * type of the annotation * * @param m * method to check * @param annotationClass * annotation to look for * @return Depth of the annotation or -1 if the annotation is not on the method. */ private static int getAnnotationDepth(final Method m, final Class
| Back | FazBrowse Home | New Git URL |