Array (Couchbase Lite 2.0.0-186)

java.lang.Object
- com.couchbase.lite.ReadOnlyArray
- - com.couchbase.lite.Array

All Implemented Interfaces:

Iterable<Object>
```
public class Array
extends ReadOnlyArray
```
Array provides access to array data.

Constructor Summary

Constructors
Constructor and Description

Array()
Constructs a new empty Array object.

Array(List<Object> array)
Constructs a new Array object with an array content.

Constructors
Constructor and Description
`Array()` Constructs a new empty Array object.
`Array(List<Object> array)` Constructs a new Array object with an array content.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Array`	`addArray(Array value)`
`Array`	`addBlob(Blob value)`
`Array`	`addBoolean(boolean value)`
`Array`	`addDate(Date value)`
`Array`	`addDictionary(Dictionary value)`
`Array`	`addDouble(double value)`
`Array`	`addFloat(float value)`
`Array`	`addInt(int value)`
`Array`	`addLong(long value)`
`Array`	`addNumber(Number value)`
`Array`	`addObject(Object value)` Adds an object to the end of the array.
`Array`	`addString(String value)`
`int`	`count()` Gets a number of the items in the array.
`void`	`fleeceEncode(FLEncoder encoder, Database database)`
`Array`	`getArray(int index)` Gets a Array at the given index.
`Blob`	`getBlob(int index)` Gets value at the given index as a Blob.
`boolean`	`getBoolean(int index)` Gets value at the given index as a boolean.
`Date`	`getDate(int index)` Gets value at the given index as a Date.
`Dictionary`	`getDictionary(int index)` Gets a Dictionary at the given index.
`double`	`getDouble(int index)` Gets value at the given index as an double.
`float`	`getFloat(int index)` Gets value at the given index as an float.
`int`	`getInt(int index)` Gets value at the given index as an int.
`long`	`getLong(int index)` Gets value at the given index as an long.
`Number`	`getNumber(int index)` Gets value at the given index as a Number.
`Object`	`getObject(int index)` Gets value at the given index as an object.
`String`	`getString(int index)` Gets value at the given index as a String.
`Array`	`insertArray(int index, Array value)`
`Array`	`insertBlob(int index, Blob value)`
`Array`	`insertBoolean(int index, boolean value)`
`Array`	`insertDate(int index, Date value)`
`Array`	`insertDictionary(int index, Dictionary value)`
`Array`	`insertDouble(int index, double value)`
`Array`	`insertFloat(int index, float value)`
`Array`	`insertInt(int index, int value)`
`Array`	`insertLong(int index, long value)`
`Array`	`insertNumber(int index, Number value)`
`Array`	`insertObject(int index, Object value)` Inserts an object at the given index.
`Array`	`insertString(int index, String value)`
`Iterator<Object>`	`iterator()`
`Array`	`remove(int index)` Removes the object at the given index.
`Array`	`set(List<Object> list)` Set an array as a content.
`Array`	`setArray(int index, Array value)`
`Array`	`setBlob(int index, Blob value)`
`Array`	`setBoolean(int index, boolean value)`
`Array`	`setDate(int index, Date value)`
`Array`	`setDictionary(int index, Dictionary value)`
`Array`	`setDouble(int index, double value)`
`Array`	`setFloat(int index, float value)`
`Array`	`setInt(int index, int value)`
`Array`	`setLong(int index, long value)`
`Array`	`setNumber(int index, Number value)`
`Array`	`setObject(int index, Object value)` Set an object at the given index.
`Array`	`setString(int index, String value)`
`List<Object>`	`toList()` Gets content of the current object as an List.

Methods inherited from class com.couchbase.lite.ReadOnlyArray
getData, setData

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Array
```
public Array()
```
    Constructs a new empty Array object.
  - Array
```
public Array(List<Object> array)
```
    Constructs a new Array object with an array content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types.
    
    Parameters:
    
    array - the array object.
- Method Detail
  - set
```
public Array set(List<Object> list)
```
    Set an array as a content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types. Setting the new array content will replcace the current data including the existing Array and Dictionary objects.
    
    Parameters:
    
    list - the array
    
    Returns:
    
    this Array instance
  - setObject
```
public Array setObject(int index,
                       Object value)
```
    Set an object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the object
    
    Returns:
    
    this Array instance
  - setString
```
public Array setString(int index,
                       String value)
```
  - setNumber
```
public Array setNumber(int index,
                       Number value)
```
  - setInt
```
public Array setInt(int index,
                    int value)
```
  - setLong
```
public Array setLong(int index,
                     long value)
```
  - setFloat
```
public Array setFloat(int index,
                      float value)
```
  - setDouble
```
public Array setDouble(int index,
                       double value)
```
  - setBoolean
```
public Array setBoolean(int index,
                        boolean value)
```
  - setBlob
```
public Array setBlob(int index,
                     Blob value)
```
  - setDate
```
public Array setDate(int index,
                     Date value)
```
  - setArray
```
public Array setArray(int index,
                      Array value)
```
  - setDictionary
```
public Array setDictionary(int index,
                           Dictionary value)
```
  - addObject
```
public Array addObject(Object value)
```
    Adds an object to the end of the array.
    
    Parameters:
    
    value - the object
    
    Returns:
    
    this Array instance
  - addString
```
public Array addString(String value)
```
  - addNumber
```
public Array addNumber(Number value)
```
  - addInt
```
public Array addInt(int value)
```
  - addLong
```
public Array addLong(long value)
```
  - addFloat
```
public Array addFloat(float value)
```
  - addDouble
```
public Array addDouble(double value)
```
  - addBoolean
```
public Array addBoolean(boolean value)
```
  - addBlob
```
public Array addBlob(Blob value)
```
  - addDate
```
public Array addDate(Date value)
```
  - addArray
```
public Array addArray(Array value)
```
  - addDictionary
```
public Array addDictionary(Dictionary value)
```
  - insertObject
```
public Array insertObject(int index,
                          Object value)
