BsonWriter

All Known Implementing Classes:

AbstractBsonWriter, BsonBinaryWriter, BsonDocumentWriter, JsonWriter
```
public interface BsonWriter
```
An interface for writing a logical BSON document using a push-oriented API.

Since:

3.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`flush()`	Flushes any pending data to the output destination.
`void`	`pipe(BsonReader reader)`	Reads a single document from a BsonReader and writes it to this.
`void`	`writeBinaryData(String name, BsonBinary binary)`	Writes a BSON Binary data element to the writer.
`void`	`writeBinaryData(BsonBinary binary)`	Writes a BSON Binary data element to the writer.
`void`	`writeBoolean(boolean value)`	Writes a BSON Boolean to the writer.
`void`	`writeBoolean(String name, boolean value)`	Writes a BSON Boolean element to the writer.
`void`	`writeDateTime(long value)`	Writes a BSON DateTime to the writer.
`void`	`writeDateTime(String name, long value)`	Writes a BSON DateTime element to the writer.
`void`	`writeDBPointer(String name, BsonDbPointer value)`	Writes a BSON DBPointer element to the writer.
`void`	`writeDBPointer(BsonDbPointer value)`	Writes a BSON DBPointer to the writer.
`void`	`writeDecimal128(String name, Decimal128 value)`	Writes a BSON Decimal128 element to the writer.
`void`	`writeDecimal128(Decimal128 value)`	Writes a BSON Decimal128 to the writer.
`void`	`writeDouble(double value)`	Writes a BSON Double to the writer.
`void`	`writeDouble(String name, double value)`	Writes a BSON Double element to the writer.
`void`	`writeEndArray()`	Writes the end of a BSON array to the writer.
`void`	`writeEndDocument()`	Writes the end of a BSON document to the writer.
`void`	`writeInt32(int value)`	Writes a BSON Int32 to the writer.
`void`	`writeInt32(String name, int value)`	Writes a BSON Int32 element to the writer.
`void`	`writeInt64(long value)`	Writes a BSON Int64 to the writer.
`void`	`writeInt64(String name, long value)`	Writes a BSON Int64 element to the writer.
`void`	`writeJavaScript(String code)`	Writes a BSON JavaScript to the writer.
`void`	`writeJavaScript(String name, String code)`	Writes a BSON JavaScript element to the writer.
`void`	`writeJavaScriptWithScope(String code)`	Writes a BSON JavaScript to the writer (call WriteStartDocument to start writing the scope).
`void`	`writeJavaScriptWithScope(String name, String code)`	Writes a BSON JavaScript element to the writer (call WriteStartDocument to start writing the scope).
`void`	`writeMaxKey()`	Writes a BSON MaxKey to the writer.
`void`	`writeMaxKey(String name)`	Writes a BSON MaxKey element to the writer.
`void`	`writeMinKey()`	Writes a BSON MinKey to the writer.
`void`	`writeMinKey(String name)`	Writes a BSON MinKey element to the writer.
`void`	`writeName(String name)`	Writes the name of an element to the writer.
`void`	`writeNull()`	Writes a BSON null to the writer.
`void`	`writeNull(String name)`	Writes a BSON null element to the writer.
`void`	`writeObjectId(String name, ObjectId objectId)`	Writes a BSON ObjectId element to the writer.
`void`	`writeObjectId(ObjectId objectId)`	Writes a BSON ObjectId to the writer.
`void`	`writeRegularExpression(String name, BsonRegularExpression regularExpression)`	Writes a BSON regular expression element to the writer.
`void`	`writeRegularExpression(BsonRegularExpression regularExpression)`	Writes a BSON regular expression to the writer.
`void`	`writeStartArray()`	Writes the start of a BSON array to the writer.
`void`	`writeStartArray(String name)`	Writes the start of a BSON array element to the writer.
`void`	`writeStartDocument()`	Writes the start of a BSON document to the writer.
`void`	`writeStartDocument(String name)`	Writes the start of a BSON document element to the writer.
`void`	`writeString(String value)`	Writes a BSON String to the writer.
`void`	`writeString(String name, String value)`	Writes a BSON String element to the writer.
`void`	`writeSymbol(String value)`	Writes a BSON Symbol to the writer.
`void`	`writeSymbol(String name, String value)`	Writes a BSON Symbol element to the writer.
`void`	`writeTimestamp(String name, BsonTimestamp value)`	Writes a BSON Timestamp element to the writer.
`void`	`writeTimestamp(BsonTimestamp value)`	Writes a BSON Timestamp to the writer.
`void`	`writeUndefined()`	Writes a BSON undefined to the writer.
`void`	`writeUndefined(String name)`	Writes a BSON undefined element to the writer.

