JsonArray (java-client 2.0.0 API)

java.lang.Object
- com.couchbase.client.java.document.json.JsonValue
- - com.couchbase.client.java.document.json.JsonArray

All Implemented Interfaces:

java.lang.Iterable<java.lang.Object>
```
public class JsonArray
extends JsonValue
implements java.lang.Iterable<java.lang.Object>
```
Represents a JSON array that can be stored and loaded from Couchbase Server.
If boxed return values are unboxed, the calling code needs to make sure to handle potential NullPointerExceptions.
The JsonArray is backed by a List and is intended to work similar to it API wise, but to only allow to store such objects which can be represented by JSON.

Since:

2.0

Field Summary
- Fields inherited from class com.couchbase.client.java.document.json.JsonValue
  NULL

Method Summary

Methods
Modifier and Type	Method and Description
`JsonArray`	`add(boolean value)` Append an `Boolean` element to the `JsonArray`.
`JsonArray`	`add(double value)` Append an `Double` element to the `JsonArray`.
`JsonArray`	`add(int value)` Append an `Integer` element to the `JsonArray`.
`JsonArray`	`add(JsonArray value)` Append an `JsonArray` element to the `JsonArray`.
`JsonArray`	`add(JsonObject value)` Append an `JsonObject` element to the `JsonArray`.
`JsonArray`	`add(long value)` Append an `Long` element to the `JsonArray`.
`JsonArray`	`add(java.lang.Object value)` Append an element to the `JsonArray`.
`JsonArray`	`add(java.lang.String value)` Append an `String` element to the `JsonArray`.
`static JsonArray`	`create()` Creates a empty `JsonArray`.
`static JsonArray`	`empty()` Creates a empty `JsonArray`.
`static JsonArray`	`from(java.lang.Object... items)` Creates a new `JsonArray` and populates it with the values supplied.
`java.lang.Object`	`get(int index)` Retrieves the value by the position in the `JsonArray` and does not cast it.
`JsonArray`	`getArray(int index)` Retrieves the value by the position in the `JsonArray` and casts it to `JsonArray`.
`boolean`	`getBoolean(int index)` Retrieves the value by the position in the `JsonArray` and casts it to `Boolean`.
`java.lang.Double`	`getDouble(int index)` Retrieves the value by the position in the `JsonArray` and casts it to `Double`.
`java.lang.Integer`	`getInt(int index)` Retrieves the value by the position in the `JsonArray` and casts it to `Integer`.
`java.lang.Long`	`getLong(int index)` Retrieves the value by the position in the `JsonArray` and casts it to `Long`.
`JsonObject`	`getObject(int index)` Retrieves the value by the position in the `JsonArray` and casts it to `JsonObject`.
`java.lang.String`	`getString(int index)` Retrieves the value by the position in the `JsonArray` and casts it to `String`.
`boolean`	`isEmpty()` Checks if the `JsonArray` is empty or not.
`java.util.Iterator<java.lang.Object>`	`iterator()`
`int`	`size()` Returns the size of the `JsonArray`.
`java.util.List<java.lang.Object>`	`toList()` Copies the content of the `JsonArray` into a new `List` and return it.
`java.lang.String`	`toString()` Converts the `JsonArray` into its JSON string representation.

Methods inherited from class com.couchbase.client.java.document.json.JsonValue
checkType, ja, jo

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

- Method Detail
  - empty
```
public static JsonArray empty()
```
    Creates a empty JsonArray.
    
    Returns:
    a empty JsonArray.
  - create
```
public static JsonArray create()
```
    Creates a empty JsonArray.
    
    Returns:
    a empty JsonArray.
  - from
```
public static JsonArray from(java.lang.Object... items)
```
    Creates a new JsonArray and populates it with the values supplied.
    If the type is not supported, a IllegalArgumentException exception is thrown.
    
    Parameters:
    items - the items to be stored in the JsonArray.
    
    Returns:
    a populated JsonArray.
  - get
```
public java.lang.Object get(int index)
```
    Retrieves the value by the position in the JsonArray and does not cast it.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - add
```
public JsonArray add(java.lang.Object value)
```
    Append an element to the JsonArray.
    Note that the type is checked and a IllegalArgumentException is thrown if not supported.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - add
```
public JsonArray add(java.lang.String value)
```
    Append an String element to the JsonArray.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - getString
```
public java.lang.String getString(int index)
```
    Retrieves the value by the position in the JsonArray and casts it to String.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - add
```
public JsonArray add(long value)
```
    Append an Long element to the JsonArray.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - getLong
```
public java.lang.Long getLong(int index)
```
    Retrieves the value by the position in the JsonArray and casts it to Long.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - add
```
public JsonArray add(int value)
```
    Append an Integer element to the JsonArray.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - getInt
```
public java.lang.Integer getInt(int index)
```
    Retrieves the value by the position in the JsonArray and casts it to Integer.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - add
```
public JsonArray add(double value)
```
    Append an Double element to the JsonArray.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - getDouble
```
public java.lang.Double getDouble(int index)
```
    Retrieves the value by the position in the JsonArray and casts it to Double.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - add
```
public JsonArray add(boolean value)
```
    Append an Boolean element to the JsonArray.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - getBoolean
```
public boolean getBoolean(int index)
```
    Retrieves the value by the position in the JsonArray and casts it to Boolean.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - add
```
public JsonArray add(JsonObject value)
```
    Append an JsonObject element to the JsonArray.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - getObject
```
public JsonObject getObject(int index)
```
    Retrieves the value by the position in the JsonArray and casts it to JsonObject.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - add
```
public JsonArray add(JsonArray value)
```
    Append an JsonArray element to the JsonArray.
    
    Parameters:
    value - the value to append.
    
    Returns:
    the JsonArray.
  - getArray
```
public JsonArray getArray(int index)
```
    Retrieves the value by the position in the JsonArray and casts it to JsonArray.
    
    Parameters:
    index - the index of the value.
    
    Returns:
    the value if found, or null otherwise.
  - toList
```
public java.util.List<java.lang.Object> toList()
```
    Copies the content of the JsonArray into a new List and return it.
    
    Returns:
    the content of the JsonArray in a new List.
  - isEmpty
```
public boolean isEmpty()
```
    Checks if the JsonArray is empty or not.
    
    Returns:
    true if it is, false otherwise.
  - size
```
public int size()
```
    Returns the size of the JsonArray.
    
    Returns:
    the size.
  - iterator
```
public java.util.Iterator<java.lang.Object> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Object>
  - toString
```
public java.lang.String toString()
```
    Converts the JsonArray into its JSON string representation.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    the JSON string representing this JsonArray.

Class JsonArray

Field Summary

Fields inherited from class com.couchbase.client.java.document.json.JsonValue

Method Summary

Methods inherited from class com.couchbase.client.java.document.json.JsonValue

Methods inherited from class java.lang.Object

Method Detail

empty

create

from

get

add

add

getString

add

getLong

add

getInt

add

getDouble

add

getBoolean

add

getObject

add

getArray

toList

isEmpty

size

iterator

toString