com.api.json

Class JSONArray

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Object>

com.api.json.JSONArray

All Implemented Interfaces:

JSONArtifact, Serializable, Cloneable, Iterable<Object>, Collection<Object>, List<Object>, RandomAccess

public class JSONArray
extends ArrayList<Object>
implements JSONArtifact

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
JSONArray() Constructor
JSONArray(int intialCapacity) Constructor with initial capacity allocated

Method Summary

Modifier and Type	Method and Description
void	add(int index, Object element)
boolean	add(Object element)
boolean	addAll(Collection<?> collection)
boolean	addAll(int index, Collection<?> collection)
static JSONArray	parse(InputStream is) Parses the supplied input stream to derive a JSONArray
static JSONArray	parse(Reader reader) Parses the supplied reader to derive a JSONArray
static JSONArray	parse(String input) Parses the supplied String to derive a JSONArray
String	serialize() Convert this object into a String of JSON text.
String	serialize(boolean verbose)
void	serialize(OutputStream os) Convert this object into a stream of JSON text.
void	serialize(OutputStream os, boolean verbose) Convert this object into a stream of JSON text.
void	serialize(Writer writer) Convert this object into a stream of JSON text.
void	serialize(Writer writer, boolean verbose) Convert this object into a stream of JSON text, specifying verbosity.
Object	set(int index, Object element)
String	toString()
String	toString(StringBuffer sb, int indent, int incr) Abstract method to help with recursive formatting of JSON into a String

Methods inherited from class java.util.ArrayList

clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

JSONArray

public JSONArray()

Constructor

JSONArray

public JSONArray(int intialCapacity)

Constructor with initial capacity allocated

Parameters:

intialCapacity - initial size for the array

Method Detail

parse

public static JSONArray parse(InputStream is)
                       throws IOException

Parses the supplied input stream to derive a JSONArray

Parameters:

is - The input stream to be parsed

Returns:

JSONArray associated with the input stream.

Throws:

IOException - If a parsing error occurs.

parse

public static JSONArray parse(Reader reader)
                       throws IOException

Parses the supplied reader to derive a JSONArray

Parameters:

reader - The Reader to be parsed

Returns:

JSONArray associated with the input reader.

Throws:

IOException - If a parsing error occurs.

parse

public static JSONArray parse(String input)
                       throws IOException

Parses the supplied String to derive a JSONArray

Parameters:

input - The String to be parsed

Returns:

JSONArray associated with the input String.

Throws:

IOException - If a parsing error occurs.

add

public void add(int index,
                Object element)

Specified by:

add in interface List<Object>

Overrides:

add in class ArrayList<Object>

add

public boolean add(Object element)

Specified by:

add in interface Collection<Object>

Specified by:

add in interface List<Object>

Overrides:

add in class ArrayList<Object>

addAll

public boolean addAll(Collection<?> collection)

Specified by:

addAll in interface Collection<Object>

Specified by:

addAll in interface List<Object>

Overrides:

addAll in class ArrayList<Object>

addAll

public boolean addAll(int index,
                      Collection<?> collection)

Specified by:

addAll in interface List<Object>

Overrides:

addAll in class ArrayList<Object>

serialize

public String serialize()
                 throws IOException

Description copied from interface: JSONArtifact

Convert this object into a String of JSON text.

Specified by:

serialize in interface JSONArtifact

Returns:

String containing the JSON formatted according to the verbose flag.

Throws:

IOException - Thrown on IO errors during serialization.

serialize

public String serialize(boolean verbose)
                 throws IOException

Specified by:

serialize in interface JSONArtifact

Parameters:

verbose - Whether or not to write the JSON text in a verbose format.

Returns:

String containing the JSON formatted according to the verbose flag.

Throws:

IOException - Thrown on IO errors during serialization.

serialize

public void serialize(OutputStream os)
               throws IOException

Description copied from interface: JSONArtifact

Convert this object into a stream of JSON text. Same as calling serialize(os,false); Note that encoding is always written as UTF-8, as per JSON spec.

Specified by:

serialize in interface JSONArtifact

Parameters:

os - The output stream to serialize data to.

Throws:

IOException - Thrown on IO errors during serialization.

serialize

public void serialize(OutputStream os,
                      boolean verbose)
               throws IOException

Description copied from interface: JSONArtifact

Convert this object into a stream of JSON text. Same as calling serialize(writer,false); Note that encoding is always written as UTF-8, as per JSON spec.

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:

IOException - Thrown on IO errors during serialization.

serialize

public void serialize(Writer writer)
               throws IOException

Description copied from interface: JSONArtifact

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:

IOException - Thrown on IO errors during serialization.

serialize

public void serialize(Writer writer,
                      boolean verbose)
               throws IOException

Description copied from interface: JSONArtifact

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.

verbose - Whether or not to write the JSON text in a verbose format.

Throws:

IOException - Thrown on IO errors during serialization.

set

public Object set(int index,
                  Object element)

Specified by:

set in interface List<Object>

Overrides:

set in class ArrayList<Object>

toString

public String toString()

Overrides:

toString in class AbstractCollection<Object>

toString

public String toString(StringBuffer sb,
                       int indent,
                       int incr)

Description copied from interface: JSONArtifact

Abstract method to help with recursive formatting of JSON into a String

Specified by:

toString in interface JSONArtifact

Parameters:

sb - Buffer to receive formatted JSON content

indent - The amount of indentation expected in the formatted output.

incr - the amount of incremental spacing used for formatted output.

Returns:

Formatted JSON output.