- Method Detail
  - flush
```
void flush()
```
    Flushes any pending data to the output destination.
  - writeBinaryData
```
void writeBinaryData(BsonBinary binary)
```
    Writes a BSON Binary data element to the writer.
    
    Parameters:
    
    binary - The Binary data.
  - writeBinaryData
```
void writeBinaryData(String name,
                     BsonBinary binary)
```
    Writes a BSON Binary data element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    binary - The Binary data value.
  - writeBoolean
```
void writeBoolean(boolean value)
```
    Writes a BSON Boolean to the writer.
    
    Parameters:
    
    value - The Boolean value.
  - writeBoolean
```
void writeBoolean(String name,
                  boolean value)
```
    Writes a BSON Boolean element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Boolean value.
  - writeDateTime
```
void writeDateTime(long value)
```
    Writes a BSON DateTime to the writer.
    
    Parameters:
    
    value - The number of milliseconds since the Unix epoch.
  - writeDateTime
```
void writeDateTime(String name,
                   long value)
```
    Writes a BSON DateTime element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The number of milliseconds since the Unix epoch.
  - writeDBPointer
```
void writeDBPointer(BsonDbPointer value)
```
    Writes a BSON DBPointer to the writer.
    
    Parameters:
    
    value - The DBPointer to write
  - writeDBPointer
```
void writeDBPointer(String name,
                    BsonDbPointer value)
```
    Writes a BSON DBPointer element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The DBPointer to write
  - writeDouble
```
void writeDouble(double value)
```
    Writes a BSON Double to the writer.
    
    Parameters:
    
    value - The Double value.
  - writeDouble
```
void writeDouble(String name,
                 double value)
```
    Writes a BSON Double element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Double value.
  - writeEndArray
```
void writeEndArray()
```
    Writes the end of a BSON array to the writer.
  - writeEndDocument
```
void writeEndDocument()
```
    Writes the end of a BSON document to the writer.
  - writeInt32
```
void writeInt32(int value)
```
    Writes a BSON Int32 to the writer.
    
    Parameters:
    
    value - The Int32 value.
  - writeInt32
```
void writeInt32(String name,
                int value)
```
    Writes a BSON Int32 element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Int32 value.
  - writeInt64
```
void writeInt64(long value)
```
    Writes a BSON Int64 to the writer.
    
    Parameters:
    
    value - The Int64 value.
  - writeInt64
```
void writeInt64(String name,
                long value)
```
    Writes a BSON Int64 element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Int64 value.
  - writeDecimal128
```
void writeDecimal128(Decimal128 value)
```
    Writes a BSON Decimal128 to the writer.
    
    Parameters:
    
    value - The Decimal128 value.
    
    Since:
    
    3.4
  - writeDecimal128
```
void writeDecimal128(String name,
                     Decimal128 value)
```
    Writes a BSON Decimal128 element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Decimal128 value.
    
    Since:
    
    3.4
  - writeJavaScript
```
void writeJavaScript(String code)
```
    Writes a BSON JavaScript to the writer.
    
    Parameters:
    
    code - The JavaScript code.
  - writeJavaScript
```
void writeJavaScript(String name,
                     String code)
```
    Writes a BSON JavaScript element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    code - The JavaScript code.
  - writeJavaScriptWithScope
