com.ibm.json.java
Class JSONArray

java.lang.Object
  extended by java.util.AbstractCollection
      extended by java.util.AbstractList
          extended by java.util.ArrayList
              extended by com.ibm.json.java.JSONArray
All Implemented Interfaces:
JSONArtifact, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class JSONArray
extends java.util.ArrayList
implements JSONArtifact

Extension of ArrayList that only allows values which are JSON-able. See JSONObject for a list of valid values. Instances of this class are not thread-safe.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
JSONArray()
          Create a new instance of this class.
JSONArray(int initialCapacity)
          Create a new instance of this class with the specified initial capacity.
 
Method Summary
 void add(int index, java.lang.Object element)
           
 boolean add(java.lang.Object element)
           
 boolean addAll(java.util.Collection collection)
           
 boolean addAll(int index, java.util.Collection collection)
           
static JSONArray parse(java.io.InputStream is)
          Convert a stream of JSONArray text into JSONArray form.
static JSONArray parse(java.io.Reader reader)
          Convert a stream (in reader form) of JSONArray text into object form.
static JSONArray parse(java.lang.String str)
          Convert a String of JSONArray text into object form.
 java.lang.String serialize()
          Convert this object into a String of JSON text.
 java.lang.String serialize(boolean verbose)
          Convert this object into a String of JSON text, specifying verbosity.
 void serialize(java.io.OutputStream os)
          Convert this object into a stream of JSON text.
 void serialize(java.io.OutputStream os, boolean verbose)
          Convert this object into a stream of JSON text.
 void serialize(java.io.Writer writer)
          Convert this object into a stream of JSON text.
 void serialize(java.io.Writer writer, boolean verbose)
          Convert this object into a stream of JSON text, specifying verbosity.
 java.lang.Object set(int index, java.lang.Object element)
           
 
Methods inherited from class java.util.ArrayList
clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeRange, size, toArray, toArray, trimToSize
 
Methods inherited from class java.util.AbstractList
equals, hashCode, iterator, listIterator, listIterator, subList
 
Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList
 

Constructor Detail

JSONArray

public JSONArray()
Create a new instance of this class.


JSONArray

public JSONArray(int initialCapacity)
Create a new instance of this class with the specified initial capacity.

Method Detail

add

public void add(int index,
                java.lang.Object element)
Specified by:
add in interface java.util.List
Overrides:
add in class java.util.ArrayList

add

public boolean add(java.lang.Object element)
Specified by:
add in interface java.util.Collection
Specified by:
add in interface java.util.List
Overrides:
add in class java.util.ArrayList

addAll

public boolean addAll(java.util.Collection collection)
Specified by:
addAll in interface java.util.Collection
Specified by:
addAll in interface java.util.List
Overrides:
addAll in class java.util.ArrayList

addAll

public boolean addAll(int index,
                      java.util.Collection collection)
Specified by:
addAll in interface java.util.List
Overrides:
addAll in class java.util.ArrayList

set

public java.lang.Object set(int index,
                            java.lang.Object element)
Specified by:
set in interface java.util.List
Overrides:
set in class java.util.ArrayList

parse

public static JSONArray parse(java.io.InputStream is)
                       throws java.io.IOException
Convert a stream of JSONArray text into JSONArray form.

Parameters:
is - The inputStream from which to read the JSON. It will assume the input stream is in UTF-8 and read it as such.
Returns:
The contructed JSONArray Object.
Throws:
IOEXception - Thrown if an underlying IO error from the stream occurs, or if malformed JSON is read,
java.io.IOException

parse

public static JSONArray parse(java.io.Reader reader)
                       throws java.io.IOException
Convert a stream (in reader form) of JSONArray text into object form.

Parameters:
reader - The reader from which the JSONArray data is read.
Returns:
The contructed JSONArray Object.
Throws:
IOEXception - Thrown if an underlying IO error from the reader occurs, or if malformed JSON is read,
java.io.IOException

parse

public static JSONArray parse(java.lang.String str)
                       throws java.io.IOException
Convert a String of JSONArray text into object form.

Parameters:
str - The JSONArray string to parse into a Java Object.
Returns:
The contructed JSONArray Object.
Throws:
IOEXception - Thrown if malformed JSON is read,
java.io.IOException

serialize

public void serialize(java.io.OutputStream os)
               throws java.io.IOException
Convert this object into a stream of JSON text. Same as calling serialize(os,false);

Specified by:
serialize in interface JSONArtifact
Parameters:
os - The output stream to serialize data to.
Throws:
java.io.IOException - Thrown on IO errors during serialization.

serialize

public void serialize(java.io.OutputStream os,
                      boolean verbose)
               throws java.io.IOException
Convert this object into a stream of JSON text. Same as calling serialize(writer,false);

Specified by:
serialize in interface JSONArtifact
Parameters:
os - The output stream to serialize data to.
verbose - Whether or not to write the JSON text in a verbose format.
Throws:
java.io.IOException - Thrown on IO errors during serialization.

serialize

public void serialize(java.io.Writer writer)
               throws java.io.IOException
Convert this object into a stream of JSON text. Same as calling serialize(writer,false);

Specified by:
serialize in interface JSONArtifact
Parameters:
writer - The writer which to serialize the JSON text to.
Throws:
java.io.IOException - Thrown on IO errors during serialization.

serialize

public void serialize(java.io.Writer writer,
                      boolean verbose)
               throws java.io.IOException
Convert this object into a stream of JSON text, specifying verbosity.

Specified by:
serialize in interface JSONArtifact
Parameters:
writer - The writer which to serialize the JSON text to.
Throws:
java.io.IOException - Thrown on IO errors during serialization.

serialize

public java.lang.String serialize(boolean verbose)
                           throws java.io.IOException
Convert this object into a String of JSON text, specifying verbosity.

Specified by:
serialize in interface JSONArtifact
Parameters:
verbose - Whether or not to serialize in compressed for formatted Strings.
Throws:
java.io.IOException - Thrown on IO errors during serialization.

serialize

public java.lang.String serialize()
                           throws java.io.IOException
Convert this object into a String of JSON text. Same as serialize(false);

Specified by:
serialize in interface JSONArtifact
Throws:
java.io.IOException - Thrown on IO errors during serialization.