Package org.bson

Class RawBsonDocument

java.lang.Object

org.bson.BsonValue

org.bson.BsonDocument

org.bson.RawBsonDocument

All Implemented Interfaces:

Serializable, Cloneable, Map<String,BsonValue>, Bson

public final class RawBsonDocument
extends BsonDocument

A BSON document that is represented using only the raw bytes.

Since:

3.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Constructor Summary

Constructors

Constructor	Description
RawBsonDocument(byte[] bytes)	Constructs a new instance with the given byte array.
RawBsonDocument(byte[] bytes, int offset, int length)	Constructs a new instance with the given byte array, offset, and length.
RawBsonDocument(T document, Codec<T> codec)	Construct a new instance from the given document and codec for the document type.

Method Summary

Modifier and Type	Method	Description
BsonDocument	append(String key, BsonValue value)	Put the given key and value into this document, and return the document.
void	clear()
BsonDocument	clone()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
<T> T	decode(Codec<T> codec)	Decode this into a document.
<T> T	decode(Decoder<T> decoder)	Decode this into a document.
Set<Map.Entry<String,BsonValue>>	entrySet()
boolean	equals(Object o)
BsonValue	get(Object key)
byte[]	getBackingArray()	Returns the byte array backing this document.
ByteBuf	getByteBuffer()	Returns a ByteBuf that wraps the byte array, with the proper byte order.
int	getByteLength()	Returns the length of this document within the backing byte array.
int	getByteOffset()	Returns the offset into the backing byte array where this document starts.
String	getFirstKey()	Gets the first key in the document.
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
static RawBsonDocument	parse(String json)	Parses a string in MongoDB Extended JSON format to a RawBsonDocument
BsonValue	put(String key, BsonValue value)
void	putAll(Map<? extends String,? extends BsonValue> m)
BsonValue	remove(Object key)
int	size()
String	toJson()	Gets a JSON representation of this document using the JsonMode.RELAXED output mode, and otherwise the default settings of JsonWriterSettings.Builder.
String	toJson(JsonWriterSettings settings)	Gets a JSON representation of this document using the given JsonWriterSettings.
Collection<BsonValue>	values()

Methods inherited from class org.bson.BsonDocument

asBsonReader, get, getArray, getArray, getBinary, getBinary, getBoolean, getBoolean, getBsonType, getDateTime, getDateTime, getDecimal128, getDecimal128, getDocument, getDocument, getDouble, getDouble, getInt32, getInt32, getInt64, getInt64, getNumber, getNumber, getObjectId, getObjectId, getRegularExpression, getRegularExpression, getString, getString, getTimestamp, getTimestamp, isArray, isBinary, isBoolean, isDateTime, isDecimal128, isDocument, isDouble, isInt32, isInt64, isNull, isNumber, isObjectId, isString, isTimestamp, toBsonDocument, toString

Methods inherited from class org.bson.BsonValue

asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDecimal128, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDecimal128, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Details

RawBsonDocument

public RawBsonDocument(byte[] bytes)

Constructs a new instance with the given byte array. Note that it does not make a copy of the array, so do not modify it after passing it to this constructor.

Parameters:

bytes - the bytes representing a BSON document. Note that the byte array is NOT copied, so care must be taken not to modify it after passing it to this construction, unless of course that is your intention.

RawBsonDocument

public RawBsonDocument(byte[] bytes,
 int offset,
 int length)

Constructs a new instance with the given byte array, offset, and length. Note that it does not make a copy of the array, so do not modify it after passing it to this constructor.

Parameters:

bytes - the bytes representing a BSON document. Note that the byte array is NOT copied, so care must be taken not to modify it after passing it to this construction, unless of course that is your intention.

offset - the offset into the byte array

length - the length of the subarray to use

Since:

3.3

RawBsonDocument

public RawBsonDocument(T document,
 Codec<T> codec)

Construct a new instance from the given document and codec for the document type.

Type Parameters:

T - the BSON type that the codec encodes/decodes

Parameters:

document - the document to transform

codec - the codec to facilitate the transformation

Method Details

parse

public static RawBsonDocument parse(String json)

Parses a string in MongoDB Extended JSON format to a RawBsonDocument

Parameters:

json - the JSON string

Returns:

