BsonDocument

class BsonDocument(initial: Map<String, BsonValue>) : BsonValue, MutableMap<String, BsonValue>

A type-safe container for a BSON document.

Parameters

initial

the initial values

Constructors

BsonDocument

fun BsonDocument(initialCapacity: Int)

Construct an empty document with the specified initial capacity.

BsonDocument

fun BsonDocument(key: String, value: BsonValue)

Construct a new instance with a single key value pair

BsonDocument

fun BsonDocument(bsonElements: List<BsonElement>)

Construct a new instance with the given list BsonElements

BsonDocument

fun BsonDocument(vararg pairs: Pair<String, BsonValue>)

Construct a new instance with the varargs of key value pairs

BsonDocument

fun BsonDocument(initial: Map<String, BsonValue> = LinkedHashMap())

constructs the bson document with the initial values, defaults to an empty document

Types

Companion

object Companion

BsonDocument companion object

Functions

append

fun append(key: String, value: BsonValue): BsonDocument

Put the given key and value into this document, and return the document.

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(): BsonDocument

Clone the document

containsKey

open override fun containsKey(key: String): Boolean

containsValue

open override fun containsValue(value: BsonValue): Boolean

equals

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

get

open operator override fun get(key: String): BsonValue?

operator fun get(key: String, defaultValue: BsonValue): BsonValue

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key.

getArray

fun getArray(key: String): BsonArray

Gets the value of the key if it is a BsonArray, or throws if not.

fun getArray(key: String, defaultValue: BsonArray): BsonArray

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonArray.

getBinary

fun getBinary(key: String): BsonBinary

Gets the value of the key if it is a BsonBinary, or throws if not.

fun getBinary(key: String, defaultValue: BsonBinary): BsonBinary

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonBinary.

getBoolean

fun getBoolean(key: String): BsonBoolean

Gets the value of the key if it is a BsonBoolean, or throws if not.

fun getBoolean(key: String, defaultValue: BsonBoolean): BsonBoolean

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonBoolean.

getDateTime

fun getDateTime(key: String): BsonDateTime

Gets the value of the key if it is a BsonDateTime, or throws if not.

fun getDateTime(key: String, defaultValue: BsonDateTime): BsonDateTime

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonDateTime.

getDecimal128

fun getDecimal128(key: String): BsonDecimal128

Gets the value of the key if it is a BsonDecimal128, or throws if not.

fun getDecimal128(key: String, defaultValue: BsonDecimal128): BsonDecimal128

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonDecimal128.

getDocument

fun getDocument(key: String): BsonDocument

Gets the value of the key if it is a BsonDocument, or throws if not.

fun getDocument(key: String, defaultValue: BsonDocument): BsonDocument

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonDocument.

getDouble

fun getDouble(key: String): BsonDouble

Gets the value of the key if it is a BsonDouble, or throws if not.

fun getDouble(key: String, defaultValue: BsonDouble): BsonDouble

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonDouble.

getFirstKey

fun getFirstKey(): String

Gets the first key in the document.

getInt32

fun getInt32(key: String): BsonInt32

Gets the value of the key if it is a BsonInt32, or throws if not.

fun getInt32(key: String, defaultValue: BsonInt32): BsonInt32

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonInt32.

getInt64

fun getInt64(key: String): BsonInt64

Gets the value of the key if it is a BsonInt64, or throws if not.

fun getInt64(key: String, defaultValue: BsonInt64): BsonInt64

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonInt64.

getNumber

fun getNumber(key: String): BsonNumber

Gets the value of the key if it is a BsonNumber, or throws if not.

fun getNumber(key: String, defaultValue: BsonNumber): BsonNumber

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonNumber.

getObjectId

fun getObjectId(key: String): BsonObjectId

Gets the value of the key if it is a BsonObjectId, or throws if not.

fun getObjectId(key: String, defaultValue: BsonObjectId): BsonObjectId

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonObjectId.

getRegularExpression

fun getRegularExpression(key: String): BsonRegularExpression

Gets the value of the key if it is a BsonRegularExpression, or throws if not.

