couchbase-lite-ee/kotbase/Array

Array

actual open class Array : DelegatedClass<CBLArray> , ArrayInterface, Iterable<Any?> (source)

Inheritors

expect open class Array : ArrayInterface, Iterable<Any?> (source)

Array provides readonly access to array data.

Inheritors

actual open class Array : DelegatedClass<<Error class: unknown class>> , ArrayInterface, Iterable<Any?> (source)

Inheritors

actual open class Array : ArrayInterface, Iterable<Any?> (source)

Inheritors

Properties

Link copied to clipboard
actual open override val count: Int
expect open override val count: Int

The number of the items in the array.

actual open override val count: Int

The number of the items in the array.

actual open override val count: Int

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
open operator override fun equals(other: Any?): Boolean
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
operator fun ArrayInterface.get(index: Int): Fragment

Subscript access to a Fragment object of the projecting result value at the given index.

Link copied to clipboard
actual open override fun getArray(index: Int): Array?
expect open override fun getArray(index: Int): Array?

Gets value at the given index as an Array. Returns null if the value doesn't exist, or its value is not an Array.

actual open override fun getArray(index: Int): Array?

Gets value at the given index as an Array. Returns null if the value doesn't exist, or its value is not an Array.

actual open override fun getArray(index: Int): Array?
Link copied to clipboard
actual open override fun getBlob(index: Int): Blob?
expect open override fun getBlob(index: Int): Blob?

Gets value at the given index as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.

actual open override fun getBlob(index: Int): Blob?

Gets value at the given index as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.

actual open override fun getBlob(index: Int): Blob?
Link copied to clipboard
actual open override fun getBoolean(index: Int): Boolean
expect open override fun getBoolean(index: Int): Boolean

Gets value at the given index as a boolean.

actual open override fun getBoolean(index: Int): Boolean

Gets value at the given index as a boolean.

actual open override fun getBoolean(index: Int): Boolean
Link copied to clipboard
actual open override fun getDate(index: Int): Instant?
expect open override fun getDate(index: Int): Instant?

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 parsable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.

actual open override fun getDate(index: Int): Instant?

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 parsable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.

actual open override fun getDate(index: Int): Instant?
Link copied to clipboard
actual open override fun getDictionary(index: Int): Dictionary?
expect open override fun getDictionary(index: Int): Dictionary?

Gets a Dictionary at the given index. Return null if the value is not a dictionary.

actual open override fun getDictionary(index: Int): Dictionary?

Gets a Dictionary at the given index. Return null if the value is not a dictionary.

actual open override fun getDictionary(index: Int): Dictionary?
Link copied to clipboard
actual open override fun getDouble(index: Int): Double
expect open override fun getDouble(index: Int): Double

Gets value at the given index as a 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.

actual open override fun getDouble(index: Int): Double

Gets value at the given index as a 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.

actual open override fun getDouble(index: Int): Double
Link copied to clipboard
actual open override fun getFloat(index: Int): Float
expect open override fun getFloat(index: Int): Float

Gets value at the given index as a 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.

actual open override fun getFloat(index: Int): Float

Gets value at the given index as a 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.

actual open override fun getFloat(index: Int): Float
Link copied to clipboard
actual open override fun getInt(index: Int): Int
expect open override fun getInt(index: Int): Int

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.

actual open override fun getInt(index: Int): Int

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.

actual open override fun getInt(index: Int): Int
Link copied to clipboard
actual open override fun getLong(index: Int): Long
expect open override fun getLong(index: Int): Long

Gets value at the given index as a 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.

actual open override fun getLong(index: Int): Long

Gets value at the given index as a 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.

actual open override fun getLong(index: Int): Long
Link copied to clipboard
actual open override fun getNumber(index: Int): Number?
expect open override fun getNumber(index: Int): Number?

Gets value at the given index as a Number. Returns null if the value doesn't exist, or its value is not a Number.

actual open override fun getNumber(index: Int): Number?

Gets value at the given index as a Number. Returns null if the value doesn't exist, or its value is not a Number.

actual open override fun getNumber(index: Int): Number?
Link copied to clipboard
actual open override fun getString(index: Int): String?
expect open override fun getString(index: Int): String?

Gets value at the given index as a String. Returns null if the value doesn't exist, or its value is not a String.

actual open override fun getString(index: Int): String?

Gets value at the given index as a String. Returns null if the value doesn't exist, or its value is not a String.

actual open override fun getString(index: Int): String?
Link copied to clipboard
actual open override fun getValue(index: Int): Any?
expect open override fun getValue(index: Int): Any?

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 null if the value is null.

actual open override fun getValue(index: Int): Any?

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 null if the value is null.

actual open override fun getValue(index: Int): Any?
Link copied to clipboard
open override fun hashCode(): Int
open override fun hashCode(): Int
open override fun hashCode(): Int
Link copied to clipboard
actual open operator override fun iterator(): Iterator<Any?>
expect open operator override fun iterator(): Iterator<Any?>

An iterator over elements of this array. A call to the next() method of the returned iterator will throw a ConcurrentModificationException, if the MutableArray is modified while it is in use.

actual open operator override fun iterator(): Iterator<Any?>
actual open operator override fun iterator(): Iterator<Any?>
Link copied to clipboard
actual open override fun toJSON(): String
expect open override fun toJSON(): String

Encode an Array as a JSON string

actual open override fun toJSON(): String

Encode an Array as a JSON string

actual open override fun toJSON(): String
Link copied to clipboard
actual open override fun toList(): List<Any?>
expect open override fun toList(): List<Any?>

Gets content of the current object as a List. The values contained in the returned List object are all JSON based values.

actual open override fun toList(): List<Any?>

Gets content of the current object as a List. The values contained in the returned List object are all JSON based values.

actual open override fun toList(): List<Any?>
Link copied to clipboard
actual fun toMutable(): MutableArray
expect fun toMutable(): MutableArray

Return a mutable copy of the array

actual fun toMutable(): MutableArray
actual fun toMutable(): MutableArray
Link copied to clipboard
open override fun toString(): String
open override fun toString(): String
open override fun toString(): String