a corresponding RawBsonDocument object

Since:

3.3

See Also:

• JsonReader

MongoDB documentation

MongoDB Extended JSON

getByteBuffer

public ByteBuf getByteBuffer()

Returns a ByteBuf that wraps the byte array, with the proper byte order. Any changes made to the returned will be reflected in the underlying byte array owned by this instance.

Returns:

a byte buffer that wraps the byte array owned by this instance.

getBackingArray

public byte[] getBackingArray()

Returns the byte array backing this document. The returned array may be larger than the BSON document itself; only the range from getByteOffset() to getByteOffset() + getByteLength() contains valid document bytes. Changes to the returned array will be reflected in this document.

Returns:

the backing byte array

Since:

5.8

See Also:

• getByteOffset()
• getByteLength()

getByteOffset

public int getByteOffset()

Returns the offset into the backing byte array where this document starts.

Returns:

the offset

Since:

5.8

getByteLength

public int getByteLength()

Returns the length of this document within the backing byte array.

Returns:

the length

Since:

5.8

decode

public <T> T decode(Codec<T> codec)

Decode this into a document.

Type Parameters:

T - the BSON type that the codec encodes/decodes

Parameters:

codec - the codec to facilitate the transformation

Returns:

the decoded document

decode

public <T> T decode(Decoder<T> decoder)

Decode this into a document.

Type Parameters:

T - the BSON type that the codec encodes/decodes

Parameters:

decoder - the decoder to facilitate the transformation

Returns:

the decoded document

Since:

3.6

clear

public void clear()

Specified by:

clear in interface Map<String,BsonValue>

Overrides:

clear in class BsonDocument

put

public BsonValue put(String key,
 BsonValue value)

Specified by:

put in interface Map<String,BsonValue>

Overrides:

put in class BsonDocument

append

public BsonDocument append(String key,
 BsonValue value)

Description copied from class: BsonDocument

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

Overrides:

append in class BsonDocument

Parameters:

key - the key

value - the value

Returns:

this

putAll

public void putAll(Map<? extends String,? extends BsonValue> m)

Specified by:

putAll in interface Map<String,BsonValue>

Overrides:

putAll in class BsonDocument

remove

public BsonValue remove(Object key)

Specified by:

remove in interface Map<String,BsonValue>

Overrides:

remove in class BsonDocument

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,BsonValue>

Overrides:

isEmpty in class BsonDocument

size

public int size()

Specified by:

size in interface Map<String,BsonValue>

Overrides:

size in class BsonDocument

entrySet

public Set<Map.Entry<String,BsonValue>> entrySet()

Specified by:

entrySet in interface Map<String,BsonValue>

Overrides:

entrySet in class BsonDocument

values

public Collection<BsonValue> values()

Specified by:

values in interface Map<String,BsonValue>

Overrides:

values in class BsonDocument

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,BsonValue>

Overrides:

keySet in class BsonDocument

getFirstKey

public String getFirstKey()

Description copied from class: BsonDocument

Gets the first key in the document.

Overrides:

getFirstKey in class BsonDocument

Returns:

the first key in the document

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,BsonValue>

Overrides:

containsKey in class BsonDocument

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,BsonValue>

Overrides:

containsValue in class BsonDocument

get

public BsonValue get(Object key)

Specified by:

get in interface Map<String,BsonValue>

Overrides:

get in class BsonDocument

toJson

public String toJson()

Description copied from class: BsonDocument

Gets a JSON representation of this document using the JsonMode.RELAXED output mode, and otherwise the default settings of JsonWriterSettings.Builder.

Overrides:

toJson in class BsonDocument

Returns:

a JSON representation of this document

See Also:

• BsonDocument.toJson(JsonWriterSettings)
• JsonWriterSettings

toJson

public String toJson(JsonWriterSettings settings)

Description copied from class: BsonDocument

Gets a JSON representation of this document using the given JsonWriterSettings.

Overrides:

toJson in class BsonDocument

Parameters:

settings - the JSON writer settings

Returns:

a JSON representation of this document

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,BsonValue>

Overrides:

equals in class BsonDocument

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,BsonValue>

Overrides:

hashCode in class BsonDocument

clone

public BsonDocument clone()

Overrides:

clone in class BsonDocument