BsonObjectId

class BsonObjectId(timestamp: Int, randomValue1: Int, randomValue2: Short, counter: Int) : BsonValue, Comparable<BsonObjectId>

A representation of the BSON ObjectId type

A globally unique identifier for objects.

Consists of 12 bytes, divided as follows:

``` ```

ObjectID layout
0	1	2	3	4	5	6	7	8	9	10	11
time				random value					inc

Constructors

BsonObjectId

fun BsonObjectId(timestamp: Int, randomValue1: Int, randomValue2: Short, counter: Int)

constructs a new instance with the given timestamp, random values and counter

Types

Companion

object Companion

Functions

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

compareTo

open operator override fun compareTo(other: BsonObjectId): Int

equals

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

hashCode

open override fun hashCode(): 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

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

toByteArray

fun toByteArray(): ByteArray

Convert to a byte array. Note that the numbers are stored in big-endian order.

toHexString

fun toHexString(): String

Converts this instance into a 24-byte hexadecimal string representation.

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.

timestamp

val timestamp: Int

the timestamp seconds since epoch