JsonArray (Gson 2.2.3 API)

java.lang.Object
- com.google.gson.JsonElement
- - com.google.gson.JsonArray

All Implemented Interfaces:

Iterable<JsonElement>
```
public final class JsonArray
extends JsonElement
implements Iterable<JsonElement>
```
A class representing an array type in Json. An array is a list of JsonElements each of which can be of a different type. This is an ordered list, meaning that the order in which elements are added is preserved.

Author:

Inderjeet Singh, Joel Leitch

Constructor Summary

Constructors
Constructor and Description

JsonArray()
Creates an empty JsonArray.

Constructors
Constructor and Description
`JsonArray()` Creates an empty JsonArray.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(JsonElement element)` Adds the specified element to self.
`void`	`addAll(JsonArray array)` Adds all the elements of the specified array to self.
`boolean`	`equals(Object o)`
`JsonElement`	`get(int i)` Returns the ith element of the array.
`BigDecimal`	`getAsBigDecimal()` convenience method to get this array as a `BigDecimal` if it contains a single element.
`BigInteger`	`getAsBigInteger()` convenience method to get this array as a `BigInteger` if it contains a single element.
`boolean`	`getAsBoolean()` convenience method to get this array as a boolean if it contains a single element.
`byte`	`getAsByte()` convenience method to get this element as a primitive byte value.
`char`	`getAsCharacter()` convenience method to get this element as a primitive character value.
`double`	`getAsDouble()` convenience method to get this array as a double if it contains a single element.
`float`	`getAsFloat()` convenience method to get this array as a float if it contains a single element.
`int`	`getAsInt()` convenience method to get this array as an integer if it contains a single element.
`long`	`getAsLong()` convenience method to get this array as a long if it contains a single element.
`Number`	`getAsNumber()` convenience method to get this array as a `Number` if it contains a single element.
`short`	`getAsShort()` convenience method to get this array as a primitive short if it contains a single element.
`String`	`getAsString()` convenience method to get this array as a `String` if it contains a single element.
`int`	`hashCode()`
`Iterator<JsonElement>`	`iterator()` Returns an iterator to navigate the elemetns of the array.
`int`	`size()` Returns the number of elements in the array.

Methods inherited from class com.google.gson.JsonElement
getAsJsonArray, getAsJsonNull, getAsJsonObject, getAsJsonPrimitive, isJsonArray, isJsonNull, isJsonObject, isJsonPrimitive, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JsonArray
```
public JsonArray()
```
    Creates an empty JsonArray.
- Method Detail
  - add
```
public void add(JsonElement element)
```
    Adds the specified element to self.
    
    Parameters:
    element - the element that needs to be added to the array.
  - addAll
```
public void addAll(JsonArray array)
```
    Adds all the elements of the specified array to self.
    
    Parameters:
    array - the array whose elements need to be added to the array.
  - size
```
public int size()
```
    Returns the number of elements in the array.
    
    Returns:
    the number of elements in the array.
  - iterator
```
public Iterator<JsonElement> iterator()
```
    Returns an iterator to navigate the elemetns of the array. Since the array is an ordered list, the iterator navigates the elements in the order they were inserted.
    
    Specified by:
    
    iterator in interface Iterable<JsonElement>
    
    Returns:
    an iterator to navigate the elements of the array.
  - get
```
public JsonElement get(int i)
```
    Returns the ith element of the array.
    
    Parameters:
    i - the index of the element that is being sought.
    
    Returns:
    the element present at the ith index.
    
    Throws:
    
    IndexOutOfBoundsException - if i is negative or greater than or equal to the size() of the array.
  - getAsNumber
```
public Number getAsNumber()
```
    convenience method to get this array as a Number if it contains a single element.
    
    Overrides:
    
    getAsNumber in class JsonElement
    
    Returns:
    get this element as a number if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid Number.
    
    IllegalStateException - if the array has more than one element.
  - getAsString
```
public String getAsString()
```
    convenience method to get this array as a String if it contains a single element.
    
    Overrides:
    
    getAsString in class JsonElement
    
    Returns:
    get this element as a String if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid String.
    
    IllegalStateException - if the array has more than one element.
  - getAsDouble
```
public double getAsDouble()
```
    convenience method to get this array as a double if it contains a single element.
    
    Overrides:
    
    getAsDouble in class JsonElement
    
    Returns:
    get this element as a double if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid double.
    
    IllegalStateException - if the array has more than one element.
  - getAsBigDecimal
```
public BigDecimal getAsBigDecimal()
```
    convenience method to get this array as a BigDecimal if it contains a single element.
    
    Overrides:
    
    getAsBigDecimal in class JsonElement
    
    Returns:
    get this element as a BigDecimal if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive.
    
    NumberFormatException - if the element at index 0 is not a valid BigDecimal.
    
    IllegalStateException - if the array has more than one element.
    Since:
    
    1.2
  - getAsBigInteger
```
public BigInteger getAsBigInteger()
```
    convenience method to get this array as a BigInteger if it contains a single element.
    
    Overrides:
    
    getAsBigInteger in class JsonElement
    
    Returns:
    get this element as a BigInteger if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive.
    
    NumberFormatException - if the element at index 0 is not a valid BigInteger.
    
    IllegalStateException - if the array has more than one element.
    Since:
    
    1.2
  - getAsFloat
```
public float getAsFloat()
```
    convenience method to get this array as a float if it contains a single element.
    
    Overrides:
    
    getAsFloat in class JsonElement
    
    Returns:
    get this element as a float if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid float.
    
    IllegalStateException - if the array has more than one element.
  - getAsLong
```
public long getAsLong()
```
    convenience method to get this array as a long if it contains a single element.
    
    Overrides:
    
    getAsLong in class JsonElement
    
    Returns:
    get this element as a long if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid long.
    
    IllegalStateException - if the array has more than one element.
  - getAsInt
```
public int getAsInt()
```
    convenience method to get this array as an integer if it contains a single element.
    
    Overrides:
    
    getAsInt in class JsonElement
    
    Returns:
    get this element as an integer if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid integer.
    
    IllegalStateException - if the array has more than one element.
  - getAsByte
```
public byte getAsByte()
```
    Description copied from class: JsonElement
    
    convenience method to get this element as a primitive byte value.
    
    Overrides:
    
    getAsByte in class JsonElement
    
    Returns:
    get this element as a primitive byte value.
  - getAsCharacter
```
public char getAsCharacter()
```
    Description copied from class: JsonElement
    
    convenience method to get this element as a primitive character value.
    
    Overrides:
    
    getAsCharacter in class JsonElement
    
    Returns:
    get this element as a primitive char value.
  - getAsShort
```
public short getAsShort()
```
    convenience method to get this array as a primitive short if it contains a single element.
    
    Overrides:
    
    getAsShort in class JsonElement
    
    Returns:
    get this element as a primitive short if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid short.
    
    IllegalStateException - if the array has more than one element.
  - getAsBoolean
```
public boolean getAsBoolean()
```
    convenience method to get this array as a boolean if it contains a single element.
    
    Overrides:
    
    getAsBoolean in class JsonElement
    
    Returns:
    get this element as a boolean if it is single element array.
    
    Throws:
    
    ClassCastException - if the element in the array is of not a JsonPrimitive and is not a valid boolean.
    
    IllegalStateException - if the array has more than one element.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class JsonArray

Constructor Summary

Method Summary

Methods inherited from class com.google.gson.JsonElement

Methods inherited from class java.lang.Object

Constructor Detail

JsonArray

Method Detail

add

addAll

size

iterator

get

getAsNumber

getAsString

getAsDouble

getAsBigDecimal

getAsBigInteger

getAsFloat

getAsLong

getAsInt

getAsByte

getAsCharacter

getAsShort

getAsBoolean

equals

hashCode