```
void writeJavaScriptWithScope(String code)
```
    Writes a BSON JavaScript to the writer (call WriteStartDocument to start writing the scope).
    
    Parameters:
    
    code - The JavaScript code.
  - writeJavaScriptWithScope
```
void writeJavaScriptWithScope(String name,
                              String code)
```
    Writes a BSON JavaScript element to the writer (call WriteStartDocument to start writing the scope).
    
    Parameters:
    
    name - The name of the element.
    
    code - The JavaScript code.
  - writeMaxKey
```
void writeMaxKey()
```
    Writes a BSON MaxKey to the writer.
  - writeMaxKey
```
void writeMaxKey(String name)
```
    Writes a BSON MaxKey element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeMinKey
```
void writeMinKey()
```
    Writes a BSON MinKey to the writer.
  - writeMinKey
```
void writeMinKey(String name)
```
    Writes a BSON MinKey element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeName
```
void writeName(String name)
```
    Writes the name of an element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeNull
```
void writeNull()
```
    Writes a BSON null to the writer.
  - writeNull
```
void writeNull(String name)
```
    Writes a BSON null element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeObjectId
```
void writeObjectId(ObjectId objectId)
```
    Writes a BSON ObjectId to the writer.
    
    Parameters:
    
    objectId - The ObjectId value.
  - writeObjectId
```
void writeObjectId(String name,
                   ObjectId objectId)
```
    Writes a BSON ObjectId element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    objectId - The ObjectId value.
  - writeRegularExpression
```
void writeRegularExpression(BsonRegularExpression regularExpression)
```
    Writes a BSON regular expression to the writer.
    
    Parameters:
    
    regularExpression - the regular expression to write.
  - writeRegularExpression
```
void writeRegularExpression(String name,
                            BsonRegularExpression regularExpression)
```
    Writes a BSON regular expression element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    regularExpression - The RegularExpression value.
  - writeStartArray
```
void writeStartArray()
```
    Writes the start of a BSON array to the writer.
    
    Throws:
    
    BsonSerializationException - if maximum serialization depth exceeded.
  - writeStartArray
```
void writeStartArray(String name)
```
    Writes the start of a BSON array element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeStartDocument
```
void writeStartDocument()
```
    Writes the start of a BSON document to the writer.
    
    Throws:
    
    BsonSerializationException - if maximum serialization depth exceeded.
  - writeStartDocument
```
void writeStartDocument(String name)
```
    Writes the start of a BSON document element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeString
```
void writeString(String value)
```
    Writes a BSON String to the writer.
    
    Parameters:
    
    value - The String value.
  - writeString
```
void writeString(String name,
                 String value)
```
    Writes a BSON String element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The String value.
  - writeSymbol
```
void writeSymbol(String value)
```
    Writes a BSON Symbol to the writer.
    
    Parameters:
    
    value - The symbol.
  - writeSymbol
```
void writeSymbol(String name,
                 String value)
```
    Writes a BSON Symbol element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The symbol.
  - writeTimestamp
```
void writeTimestamp(BsonTimestamp value)
```
    Writes a BSON Timestamp to the writer.
    
    Parameters:
    
    value - The combined timestamp/increment value.
  - writeTimestamp
```
void writeTimestamp(String name,
                    BsonTimestamp value)
```
    Writes a BSON Timestamp element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The combined timestamp/increment value.
  - writeUndefined
```
void writeUndefined()
```
    Writes a BSON undefined to the writer.
  - writeUndefined
```
void writeUndefined(String name)
```
    Writes a BSON undefined element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - pipe
```
void pipe(BsonReader reader)
```
    Reads a single document from a BsonReader and writes it to this.
    
    Parameters:
    
    reader - The source.

Interface BsonWriter

Method Summary

Method Detail

flush

writeBinaryData

writeBinaryData

writeBoolean

writeBoolean

writeDateTime

writeDateTime

writeDBPointer

writeDBPointer

writeDouble

writeDouble

writeEndArray

writeEndDocument

writeInt32

writeInt32

writeInt64

writeInt64

writeDecimal128

writeDecimal128

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

pipe