fun getRegularExpression(key: String, defaultValue: BsonRegularExpression): BsonRegularExpression

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonRegularExpression.

getString

fun getString(key: String): BsonString

Gets the value of the key if it is a BsonString, or throws if not.

fun getString(key: String, defaultValue: BsonString): BsonString

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonString.

getTimestamp

fun getTimestamp(key: String): BsonTimestamp

Gets the value of the key if it is a BsonTimestamp, or throws if not.

fun getTimestamp(key: String, defaultValue: BsonTimestamp): BsonTimestamp

If the document does not contain the given key, return the given default value. Otherwise, gets the value of the key as a BsonTimestamp.

hashCode

open override fun hashCode(): Int

isArray

fun isArray(): Boolean

fun isArray(key: String): Boolean

Returns true if the value of the key is a BsonArray, returns false if the document does not contain the key.

isBinary

fun isBinary(): Boolean

fun isBinary(key: String): Boolean

Returns true if the value of the key is a BsonBinary, returns false if the document does not contain the key.

isBoolean

fun isBoolean(): Boolean

fun isBoolean(key: String): Boolean

Returns true if the value of the key is a BsonBoolean, returns false if the document does not contain the key.

isDateTime

fun isDateTime(): Boolean

fun isDateTime(key: String): Boolean

Returns true if the value of the key is a BsonDateTime, returns false if the document does not contain the key.

isDBPointer

fun isDBPointer(): Boolean

isDecimal128

fun isDecimal128(): Boolean

fun isDecimal128(key: String): Boolean

Returns true if the value of the key is a BsonDecimal128, returns false if the document does not contain the key.

isDocument

fun isDocument(): Boolean

fun isDocument(key: String): Boolean

Returns true if the value of the key is a BsonDocument, returns false if the document does not contain the key.

isDouble

fun isDouble(): Boolean

fun isDouble(key: String): Boolean

Returns true if the value of the key is a BsonDouble, returns false if the document does not contain the key.

isEmpty

open override fun isEmpty(): Boolean

isInt32

fun isInt32(): Boolean

fun isInt32(key: String): Boolean

Returns true if the value of the key is a BsonInt32, returns false if the document does not contain the key.

isInt64

fun isInt64(): Boolean

fun isInt64(key: String): Boolean

Returns true if the value of the key is a BsonInt64, returns false if the document does not contain the key.

isJavaScript

fun isJavaScript(): Boolean

isJavaScriptWithScope

fun isJavaScriptWithScope(): Boolean

isMaxKey

fun isMaxKey(): Boolean

isMinKey

fun isMinKey(): Boolean

isNull

fun isNull(): Boolean

fun isNull(key: String): Boolean

Returns true if the value of the key is a BsonNull, returns false if the document does not contain the key.

isNumber

fun isNumber(): Boolean

fun isNumber(key: String): Boolean

Returns true if the value of the key is a BsonNumber, returns false if the document does not contain the key.

isObjectId

fun isObjectId(): Boolean

fun isObjectId(key: String): Boolean

Returns true if the value of the key is a BsonObjectId, returns false if the document does not contain the key.

isRegularExpression

fun isRegularExpression(): Boolean

isString

fun isString(): Boolean

fun isString(key: String): Boolean

Returns true if the value of the key is a BsonString, returns false if the document does not contain the key.

isSymbol

fun isSymbol(): Boolean

isTimestamp

fun isTimestamp(): Boolean

fun isTimestamp(key: String): Boolean

Returns true if the value of the key is a BsonTimestamp, returns false if the document does not contain the key.

isUndefined

fun isUndefined(): Boolean

put

open override fun put(key: String, value: BsonValue): BsonValue?

putAll

open override fun putAll(from: Map<out String, BsonValue>)

remove

open override fun remove(key: String): BsonValue?

toByteArray

fun toByteArray(): ByteArray

Returns the Bson bytes for this document

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.

entries

open override val entries: MutableSet<MutableMap.MutableEntry<String, BsonValue>>

keys

open override val keys: MutableSet<String>

size

open override val size: Int

values

open override val values: MutableCollection<BsonValue>