Array (Couchbase Lite 2.0.0-231)

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

All Implemented Interfaces:

Iterable<Object>

Direct Known Subclasses:

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

Field Summary

Fields
Modifier and Type Field and Description

protected MArray _array

Fields
Modifier and Type	Field and Description
`protected MArray`	`_array`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static MValue`	`_get(MArray array, int index)`
`int`	`count()` Gets a number of the items in the array.
`void`	`encodeTo(FLEncoder enc)`
`boolean`	`equals(Object o)`
`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.
`String`	`getString(int index)` Gets value at the given index as a String.
`Object`	`getValue(int index)` Gets value at the given index as an object.
`int`	`hashCode()`
`Iterator<Object>`	`iterator()`
`protected String`	`outOfBoundsMsg(int index)`
`protected void`	`rangeCheck(int index)`
`List<Object>`	`toList()` Gets content of the current object as an List.
`MutableArray`	`toMutable()` Return a mutable copy of the array

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

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

- Field Detail
  - _array
```
protected MArray _array
```
- Method Detail
  - count
```
public int count()
```
    Gets a number of the items in the array.
    
    Returns:
  - getValue
```
public Object getValue(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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Date value or null.
  - getArray
```
public Array getArray(int index)
```
    Gets a Array at the given index. Return null if the value is not an array.
    
    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.
    
    Parameters:
    
    index - the index. This value must not exceed the bounds of the array.
    
    Returns:
    
    the Dictionary object.
  - 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.
    
    Returns:
    
    the List object representing the content of the current object in the JSON format.
  - toMutable
```
public MutableArray toMutable()
```
    Return a mutable copy of the array
    
    Returns:
    
    the MutableArray instance
  - encodeTo
```
public void encodeTo(FLEncoder enc)
```
  - iterator
```
public Iterator<Object> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Object>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - _get
```
protected static MValue _get(MArray array,
                             int index)
```
  - rangeCheck
```
protected void rangeCheck(int index)
```
  - outOfBoundsMsg
```
protected String outOfBoundsMsg(int index)
```

Class Array

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

_array

Method Detail

count

getValue

getString

getNumber

getInt

getLong

getFloat

getDouble

getBoolean

getBlob

getDate

getArray

getDictionary

toList

toMutable

encodeTo

iterator

equals

hashCode

_get

rangeCheck

outOfBoundsMsg