kbson/org.mongodb.kbson/BsonBinary

BsonBinary

class BsonBinary(type: Byte, data: ByteArray) : BsonValue
Content copied to clipboard

A representation of the BSON Binary type.

Note: that for performance reasons instances of this class are not immutable, so care should be taken to only modify the underlying byte array if you know what you're doing, or else make a defensive copy: BsonBinary.clone.

Constructors

Link copied to clipboard
fun BsonBinary(data: ByteArray)
Content copied to clipboard

Construct a new instance with the given data and the default subtype BsonBinarySubType.BINARY.

Link copied to clipboard
fun BsonBinary(type: BsonBinarySubType, data: ByteArray)
Content copied to clipboard

Construct a new instance with the given data and byte value of the subtype

Link copied to clipboard
fun BsonBinary(type: Byte, data: ByteArray)
Content copied to clipboard

constructs a new instance with the given subtype and data

Functions

Link copied to clipboard
fun asArray(): BsonArray
Content copied to clipboard

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

Link copied to clipboard
fun asBinary(): BsonBinary
Content copied to clipboard

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

Link copied to clipboard
fun asBoolean(): BsonBoolean
Content copied to clipboard

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

Link copied to clipboard
fun asBsonMaxKey(): BsonMaxKey
Content copied to clipboard

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

Link copied to clipboard
fun asBsonMinKey(): BsonMinKey
Content copied to clipboard

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

Link copied to clipboard
fun asBsonNull(): BsonNull
Content copied to clipboard

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

Link copied to clipboard
fun asBsonUndefined(): BsonUndefined
Content copied to clipboard

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

Link copied to clipboard
fun asDateTime(): BsonDateTime
Content copied to clipboard

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

Link copied to clipboard
fun asDBPointer(): BsonDBPointer
Content copied to clipboard

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

Link copied to clipboard
fun asDecimal128(): BsonDecimal128
Content copied to clipboard

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

Link copied to clipboard
fun asDocument(): BsonDocument
Content copied to clipboard

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

Link copied to clipboard
fun asDouble(): BsonDouble
Content copied to clipboard

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

Link copied to clipboard
fun asInt32(): BsonInt32
Content copied to clipboard

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

Link copied to clipboard
fun asInt64(): BsonInt64
Content copied to clipboard

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

Link copied to clipboard
fun asJavaScript(): BsonJavaScript
Content copied to clipboard

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

Link copied to clipboard
fun asJavaScriptWithScope(): BsonJavaScriptWithScope
Content copied to clipboard

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

Link copied to clipboard
fun asNumber(): BsonNumber
Content copied to clipboard

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

Link copied to clipboard
fun asObjectId(): BsonObjectId
Content copied to clipboard

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

Link copied to clipboard
fun asRegularExpression(): BsonRegularExpression
Content copied to clipboard

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

Link copied to clipboard
fun asString(): BsonString
Content copied to clipboard

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

Link copied to clipboard
fun asSymbol(): BsonSymbol
Content copied to clipboard

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

Link copied to clipboard
fun asTimestamp(): BsonTimestamp
Content copied to clipboard

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

Link copied to clipboard
fun clone(): BsonBinary
Content copied to clipboard

Clones this BsonBinary

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Content copied to clipboard
Link copied to clipboard
open override fun hashCode(): Int
Content copied to clipboard
Link copied to clipboard
fun isArray(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isBinary(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isBoolean(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isDateTime(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isDBPointer(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isDecimal128(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isDocument(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isDouble(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isInt32(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isInt64(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isJavaScript(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isJavaScriptWithScope(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isMaxKey(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isMinKey(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isNull(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isNumber(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isObjectId(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isRegularExpression(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isString(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isSymbol(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isTimestamp(): Boolean
Content copied to clipboard
Link copied to clipboard
fun isUndefined(): Boolean
Content copied to clipboard
Link copied to clipboard
fun toJson(): String
Content copied to clipboard

Return an extended json representation of this BsonValue

Link copied to clipboard
open override fun toString(): String
Content copied to clipboard

Properties

Link copied to clipboard
open override val bsonType: BsonType
Content copied to clipboard

Gets the BSON type of this value.

Link copied to clipboard
val data: ByteArray
Content copied to clipboard

the ByteArray

Link copied to clipboard
val type: Byte
Content copied to clipboard

the BsonBinarySubType byte value