```
    Inserts an object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    value - the object
    
    Returns:
    
    this Array instance
  - insertString
```
public Array insertString(int index,
                          String value)
```
  - insertNumber
```
public Array insertNumber(int index,
                          Number value)
```
  - insertInt
```
public Array insertInt(int index,
                       int value)
```
  - insertLong
```
public Array insertLong(int index,
                        long value)
```
  - insertFloat
```
public Array insertFloat(int index,
                         float value)
```
  - insertDouble
```
public Array insertDouble(int index,
                          double value)
```
  - insertBoolean
```
public Array insertBoolean(int index,
                           boolean value)
```
  - insertBlob
```
public Array insertBlob(int index,
                        Blob value)
```
  - insertDate
```
public Array insertDate(int index,
                        Date value)
```
  - insertArray
```
public Array insertArray(int index,
                         Array value)
```
  - insertDictionary
```
public Array insertDictionary(int index,
                              Dictionary value)
```
  - remove
```
public Array remove(int index)
```
    Removes the object at the given index.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    this Array instance
  - getArray
```
public Array getArray(int index)
```
    Gets a Array at the given index. Return null if the value is not an array.
    
    Overrides:
    
    getArray in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Array object.
  - getDictionary
```
public Dictionary getDictionary(int index)
```
    Gets a Dictionary at the given index. Return null if the value is not an dictionary.
    
    Overrides:
    
    getDictionary in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Dictionary object.
  - count
```
public int count()
```
    Gets a number of the items in the array.
    
    Overrides:
    
    count in class ReadOnlyArray
    
    Returns:
  - getObject
```
public Object getObject(int index)
```
    Gets value at the given index as an object. The object types are Blob, Array, Dictionary, Number, or String based on the underlying data type; or nil if the value is nil.
    
    Overrides:
    
    getObject in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Object or null.
  - getString
```
public String getString(int index)
```
    Gets value at the given index as a String. Returns null if the value doesn't exist, or its value is not a String.
    
    Overrides:
    
    getString in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the String or null.
  - getNumber
```
public Number getNumber(int index)
```
    Gets value at the given index as a Number. Returns null if the value doesn't exist, or its value is not a Number.
    
    Overrides:
    
    getNumber in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Number or nil.
  - getInt
```
public int getInt(int index)
```
    Gets value at the given index as an int. Floating point values will be rounded. The value `true` is returned as 1, `false` as 0. Returns 0 if the value doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getInt in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the int value.
  - getLong
```
public long getLong(int index)
```
    Gets value at the given index as an long. Floating point values will be rounded. The value `true` is returned as 1, `false` as 0. Returns 0 if the value doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getLong in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the long value.
  - getFloat
```
public float getFloat(int index)
```
    Gets value at the given index as an float. Integers will be converted to float. The value `true` is returned as 1.0, `false` as 0.0. Returns 0.0 if the value doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getFloat in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the float value.
  - getDouble
```
public double getDouble(int index)
```
    Gets value at the given index as an double. Integers will be converted to double. The value `true` is returned as 1.0, `false` as 0.0. Returns 0.0 if the property doesn't exist or does not have a numeric value.
    
    Overrides:
    
    getDouble in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the double value.
  - getBoolean
```
public boolean getBoolean(int index)
```
    Gets value at the given index as a boolean.
    
    Overrides:
    
    getBoolean in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the boolean value.
  - getBlob
```
public Blob getBlob(int index)
```
    Gets value at the given index as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.
    
    Overrides:
    
    getBlob in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Blob value or null.
  - getDate
```
public Date getDate(int index)
```
    Gets value at the given index as a Date. JSON does not directly support dates, so the actual property value must be a string, which is then parsed according to the ISO-8601 date format (the default used in JSON.) Returns null if the value doesn't exist, is not a string, or is not parseable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.
    
    Overrides:
    
    getDate in class ReadOnlyArray
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Date value or null.
  - toList
```
public List<Object> toList()
```
    Gets content of the current object as an List. The values contained in the returned List object are all JSON based values.
    
    Overrides:
    
    toList in class ReadOnlyArray
    
    Returns:
    
    the List object representing the content of the current object in the JSON format.
  - iterator
```
public Iterator<Object> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Object>
    
    Overrides:
    
    iterator in class ReadOnlyArray
  - fleeceEncode
```
public void fleeceEncode(FLEncoder encoder,
                         Database database)
```
    Overrides:
    
    fleeceEncode in class ReadOnlyArray

Class Array

Constructor Summary

Method Summary

Methods inherited from class com.couchbase.lite.ReadOnlyArray

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Array

Array

Method Detail

set

setObject

setString

setNumber

setInt

setLong

setFloat

setDouble

setBoolean

setBlob

setDate

setArray

setDictionary

addObject

addString

addNumber

addInt

addLong

addFloat

addDouble

addBoolean

addBlob

addDate

addArray

addDictionary

insertObject

insertString

insertNumber

insertInt

insertLong

insertFloat

insertDouble

insertBoolean

insertBlob

insertDate

insertArray

insertDictionary

remove

getArray

getDictionary

count

getObject

getString

getNumber

getInt

getLong

getFloat

getDouble

getBoolean

getBlob

getDate

toList

iterator

fleeceEncode