org.bson

Class BsonDocumentWriter

java.lang.Object

org.bson.AbstractBsonWriter

org.bson.BsonDocumentWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BsonWriter

public class BsonDocumentWriter
extends AbstractBsonWriter

A BsonWriter implementation that writes to an instance of BsonDocument. This can be used to encode an object into a BsonDocument using an Encoder.

Since:

3.0

See Also:

BsonDocument, Encoder

Nested Class Summary

Nested classes/interfaces inherited from class org.bson.AbstractBsonWriter

AbstractBsonWriter.State

Constructor Summary

Constructors

Constructor and Description
BsonDocumentWriter(BsonDocument document) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	doWriteBoolean(boolean value) Handles the logic of writing a boolean value
void	doWriteNull() Handles the logic of writing a Null value
void	doWriteObjectId(ObjectId value) Handles the logic of writing an ObjectId
void	doWriteRegularExpression(BsonRegularExpression value) Handles the logic of writing a regular expression
void	doWriteString(java.lang.String value) Handles the logic of writing a String
void	doWriteSymbol(java.lang.String value) Handles the logic of writing a Symbol
void	doWriteTimestamp(BsonTimestamp value) Handles the logic of writing a timestamp
void	doWriteUndefined() Handles the logic of writing an Undefined value
void	flush() Flushes any pending data to the output destination.
BsonDocument	getDocument() Gets the document that the writer is writing to.

Methods inherited from class org.bson.AbstractBsonWriter

close, pipe, pipe, writeBinaryData, writeBinaryData, writeBoolean, writeBoolean, writeDateTime, writeDateTime, writeDBPointer, writeDBPointer, writeDecimal128, writeDecimal128, writeDouble, writeDouble, writeEndArray, writeEndDocument, writeInt32, writeInt32, writeInt64, writeInt64, writeJavaScript, writeJavaScript, writeJavaScriptWithScope, writeJavaScriptWithScope, writeMaxKey, writeMaxKey, writeMinKey, writeMinKey, writeName, writeNull, writeNull, writeObjectId, writeObjectId, writeRegularExpression, writeRegularExpression, writeStartArray, writeStartArray, writeStartDocument, writeStartDocument, writeString, writeString, writeSymbol, writeSymbol, writeTimestamp, writeTimestamp, writeUndefined, writeUndefined

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BsonDocumentWriter

public BsonDocumentWriter(BsonDocument document)

Construct a new instance.

Parameters:

document - the document to write to

Method Detail

getDocument

public BsonDocument getDocument()

Gets the document that the writer is writing to.

Returns:

the document

doWriteBoolean

public void doWriteBoolean(boolean value)

Description copied from class: AbstractBsonWriter

Handles the logic of writing a boolean value

Parameters:

value - the boolean value to write

doWriteNull

public void doWriteNull()

Description copied from class: AbstractBsonWriter

Handles the logic of writing a Null value

doWriteObjectId

public void doWriteObjectId(ObjectId value)

Description copied from class: AbstractBsonWriter

Handles the logic of writing an ObjectId

Parameters:

value - the ObjectId value to write

doWriteRegularExpression

public void doWriteRegularExpression(BsonRegularExpression value)

Description copied from class: AbstractBsonWriter

Handles the logic of writing a regular expression

Parameters:

value - the BsonRegularExpression value to write

doWriteString

public void doWriteString(java.lang.String value)

Description copied from class: AbstractBsonWriter

Handles the logic of writing a String

Parameters:

value - the String value to write

doWriteSymbol

public void doWriteSymbol(java.lang.String value)

Description copied from class: AbstractBsonWriter

Handles the logic of writing a Symbol

Parameters:

value - the boolean value to write

doWriteTimestamp

public void doWriteTimestamp(BsonTimestamp value)

Description copied from class: AbstractBsonWriter

Handles the logic of writing a timestamp

Parameters:

value - the BsonTimestamp value to write

doWriteUndefined

public void doWriteUndefined()

Description copied from class: AbstractBsonWriter

Handles the logic of writing an Undefined value

flush

public void flush()

Description copied from interface: BsonWriter

Flushes any pending data to the output destination.