org.pfsw.text.json

Class JsonArray

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<java.lang.Object>

org.pfsw.text.json.JsonArray

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.List<java.lang.Object>, java.util.RandomAccess, IJSONConvertible, IStringRepresentation, JsonType

public class JsonArray
extends java.util.ArrayList<java.lang.Object>
implements JsonType

The Java internal representation of a JSON array.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Fields inherited from interface org.pfsw.bif.text.IJSONConvertible

JSON_ARRAY_END, JSON_ARRAY_START, JSON_ELEMENT_SEPARATOR, JSON_LITERAL_FALSE, JSON_LITERAL_NULL, JSON_LITERAL_TRUE, JSON_OBJECT_END, JSON_OBJECT_START, JSON_PAIR_SEPARATOR, JSON_STRING_DELIMITER, JSON_STRING_ESCAPE

Constructor Summary

Constructors

Constructor and Description
JsonArray(java.util.Collection<? extends java.lang.Object> collection)
JsonArray(int initialCapacity)
JsonArray(java.lang.Object... objects)

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Object object) Adds the given element if it is a valid JSON object type.
JsonArray	addElements(java.lang.Object... elements) Adds all given elements if they are valid JSON object types, which are: JsonObject JsonArray String Boolean Integer Long BigDecimal null Objects of other types will cause an exception.
JsonArray	addJsonObjects(java.util.Collection<JsonObject> objects) Adds the given JSON objects.
JsonArray	addJsonObjects(JsonObject... objects) Adds the given JSON objects.
JsonArray	addStrings(java.util.Collection<java.lang.String> strings) Adds the given strings.
JsonArray	addStrings(java.lang.String... strings) Adds the given strings.
void	appendAsJSONString(java.lang.Appendable output) The receiver of this method must append its internal state as JSON string representation to the given buffer.
<T> T[]	asArray(java.lang.Class<T> elementType) Returns a copy of this JsonArray as an array of elements with the given type.
<T> java.util.List<T>	asList(java.lang.Class<T> elementType) Returns a copy of this JsonArray as list of elements with the same type.
java.lang.String	asString() Returns the JSON string representation of this object.
static JsonArray	create()
java.math.BigDecimal	getBigDecimal(int index) Returns the value for the given index as BigDecimal (if it is one).
java.lang.Boolean	getBoolean(int index) Returns the value for the given index as Boolean (if it is one).
java.lang.Integer	getInteger(int index) Returns the value for the given index as Integer (if it is one).
JsonArray	getJsonArray(int index) Returns the value at the given index as JsonArray (if it is one).
JsonObject	getJsonObject(int index) Returns the value at the given index as JsonObject (if it is one).
java.lang.Long	getLong(int index) Returns the value for the given index as Long (if it is one).
java.lang.Number	getNumber(int index) Returns the value for the given index as Number (if it is one).
java.lang.String	getString(int index) Returns the value for the given index as String (if it is one).
protected <T> T	getTypedElement(int index, java.lang.Class<T> type)
<T> T	getValueOfType(int index, java.lang.Class<T> type) Returns the value for the given index as type of the given class.
boolean	isArray() Returns true because this is a JSON array representation (in Java).
boolean	isObject() Returns false because this is no JSON object representation (in Java).
java.lang.String	toJSON() The receiver of this method returns its internal state as JSON string representation.
static JsonArray	withIntegerValuess(java.lang.Integer... integerValues)
static JsonArray	withJsonObjects(JsonObject... objects)
static JsonArray	withLongValues(java.lang.Long... longValues)
static JsonArray	withStrings(java.lang.String... strings)

Methods inherited from class java.util.ArrayList

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

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, 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

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

JsonArray

public JsonArray(java.lang.Object... objects)

JsonArray

public JsonArray(java.util.Collection<? extends java.lang.Object> collection)

JsonArray

public JsonArray(int initialCapacity)

Method Detail

create

public static JsonArray create()

withStrings

public static JsonArray withStrings(java.lang.String... strings)

withIntegerValuess

public static JsonArray withIntegerValuess(java.lang.Integer... integerValues)

withLongValues

public static JsonArray withLongValues(java.lang.Long... longValues)

withJsonObjects

public static JsonArray withJsonObjects(JsonObject... objects)

getJsonObject

public JsonObject getJsonObject(int index)

Returns the value at the given index as JsonObject (if it is one).

Parameters:

index - The index of the object to look for.

Returns:

The found JsonObject or null.

Throws:

java.lang.ClassCastException - If the object at the given index is no JsonObject.

getJsonArray

public JsonArray getJsonArray(int index)

Returns the value at the given index as JsonArray (if it is one).

Parameters:

index - The index of the array to look for.

Returns:

The found JsonArray or null.

Throws:

java.lang.ClassCastException - If the object at the given index is no JsonArray.

getString

public java.lang.String getString(int index)

Returns the value for the given index as String (if it is one).

Parameters:

index - The index of the value to look for.

Returns:

The found String or null if not existent.

Throws:

java.lang.ClassCastException - If the object at the given index is no String.

getBoolean

public java.lang.Boolean getBoolean(int index)

Returns the value for the given index as Boolean (if it is one).

Parameters:

index - The index of the value to look for.

Returns:

The found Boolean or null if not existent.

Throws:

java.lang.ClassCastException - If the object at the given index is no Boolean.

getNumber

public java.lang.Number getNumber(int index)

Returns the value for the given index as Number (if it is one).

Parameters:

index - The index of the value to look for.

Returns:

The found Number or null if not existent.

Throws:

java.lang.ClassCastException - If the object at the given index is no Number.

getInteger

public java.lang.Integer getInteger(int index)

Returns the value for the given index as Integer (if it is one).

Parameters:

index - The index of the value to look for.

Returns:

The found Integer or null if not existent.

Throws:

java.lang.ClassCastException - If the object at the given index is no Integer.

getLong

public java.lang.Long getLong(int index)

Returns the value for the given index as Long (if it is one).

Parameters:

index - The index of the value to look for.

Returns:

The found Long or null if not existent.

Throws:

java.lang.ClassCastException - If the object at the given index is no Long.

getBigDecimal

public java.math.BigDecimal getBigDecimal(int index)

Returns the value for the given index as BigDecimal (if it is one).

Parameters:

index - The index of the value to look for.

Returns:

The found BigDecimal or null if not existent.

Throws:

java.lang.ClassCastException - If the object at the given index is no BigDecimal.

getValueOfType

public <T> T getValueOfType(int index,
                            java.lang.Class<T> type)

Returns the value for the given index as type of the given class.

Parameters:

index - The index of the value to look for.

Returns:

The found object or null if not existent.

Throws:

java.lang.IllegalArgumentException - If the specified type is no valid JSON type.

java.lang.ClassCastException - If the object at the given index is not of the specified type.

isObject

public boolean isObject()

Returns false because this is no JSON object representation (in Java).

Specified by:

isObject in interface JsonType

isArray

public boolean isArray()

Returns true because this is a JSON array representation (in Java).

Specified by:

isArray in interface JsonType

add

public boolean add(java.lang.Object object)

Adds the given element if it is a valid JSON object type.

Valid types are:

• JsonObject
• JsonArray
• String
• Boolean
• Integer
• Long
• BigDecimal
• null

Objects of other types will cause an exception.

Specified by:

add in interface java.util.Collection<java.lang.Object>

Specified by:

add in interface java.util.List<java.lang.Object>

Overrides:

add in class java.util.ArrayList<java.lang.Object>

Returns:

true if the object was added.

Throws:

java.lang.IllegalArgumentException - If the given object is not of a valid JSON type.

addStrings

public JsonArray addStrings(java.lang.String... strings)

Adds the given strings.

addStrings

public JsonArray addStrings(java.util.Collection<java.lang.String> strings)

Adds the given strings.

addJsonObjects

public JsonArray addJsonObjects(JsonObject... objects)

Adds the given JSON objects.

addJsonObjects

public JsonArray addJsonObjects(java.util.Collection<JsonObject> objects)

Adds the given JSON objects.

addElements

public JsonArray addElements(java.lang.Object... elements)

Adds all given elements if they are valid JSON object types, which are:

• JsonObject
• JsonArray
• String
• Boolean
• Integer
• Long
• BigDecimal
• null

Objects of other types will cause an exception.

Throws:

java.lang.IllegalArgumentException - If a given element is not of a valid JSON type.

asList

public <T> java.util.List<T> asList(java.lang.Class<T> elementType)

Returns a copy of this JsonArray as list of elements with the same type.

Parameters:

elementType - The type all elements must have (must not be null).

Throws:

java.lang.ClassCastException - If any of the elements in this JsonArray is not of the specified type.

asArray

public <T> T[] asArray(java.lang.Class<T> elementType)

Returns a copy of this JsonArray as an array of elements with the given type.

Parameters:

elementType - The type all elements must have (must not be null).

Throws:

java.lang.ClassCastException - If any of the elements in this JsonArray is not of the specified type.

asString

public java.lang.String asString()

Returns the JSON string representation of this object.

Specified by:

asString in interface IStringRepresentation

appendAsJSONString

public void appendAsJSONString(java.lang.Appendable output)

Description copied from interface: IJSONConvertible

The receiver of this method must append its internal state as JSON string representation to the given buffer.

Specified by:

appendAsJSONString in interface IJSONConvertible

Parameters:

output - The output target to which to append the JSON string (must not be null).

toJSON

public java.lang.String toJSON()

Description copied from interface: IJSONConvertible

The receiver of this method returns its internal state as JSON string representation.

Specified by:

toJSON in interface IJSONConvertible

getTypedElement

protected <T> T getTypedElement(int index,
                                java.lang.Class<T> type)