Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  package org.apache.tomcat.util.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 static org.jboss.web.JSONMessages.MESSAGES;
 
 import java.io.Writer;
 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 coersion for you.

The texts produced by the toString methods strictly conform to JSON syntax rules. The constructors are more forgiving in the texts they will accept:

  • An extra , (comma) may appear just before the closing bracket.
  • The null value will be inserted when there is , (comma) elision.
  • Strings may be quoted with ' (single quote).
  • Strings do not need to be quoted at all if they do not begin with a quote or single quote, and if they do not contain leading or trailing spaces, and if they do not contain any of these characters: { } [ ] / \ : , = ; # and if they do not look like numbers and if they are not the reserved words true, false, or null.
  • Values can be separated by ; (semicolon) as well as by , (comma).
  • Numbers may have the 0- (octal) or 0x- (hex) prefix.
  • Comments written in the slashshlash, slashstar, and hash conventions will be ignored.

Author(s):
JSON.org
Version:
2008-09-18
 
 public class JSONArray {


    
The arrayList where the JSONArray's properties are kept.
 
     private ArrayList myArrayList;


    
Construct an empty JSONArray.
 
     public JSONArray() {
        this. = new ArrayList();
    }

    
Construct a JSONArray from a JSONTokener.

Parameters:
x A JSONTokener
Throws:
JSONException If there is a syntax error.
    public JSONArray(JSONTokener xthrows JSONException {
        this();
        char c = x.nextClean();
        char q;
        if (c == '[') {
            q = ']';
        } else if (c == '(') {
            q = ')';
        } else {
            throw x.syntaxError(.arrayMustStartWithBracket());
        }
        if (x.nextClean() == ']') {
            return;
        }
        x.back();
        for (;;) {
            if (x.nextClean() == ',') {
                x.back();
                this..add(null);
            } else {
                x.back();
                this..add(x.nextValue());
            }
            c = x.nextClean();
            switch (c) {
            case ';':
            case ',':
                if (x.nextClean() == ']') {
                    return;
                }
                x.back();
                break;
            case ']':
            case ')':
                if (q != c) {
                    throw x.syntaxError(.arrayCharExpected('q'));
                }
                return;
            default:
                throw x.syntaxError(.arrayEndExpected());
            }
        }
    }


    
Construct a JSONArray from a source JSON text.

Parameters:
source A string that begins with [ (left bracket) and ends with ] (right bracket).
Throws:
JSONException If there is a syntax error.
    public JSONArray(String sourcethrows JSONException {
        this(new JSONTokener(source));
    }


    
Construct a JSONArray from a Collection.

Parameters:
collection A Collection.
    public JSONArray(Collection collection) {
        this. = (collection == null) ?
            new ArrayList() :
            new ArrayList(collection);
    }

    
Construct a JSONArray from a collection of beans. The collection should have Java Beans.

Throws:
JSONException If not an array.
    public JSONArray(Collection collection,boolean includeSuperClass) {
		this. = new ArrayList();
		if(collection != null) {
			for (Iterator iter = collection.iterator(); iter.hasNext();) {
				this..add(new JSONObject(iter.next(),includeSuperClass));	
			}
		}
    }

    
    
Construct a JSONArray from an array

Throws:
JSONException If not an array.
    public JSONArray(Object arraythrows JSONException {
        this();
        if (array.getClass().isArray()) {
            int length = Array.getLength(array);
            for (int i = 0; i < lengthi += 1) {
                this.put(Array.get(arrayi));
            }
        } else {
            throw new JSONException(.arrayInvalidValue());
        }
    }

    
Construct a JSONArray from an array with a bean. The array should have Java Beans.

Throws:
JSONException If not an array.
    public JSONArray(Object array,boolean includeSuperClassthrows JSONException {
        this();
        if (array.getClass().isArray()) {
            int length = Array.getLength(array);
            for (int i = 0; i < lengthi += 1) {
                this.put(new JSONObject(Array.get(arrayi),includeSuperClass));
            }
        } else {
            throw new JSONException(.arrayInvalidValue());
        }
    }

    
    
    
Get the object value associated with an index.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
An object value.
Throws:
JSONException If there is no value for the index.
    public Object get(int indexthrows JSONException {
        Object o = opt(index);
        if (o == null) {
            throw new JSONException(.arrayInvalidIndex(index));
        }
        return o;
    }


    
Get the boolean value associated with an index. The string values "true" and "false" are converted to boolean.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The truth.
Throws:
JSONException If there is no value for the index or if the value is not convertable to boolean.
    public boolean getBoolean(int indexthrows JSONException {
        Object o = get(index);
        if (o.equals(.) ||
                (o instanceof String &&
                ((String)o).equalsIgnoreCase("false"))) {
            return false;
        } else if (o.equals(.) ||
                (o instanceof String &&
                ((String)o).equalsIgnoreCase("true"))) {
            return true;
        }
        throw new JSONException(.arrayInvalidType(index"Boolean"));
    }


    
Get the double value associated with an index.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The value.
Throws:
JSONException If the key is not found or if the value cannot be converted to a number.
    public double getDouble(int indexthrows JSONException {
        Object o = get(index);
        try {
            return o instanceof Number ?
                ((Number)o).doubleValue() :
                Double.valueOf((String)o).doubleValue();
        } catch (Exception e) {
            throw new JSONException(.arrayInvalidType(index"Double"));
        }
    }


    
Get the int value associated with an index.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The value.
Throws:
JSONException If the key is not found or if the value cannot be converted to a number. if the value cannot be converted to a number.
    public int getInt(int indexthrows JSONException {
        Object o = get(index);
        return o instanceof Number ?
                ((Number)o).intValue() : (int)getDouble(index);
    }


    
Get the JSONArray associated with an index.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
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 indexthrows JSONException {
        Object o = get(index);
        if (o instanceof JSONArray) {
            return (JSONArray)o;
        }
        throw new JSONException(.arrayInvalidType(index"JSONArray"));
    }


    
Get the JSONObject associated with an index.

Parameters:
index subscript
Returns:
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 indexthrows JSONException {
        Object o = get(index);
        if (o instanceof JSONObject) {
            return (JSONObject)o;
        }
        throw new JSONException(.arrayInvalidType(index"JSONObject"));
    }


    
Get the long value associated with an index.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The value.
Throws:
JSONException If the key is not found or if the value cannot be converted to a number.
    public long getLong(int indexthrows JSONException {
        Object o = get(index);
        return o instanceof Number ?
                ((Number)o).longValue() : (long)getDouble(index);
    }


    
Get the string associated with an index.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
A string value.
Throws:
JSONException If there is no value for the index.
    public String getString(int indexthrows JSONException {
        return get(index).toString();
    }


    
Determine if the value is null.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
true if the value at the index is null, or if there is no value.
    public boolean isNull(int index) {
        return ..equals(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.

Parameters:
separator A string that will be inserted between the elements.
Returns:
a string.
Throws:
JSONException If the array contains an invalid number.
    public String join(String separatorthrows JSONException {
        int len = length();
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < leni += 1) {
            if (i > 0) {
                sb.append(separator);
            }
            sb.append(JSONObject.valueToString(this..get(i)));
        }
        return sb.toString();
    }


    
Get the number of elements in the JSONArray, included nulls.

Returns:
The length (or size).
    public int length() {
        return this..size();
    }


    
Get the optional object value associated with an index.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
An object value, or null if there is no object at that index.
    public Object opt(int index) {
        return (index < 0 || index >= length()) ?
            null : this..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".

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The truth.
    public boolean optBoolean(int index)  {
        return optBoolean(indexfalse);
    }


    
Get the optional boolean value associated with an index. It returns the defaultValue if there is no value at that index or if it is not a Boolean or the String "true" or "false" (case insensitive).

Parameters:
index The index must be between 0 and length() - 1.
defaultValue A boolean default.
Returns:
The truth.
    public boolean optBoolean(int indexboolean defaultValue)  {
        try {
            return 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.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The value.
    public double optDouble(int index) {
        return optDouble(index.);
    }


    
Get the optional double value associated with an index. The defaultValue is returned if there is no value for the index, or if the value is not a number and cannot be converted to a number.

Parameters:
index subscript
defaultValue The default value.
Returns:
The value.
    public double optDouble(int indexdouble defaultValue) {
        try {
            return 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.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The value.
    public int optInt(int index) {
        return 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.

Parameters:
index The index must be between 0 and length() - 1.
defaultValue The default value.
Returns:
The value.
    public int optInt(int indexint defaultValue) {
        try {
            return getInt(index);
        } catch (Exception e) {
            return defaultValue;
        }
    }


    
Get the optional JSONArray associated with an index.

Parameters:
index subscript
Returns:
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 = 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.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
A JSONObject value.
    public JSONObject optJSONObject(int index) {
        Object o = 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.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
The value.
    public long optLong(int index) {
        return 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.

Parameters:
index The index must be between 0 and length() - 1.
defaultValue The default value.
Returns:
The value.
    public long optLong(int indexlong defaultValue) {
        try {
            return 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.

Parameters:
index The index must be between 0 and length() - 1.
Returns:
A String value.
    public String optString(int index) {
        return optString(index"");
    }


    
Get the optional string associated with an index. The defaultValue is returned if the key is not found.

Parameters:
index The index must be between 0 and length() - 1.
defaultValue The default value.
Returns:
A String value.
    public String optString(int indexString defaultValue) {
        Object o = opt(index);
        return o != null ? o.toString() : defaultValue;
    }


    
Append a boolean value. This increases the array's length by one.

Parameters:
value A boolean value.
Returns:
this.
    public JSONArray put(boolean value) {
        put(value ? . : .);
        return this;
    }


    
Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.

Parameters:
value A Collection value.
Returns:
this.
    public JSONArray put(Collection value) {
        put(new JSONArray(value));
        return this;
    }


    
Append a double value. This increases the array's length by one.

Parameters:
value A double value.
Returns:
this.
Throws:
JSONException if the value is not finite.
    public JSONArray put(double valuethrows JSONException {
        Double d = new Double(value);
        JSONObject.testValidity(d);
        put(d);
        return this;
    }


    
Append an int value. This increases the array's length by one.

Parameters:
value An int value.
Returns:
this.
    public JSONArray put(int value) {
        put(new Integer(value));
        return this;
    }


    
Append an long value. This increases the array's length by one.

Parameters:
value A long value.
Returns:
this.
    public JSONArray put(long value) {
        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.

Parameters:
value A Map value.
Returns:
this.
    public JSONArray put(Map value) {
        put(new JSONObject(value));
        return this;
    }


    
Append an object value. This increases the array's length by one.

Parameters:
value An object value. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.
Returns:
this.
    public JSONArray put(Object value) {
        this..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.

Parameters:
index The subscript.
value A boolean value.
Returns:
this.
Throws:
JSONException If the index is negative.
    public JSONArray put(int indexboolean valuethrows JSONException {
        put(indexvalue ? . : .);
        return this;
    }


    
Put a value in the JSONArray, where the value will be a JSONArray which is produced from a Collection.

Parameters:
index The subscript.
value A Collection value.
Returns:
this.
Throws:
JSONException If the index is negative or if the value is not finite.
    public JSONArray put(int indexCollection valuethrows JSONException {
        put(indexnew 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.

Parameters:
index The subscript.
value A double value.
Returns:
this.
Throws:
JSONException If the index is negative or if the value is not finite.
    public JSONArray put(int indexdouble valuethrows JSONException {
        put(indexnew 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.

Parameters:
index The subscript.
value An int value.
Returns:
this.
Throws:
JSONException If the index is negative.
    public JSONArray put(int indexint valuethrows JSONException {
        put(indexnew 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.

Parameters:
index The subscript.
value A long value.
Returns:
this.
Throws:
JSONException If the index is negative.
    public JSONArray put(int indexlong valuethrows JSONException {
        put(indexnew Long(value));
        return this;
    }


    
Put a value in the JSONArray, where the value will be a JSONObject which is produced from a Map.

Parameters:
index The subscript.
value The Map value.
Returns:
this.
Throws:
JSONException If the index is negative or if the the value is an invalid number.
    public JSONArray put(int indexMap valuethrows JSONException {
        put(indexnew 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.

Parameters:
index The subscript.
value The value to put into the array. The value should be a Boolean, Double, Integer, JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.
Returns:
this.
Throws:
JSONException If the index is negative or if the the value is an invalid number.
    public JSONArray put(int indexObject valuethrows JSONException {
        JSONObject.testValidity(value);
        if (index < 0) {
            throw new JSONException(.arrayInvalidIndex(index));
        }
        if (index < length()) {
            this..set(indexvalue);
        } else {
            while (index != length()) {
                put(.);
            }
            put(value);
        }
        return this;
    }


    
Produce a JSONObject by combining a JSONArray of names with the values of this JSONArray.

Parameters:
names A JSONArray containing a list of key strings. These will be paired with the values.
Returns:
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 namesthrows JSONException {
        if (names == null || names.length() == 0 || 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.

Returns:
a printable, displayable, transmittable representation of the array.
    public String toString() {
        try {
            return '[' + join(",") + ']';
        } catch (Exception e) {
            return null;
        }
    }


    
Make a prettyprinted JSON text of this JSONArray. Warning: This method assumes that the data structure is acyclical.

Parameters:
indentFactor The number of spaces to add to each level of indentation.
Returns:
a printable, displayable, transmittable representation of the object, beginning with [ (left bracket) and ending with ] (right bracket).
Throws:
JSONException
    public String toString(int indentFactorthrows JSONException {
        return toString(indentFactor, 0);
    }


    
Make a prettyprinted JSON text of this JSONArray. Warning: This method assumes that the data structure is acyclical.

Parameters:
indentFactor The number of spaces to add to each level of indentation.
indent The indention of the top level.
Returns:
a printable, displayable, transmittable representation of the array.
Throws:
JSONException
    String toString(int indentFactorint indentthrows JSONException {
        int len = length();
        if (len == 0) {
            return "[]";
        }
        int i;
        StringBuffer sb = new StringBuffer("[");
        if (len == 1) {
            sb.append(JSONObject.valueToString(this..get(0),
                    indentFactorindent));
        } else {
            int newindent = indent + indentFactor;
            sb.append('\n');
            for (i = 0; i < leni += 1) {
                if (i > 0) {
                    sb.append(",\n");
                }
                for (int j = 0; j < newindentj += 1) {
                    sb.append(' ');
                }
                sb.append(JSONObject.valueToString(this..get(i),
                        indentFactornewindent));
            }
            sb.append('\n');
            for (i = 0; i < indenti += 1) {
                sb.append(' ');
            }
        }
        sb.append(']');
        return sb.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.

Returns:
The writer.
Throws:
JSONException
    public Writer write(Writer writerthrows JSONException {
        try {
            boolean b = false;
            int     len = length();
            writer.write('[');
            for (int i = 0; i < leni += 1) {
                if (b) {
                    writer.write(',');
                }
                Object v = this..get(i);
                if (v instanceof JSONObject) {
                    ((JSONObject)v).write(writer);
                } else if (v instanceof JSONArray) {
                    ((JSONArray)v).write(writer);
                } else {
                    writer.write(JSONObject.valueToString(v));
                }
                b = true;
            }
            writer.write(']');
            return writer;
        } catch (IOException e) {
           throw new JSONException(e);
        }
    }
New to GrepCode? Check out our FAQ X