org.bson

Class BsonBinaryWriter

java.lang.Object

org.bson.AbstractBsonWriter

org.bson.BsonBinaryWriter

All Implemented Interfaces:

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

public class BsonBinaryWriter
extends AbstractBsonWriter

A BsonWriter implementation that writes to a binary stream of data. This is the most commonly used implementation.

Since:

3.0

Nested Class Summary

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

AbstractBsonWriter.State

Constructor Summary

Constructors

Constructor and Description
BsonBinaryWriter(BsonOutput bsonOutput) Construct an instance.
BsonBinaryWriter(BsonOutput bsonOutput, FieldNameValidator validator) Construct an instance.
BsonBinaryWriter(BsonWriterSettings settings, BsonBinaryWriterSettings binaryWriterSettings, BsonOutput bsonOutput) Construct an instance.
BsonBinaryWriter(BsonWriterSettings settings, BsonBinaryWriterSettings binaryWriterSettings, BsonOutput bsonOutput, FieldNameValidator validator) Construct an instance.

Method Summary

Modifier and Type	Method and Description
void	close()
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.
BsonBinaryWriterSettings	getBinaryWriterSettings()
BsonOutput	getBsonOutput() Gets the BSON output backing this instance.
void	mark() Create a snapshot of this writer's context at a point in time.
void	pipe(BsonReader reader) Reads a single document from a BsonReader and writes it to this.
void	pipe(BsonReader reader, java.util.List<BsonElement> extraElements) Reads a single document from the given BsonReader and writes it to this, appending the given extra elements to the document.
void	popMaxDocumentSize() Reset the maximum document size to its previous value.
void	pushMaxDocumentSize(int maxDocumentSize) Sets a maximum size for documents from this point.
void	reset() Resets this writer to the last mark() saved.

Methods inherited from class org.bson.AbstractBsonWriter

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

BsonBinaryWriter

public BsonBinaryWriter(BsonOutput bsonOutput,
                        FieldNameValidator validator)

Construct an instance.

Parameters:

bsonOutput - the output to write to

validator - the field name validator to apply

BsonBinaryWriter

public BsonBinaryWriter(BsonOutput bsonOutput)

Construct an instance.

Parameters:

bsonOutput - the output to write to

BsonBinaryWriter

public BsonBinaryWriter(BsonWriterSettings settings,
                        BsonBinaryWriterSettings binaryWriterSettings,
                        BsonOutput bsonOutput)

Construct an instance.

Parameters:

settings - the generic BsonWriter settings

binaryWriterSettings - the settings specific to a BsonBinaryWriter

bsonOutput - the output to write to

BsonBinaryWriter

public BsonBinaryWriter(BsonWriterSettings settings,
                        BsonBinaryWriterSettings binaryWriterSettings,
                        BsonOutput bsonOutput,
                        FieldNameValidator validator)

Construct an instance.

Parameters:

settings - the generic BsonWriter settings

binaryWriterSettings - the settings specific to a BsonBinaryWriter

bsonOutput - the output to write to

validator - the field name validator to apply

Method Detail

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class AbstractBsonWriter

getBsonOutput

public BsonOutput getBsonOutput()

Gets the BSON output backing this instance.

Returns:

the BSON output

getBinaryWriterSettings

public BsonBinaryWriterSettings getBinaryWriterSettings()

Returns:

the BsonBinaryWriterSettings

Since:

3.6

flush

public void flush()

Description copied from interface: BsonWriter

Flushes any pending data to the output destination.

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

pipe

public void pipe(BsonReader reader)

Description copied from interface: BsonWriter

Reads a single document from a BsonReader and writes it to this.

Specified by:

pipe in interface BsonWriter

Overrides:

pipe in class AbstractBsonWriter

Parameters:

reader - The source.

pipe

public void pipe(BsonReader reader,
                 java.util.List<BsonElement> extraElements)

Description copied from class: AbstractBsonWriter

Reads a single document from the given BsonReader and writes it to this, appending the given extra elements to the document.

Overrides:

pipe in class AbstractBsonWriter

Parameters:

reader - the source of the document

extraElements - the extra elements to append to the document

pushMaxDocumentSize

public void pushMaxDocumentSize(int maxDocumentSize)

Sets a maximum size for documents from this point.

Parameters:

maxDocumentSize - the maximum document size.

popMaxDocumentSize

public void popMaxDocumentSize()

Reset the maximum document size to its previous value.

mark

public void mark()

Create a snapshot of this writer's context at a point in time.

reset

public void reset()

Resets this writer to the last mark() saved.

Throws:

java.lang.IllegalStateException - if mark() was not called prior to reset.