BsonArray

class BsonArray(initial: List<BsonValue>) : BsonValue, MutableList<BsonValue>

A type-safe representation of the BSON array type.

Parameters

initial

the initial list of BsonValues in the array

Constructors

BsonArray

fun BsonArray(initialCapacity: Int)

Construct an empty BsonArray with the specified initial capacity.

BsonArray

fun BsonArray(initial: List<BsonValue> = emptyList())

constructs the bson array with an initial list of values, defaults to no items

Functions

add

open override fun add(element: BsonValue): Boolean

open override fun add(index: Int, element: BsonValue)

addAll

open override fun addAll(elements: Collection<BsonValue>): Boolean

open override fun addAll(index: Int, elements: Collection<BsonValue>): Boolean

asArray

fun asArray(): BsonArray

Gets this value as a BsonArray if it is one, otherwise throws exception

asBinary

fun asBinary(): BsonBinary

Gets this value as a BsonBinary if it is one, otherwise throws exception

asBoolean

fun asBoolean(): BsonBoolean

Gets this value as a BsonBoolean if it is one, otherwise throws exception

asBsonMaxKey

fun asBsonMaxKey(): BsonMaxKey

Gets this value as a BsonMaxKey if it is one, otherwise throws exception

asBsonMinKey

fun asBsonMinKey(): BsonMinKey

Gets this value as a BsonMinKey if it is one, otherwise throws exception

asBsonNull

fun asBsonNull(): BsonNull

Gets this value as a BsonNull if it is one, otherwise throws exception

asBsonUndefined

fun asBsonUndefined(): BsonUndefined

Gets this value as a BsonUndefined if it is one, otherwise throws exception

asDateTime

fun asDateTime(): BsonDateTime

Gets this value as a BsonDateTime if it is one, otherwise throws exception

asDBPointer

fun asDBPointer(): BsonDBPointer

Gets this value as a BsonDBPointer if it is one, otherwise throws exception

asDecimal128

fun asDecimal128(): BsonDecimal128

Gets this value as a BsonDecimal128 if it is one, otherwise throws exception

asDocument

fun asDocument(): BsonDocument

Gets this value as a BsonDocument if it is one, otherwise throws exception

asDouble

fun asDouble(): BsonDouble

Gets this value as a BsonDouble if it is one, otherwise throws exception

asInt32

fun asInt32(): BsonInt32

Gets this value as a BsonInt32 if it is one, otherwise throws exception

asInt64

fun asInt64(): BsonInt64

Gets this value as a BsonInt64 if it is one, otherwise throws exception

asJavaScript

fun asJavaScript(): BsonJavaScript

Gets this value as a BsonJavaScript if it is one, otherwise throws exception

asJavaScriptWithScope

fun asJavaScriptWithScope(): BsonJavaScriptWithScope

Gets this value as a BsonJavaScriptWithScope if it is one, otherwise throws exception

asNumber

fun asNumber(): BsonNumber

Gets this value as a BsonNumber if it is one, otherwise throws exception

asObjectId

fun asObjectId(): BsonObjectId

Gets this value as an BsonObjectId if it is one, otherwise throws exception

asRegularExpression

fun asRegularExpression(): BsonRegularExpression

Gets this value as a BsonRegularExpression if it is one, otherwise throws exception

asString

fun asString(): BsonString

Gets this value as a BsonString if it is one, otherwise throws exception

asSymbol

fun asSymbol(): BsonSymbol

Gets this value as a BsonSymbol if it is one, otherwise throws exception

asTimestamp

fun asTimestamp(): BsonTimestamp

Gets this value as a BsonTimestamp if it is one, otherwise throws exception

clear

open override fun clear()

clone

fun clone(): BsonArray

Creates and returns a deep copy of this object

contains

open operator override fun contains(element: BsonValue): Boolean

containsAll

open override fun containsAll(elements: Collection<BsonValue>): Boolean

equals

open operator override fun equals(other: Any?): Boolean

get

open operator override fun get(index: Int): BsonValue

hashCode

open override fun hashCode(): Int

indexOf

open override fun indexOf(element: BsonValue): Int

isArray

fun isArray(): Boolean

isBinary

fun isBinary(): Boolean

isBoolean

fun isBoolean(): Boolean

isDateTime

fun isDateTime(): Boolean

isDBPointer

fun isDBPointer(): Boolean

isDecimal128

fun isDecimal128(): Boolean

isDocument

fun isDocument(): Boolean

isDouble

fun isDouble(): Boolean

isEmpty

open override fun isEmpty(): Boolean

isInt32

fun isInt32(): Boolean

isInt64

fun isInt64(): Boolean

isJavaScript

fun isJavaScript(): Boolean

isJavaScriptWithScope

fun isJavaScriptWithScope(): Boolean

isMaxKey

fun isMaxKey(): Boolean

isMinKey

fun isMinKey(): Boolean

isNull

fun isNull(): Boolean

isNumber

fun isNumber(): Boolean

isObjectId

fun isObjectId(): Boolean

isRegularExpression

fun isRegularExpression(): Boolean

isString

fun isString(): Boolean

isSymbol

fun isSymbol(): Boolean

isTimestamp

fun isTimestamp(): Boolean

isUndefined

fun isUndefined(): Boolean

iterator

open operator override fun iterator(): MutableIterator<BsonValue>

lastIndexOf

open override fun lastIndexOf(element: BsonValue): Int

listIterator

open override fun listIterator(): MutableListIterator<BsonValue>

open override fun listIterator(index: Int): MutableListIterator<BsonValue>

remove

open override fun remove(element: BsonValue): Boolean

removeAll

open override fun removeAll(elements: Collection<BsonValue>): Boolean

removeAt

open override fun removeAt(index: Int): BsonValue

retainAll

open override fun retainAll(elements: Collection<BsonValue>): Boolean

set

open operator override fun set(index: Int, element: BsonValue): BsonValue

subList

open override fun subList(fromIndex: Int, toIndex: Int): MutableList<BsonValue>

toJson

fun toJson(): String

Return an extended json representation of this BsonValue

toString

open override fun toString(): String

Properties

bsonType

open override val bsonType: BsonType

Gets the BSON type of this value.

size

open override val size: Int

values

val values: List<BsonValue>

The values in this array as a list of BsonValue objects.