Package org.bson
Class BsonDocumentWriter
java.lang.Object
org.bson.AbstractBsonWriter
org.bson.BsonDocumentWriter
- All Implemented Interfaces:
Closeable
,AutoCloseable
,BsonWriter
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bson.AbstractBsonWriter
AbstractBsonWriter.Mark, AbstractBsonWriter.State
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
doWriteBinaryData
(BsonBinary value) Handles the logic of writing aBsonBinary
valuevoid
doWriteBoolean
(boolean value) Handles the logic of writing a boolean valueprotected void
doWriteDateTime
(long value) Handles the logic of writing a date time valueprotected void
doWriteDBPointer
(BsonDbPointer value) Handles the logic of writing a DbPointer valueprotected void
doWriteDecimal128
(Decimal128 value) Handles the logic of writing a Decimal128 valueprotected void
doWriteDouble
(double value) Handles the logic of writing a Double valueprotected void
Handles the logic of writing the end of an arrayprotected void
Handles the logic of writing the end of a documentprotected void
doWriteInt32
(int value) Handles the logic of writing an int32 valueprotected void
doWriteInt64
(long value) Handles the logic of writing an int64 valueprotected void
doWriteJavaScript
(String value) Handles the logic of writing a JavaScript functionprotected void
doWriteJavaScriptWithScope
(String value) Handles the logic of writing a scoped JavaScript functionprotected void
Handles the logic of writing a Max keyprotected void
Handles the logic of writing a Min keyvoid
Handles the logic of writing a Null valuevoid
doWriteObjectId
(ObjectId value) Handles the logic of writing an ObjectIdvoid
Handles the logic of writing a regular expressionprotected void
Handles the logic to start writing an arrayprotected void
Handles the logic to start writing a documentvoid
doWriteString
(String value) Handles the logic of writing a Stringvoid
doWriteSymbol
(String value) Handles the logic of writing a Symbolvoid
doWriteTimestamp
(BsonTimestamp value) Handles the logic of writing a timestampvoid
Handles the logic of writing an Undefined valuevoid
flush()
Flushes any pending data to the output destination.protected org.bson.BsonDocumentWriter.Context
Get the context, which will indicate which state the writer is in, for example which part of a document it's currently writing.Gets the document that the writer is writing to.Methods inherited from class org.bson.AbstractBsonWriter
abortPipe, checkPreconditions, checkState, close, doWriteName, getName, getNextState, getState, isClosed, pipe, pipe, pipeExtraElements, setContext, setState, throwInvalidContextType, throwInvalidState, 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
-
Constructor Details
-
BsonDocumentWriter
Construct a new instance.- Parameters:
document
- the document to write to
-
-
Method Details
-
getDocument
Gets the document that the writer is writing to.- Returns:
- the document
-
doWriteStartDocument
protected void doWriteStartDocument()Description copied from class:AbstractBsonWriter
Handles the logic to start writing a document- Specified by:
doWriteStartDocument
in classAbstractBsonWriter
-
doWriteEndDocument
protected void doWriteEndDocument()Description copied from class:AbstractBsonWriter
Handles the logic of writing the end of a document- Specified by:
doWriteEndDocument
in classAbstractBsonWriter
-
doWriteStartArray
protected void doWriteStartArray()Description copied from class:AbstractBsonWriter
Handles the logic to start writing an array- Specified by:
doWriteStartArray
in classAbstractBsonWriter
-
doWriteEndArray
protected void doWriteEndArray()Description copied from class:AbstractBsonWriter
Handles the logic of writing the end of an array- Specified by:
doWriteEndArray
in classAbstractBsonWriter
-
doWriteBinaryData
Description copied from class:AbstractBsonWriter
Handles the logic of writing aBsonBinary
value- Specified by:
doWriteBinaryData
in classAbstractBsonWriter
- Parameters:
value
- theBsonBinary
value to write
-
doWriteBoolean
public void doWriteBoolean(boolean value) Description copied from class:AbstractBsonWriter
Handles the logic of writing a boolean value- Specified by:
doWriteBoolean
in classAbstractBsonWriter
- Parameters:
value
- theboolean
value to write
-
doWriteDateTime
protected void doWriteDateTime(long value) Description copied from class:AbstractBsonWriter
Handles the logic of writing a date time value- Specified by:
doWriteDateTime
in classAbstractBsonWriter
- Parameters:
value
- thelong
value to write
-
doWriteDBPointer
Description copied from class:AbstractBsonWriter
Handles the logic of writing a DbPointer value- Specified by:
doWriteDBPointer
in classAbstractBsonWriter
- Parameters:
value
- theBsonDbPointer
value to write
-
doWriteDouble
protected void doWriteDouble(double value) Description copied from class:AbstractBsonWriter
Handles the logic of writing a Double value- Specified by:
doWriteDouble
in classAbstractBsonWriter
- Parameters:
value
- thedouble
value to write
-
doWriteInt32
protected void doWriteInt32(int value) Description copied from class:AbstractBsonWriter
Handles the logic of writing an int32 value- Specified by:
doWriteInt32
in classAbstractBsonWriter
- Parameters:
value
- theint
value to write
-
doWriteInt64
protected void doWriteInt64(long value) Description copied from class:AbstractBsonWriter
Handles the logic of writing an int64 value- Specified by:
doWriteInt64
in classAbstractBsonWriter
- Parameters:
value
- thelong
value to write
-
doWriteDecimal128
Description copied from class:AbstractBsonWriter
Handles the logic of writing a Decimal128 value- Specified by:
doWriteDecimal128
in classAbstractBsonWriter
- Parameters:
value
- theDecimal128
value to write
-
doWriteJavaScript
Description copied from class:AbstractBsonWriter
Handles the logic of writing a JavaScript function- Specified by:
doWriteJavaScript
in classAbstractBsonWriter
- Parameters:
value
- theString
value to write
-
doWriteJavaScriptWithScope
Description copied from class:AbstractBsonWriter
Handles the logic of writing a scoped JavaScript function- Specified by:
doWriteJavaScriptWithScope
in classAbstractBsonWriter
- Parameters:
value
- theboolean
value to write
-
doWriteMaxKey
protected void doWriteMaxKey()Description copied from class:AbstractBsonWriter
Handles the logic of writing a Max key- Specified by:
doWriteMaxKey
in classAbstractBsonWriter
-
doWriteMinKey
protected void doWriteMinKey()Description copied from class:AbstractBsonWriter
Handles the logic of writing a Min key- Specified by:
doWriteMinKey
in classAbstractBsonWriter
-
doWriteNull
public void doWriteNull()Description copied from class:AbstractBsonWriter
Handles the logic of writing a Null value- Specified by:
doWriteNull
in classAbstractBsonWriter
-
doWriteObjectId
Description copied from class:AbstractBsonWriter
Handles the logic of writing an ObjectId- Specified by:
doWriteObjectId
in classAbstractBsonWriter
- Parameters:
value
- theObjectId
value to write
-
doWriteRegularExpression
Description copied from class:AbstractBsonWriter
Handles the logic of writing a regular expression- Specified by:
doWriteRegularExpression
in classAbstractBsonWriter
- Parameters:
value
- theBsonRegularExpression
value to write
-
doWriteString
Description copied from class:AbstractBsonWriter
Handles the logic of writing a String- Specified by:
doWriteString
in classAbstractBsonWriter
- Parameters:
value
- theString
value to write
-
doWriteSymbol
Description copied from class:AbstractBsonWriter
Handles the logic of writing a Symbol- Specified by:
doWriteSymbol
in classAbstractBsonWriter
- Parameters:
value
- theboolean
value to write
-
doWriteTimestamp
Description copied from class:AbstractBsonWriter
Handles the logic of writing a timestamp- Specified by:
doWriteTimestamp
in classAbstractBsonWriter
- Parameters:
value
- theBsonTimestamp
value to write
-
doWriteUndefined
public void doWriteUndefined()Description copied from class:AbstractBsonWriter
Handles the logic of writing an Undefined value- Specified by:
doWriteUndefined
in classAbstractBsonWriter
-
flush
public void flush()Description copied from interface:BsonWriter
Flushes any pending data to the output destination. -
getContext
protected org.bson.BsonDocumentWriter.Context getContext()Description copied from class:AbstractBsonWriter
Get the context, which will indicate which state the writer is in, for example which part of a document it's currently writing.- Overrides:
getContext
in classAbstractBsonWriter
- Returns:
- the current context.
-