BSONBinaryWriter

java.lang.Object
- com.mongodb.BSONWriter
- - com.mongodb.BSONBinaryWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
class BSONBinaryWriter
extends BSONWriter
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class BSONBinaryWriter.Context

(package private) class BSONBinaryWriter.Mark
- Nested classes/interfaces inherited from class com.mongodb.BSONWriter
  BSONWriter.State

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`BSONBinaryWriter.Context`
`(package private) class`	`BSONBinaryWriter.Mark`

Field Summary

Fields
Modifier and Type	Field and Description
`private BSONBinaryWriterSettings`	`binaryWriterSettings`
`private OutputBuffer`	`buffer`
`private BSONBinaryWriter.Mark`	`mark`
`private java.util.Stack<java.lang.Integer>`	`maxDocumentSizeStack`

Constructor Summary

Constructors
Constructor and Description
`BSONBinaryWriter(BSONWriterSettings settings, BSONBinaryWriterSettings binaryWriterSettings, OutputBuffer buffer)`
`BSONBinaryWriter(OutputBuffer buffer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`backpatchSize()`
`void`	`close()` Closes the writer.
`void`	`encodeDocument(DBEncoder encoder, DBObject dbObject)`
`void`	`flush()` Flushes any pending data to the output destination.
`OutputBuffer`	`getBuffer()` Gets the output buffer that is backing this instance.
`protected BSONBinaryWriter.Context`	`getContext()`
`void`	`mark()`
`void`	`popMaxDocumentSize()`
`void`	`pushMaxDocumentSize(int maxDocumentSize)`
`void`	`reset()`
`private void`	`throwIfSizeExceedsLimit(int size)`
`void`	`writeBinaryData(Binary binary)` Writes a BSON Binary data element to the writer.
`void`	`writeBoolean(boolean value)` Writes a BSON Boolean to the writer.
`private void`	`writeCurrentName()`
`void`	`writeDateTime(long value)` Writes a BSON DateTime to the writer.
`void`	`writeDouble(double value)` Writes a BSON Double 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`	`writeInt64(long value)` Writes a BSON Int64 to the writer.
`void`	`writeJavaScript(java.lang.String code)` Writes a BSON JavaScript to the writer.
`void`	`writeJavaScriptWithScope(java.lang.String code)` Writes a BSON JavaScript to the writer (call WriteStartDocument to start writing the scope).
`void`	`writeMaxKey()` Writes a BSON MaxKey to the writer.
`void`	`writeMinKey()` Writes a BSON MinKey to the writer.
`void`	`writeNull()` Writes a BSON null to the writer.
`void`	`writeObjectId(ObjectId objectId)` Writes a BSON ObjectId to the writer.
`void`	`writeStartArray()` Writes the start of a BSON array to the writer.
`void`	`writeStartDocument()` Writes the start of a BSON document to the writer.
`void`	`writeString(java.lang.String value)` Writes a BSON String to the writer.
`void`	`writeSymbol(java.lang.String value)` Writes a BSON Symbol to the writer.
`void`	`writeTimestamp(BSONTimestamp value)` Writes a BSON Timestamp to the writer.
`void`	`writeUndefined()` Writes a BSON undefined to the writer.

Methods inherited from class com.mongodb.BSONWriter
checkPreconditions, checkState, getName, getNextState, getState, isClosed, setContext, setState, throwInvalidContextType, throwInvalidState, writeBinaryData, writeBoolean, writeDateTime, writeDouble, writeInt32, writeInt64, writeJavaScript, writeJavaScriptWithScope, writeMaxKey, writeMinKey, writeName, writeNull, writeObjectId, writeStartArray, writeStartDocument, writeString, writeSymbol, writeTimestamp, writeUndefined

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - binaryWriterSettings
```
private final BSONBinaryWriterSettings binaryWriterSettings
```
  - buffer
```
private final OutputBuffer buffer
```
  - maxDocumentSizeStack
```
private final java.util.Stack<java.lang.Integer> maxDocumentSizeStack
```
  - mark
```
private BSONBinaryWriter.Mark mark
```
- Constructor Detail
  - BSONBinaryWriter
```
public BSONBinaryWriter(OutputBuffer buffer)
```
  - BSONBinaryWriter
```
public BSONBinaryWriter(BSONWriterSettings settings,
                        BSONBinaryWriterSettings binaryWriterSettings,
                        OutputBuffer buffer)
```
- Method Detail
  - close
```
public void close()
```
    Description copied from class: BSONWriter
    
    Closes the writer.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class BSONWriter
  - getBuffer
```
public OutputBuffer getBuffer()
```
    Gets the output buffer that is backing this instance.
    
    Returns:
    
    the buffer
  - flush
```
public void flush()
```
    Description copied from class: BSONWriter
    
    Flushes any pending data to the output destination.
    
    Specified by:
    
    flush in class BSONWriter
  - getContext
```
protected BSONBinaryWriter.Context getContext()
```
    Overrides:
    
    getContext in class BSONWriter
  - writeBinaryData
```
public void writeBinaryData(Binary binary)
```
    Description copied from class: BSONWriter
    
    Writes a BSON Binary data element to the writer.
    
    Specified by:
    
    writeBinaryData in class BSONWriter
    
    Parameters:
    
    binary - The Binary data.
  - writeBoolean
```
public void writeBoolean(boolean value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON Boolean to the writer.
    
    Specified by:
    
    writeBoolean in class BSONWriter
    
    Parameters:
    
    value - The Boolean value.
  - writeDateTime
```
public void writeDateTime(long value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON DateTime to the writer.
    
    Specified by:
    
    writeDateTime in class BSONWriter
    
    Parameters:
    
    value - The number of milliseconds since the Unix epoch.
  - writeDouble
```
public void writeDouble(double value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON Double to the writer.
    
    Specified by:
    
    writeDouble in class BSONWriter
    
    Parameters:
    
    value - The Double value.
  - writeInt32
```
public void writeInt32(int value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON Int32 to the writer.
    
    Specified by:
    
    writeInt32 in class BSONWriter
    
    Parameters:
    
    value - The Int32 value.
  - writeInt64
```
public void writeInt64(long value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON Int64 to the writer.
    
    Specified by:
    
    writeInt64 in class BSONWriter
    
    Parameters:
    
    value - The Int64 value.
  - writeJavaScript
```
public void writeJavaScript(java.lang.String code)
```
    Description copied from class: BSONWriter
    
    Writes a BSON JavaScript to the writer.
    
    Specified by:
    
    writeJavaScript in class BSONWriter
    
    Parameters:
    
    code - The JavaScript code.
  - writeJavaScriptWithScope
```
public void writeJavaScriptWithScope(java.lang.String code)
```
    Description copied from class: BSONWriter
    
    Writes a BSON JavaScript to the writer (call WriteStartDocument to start writing the scope).
    
    Specified by:
    
    writeJavaScriptWithScope in class BSONWriter
    
    Parameters:
    
    code - The JavaScript code.
  - writeMaxKey
```
public void writeMaxKey()
```
    Description copied from class: BSONWriter
    
    Writes a BSON MaxKey to the writer.
    
    Specified by:
    
    writeMaxKey in class BSONWriter
  - writeMinKey
```
public void writeMinKey()
```
    Description copied from class: BSONWriter
    
    Writes a BSON MinKey to the writer.
    
    Specified by:
    
    writeMinKey in class BSONWriter
  - writeNull
```
public void writeNull()
```
    Description copied from class: BSONWriter
    
    Writes a BSON null to the writer.
    
    Specified by:
    
    writeNull in class BSONWriter
  - writeObjectId
```
public void writeObjectId(ObjectId objectId)
```
    Description copied from class: BSONWriter
    
    Writes a BSON ObjectId to the writer.
    
    Specified by:
    
    writeObjectId in class BSONWriter
    
    Parameters:
    
    objectId - The ObjectId value.
  - writeString
```
public void writeString(java.lang.String value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON String to the writer.
    
    Specified by:
    
    writeString in class BSONWriter
    
    Parameters:
    
    value - The String value.
  - writeSymbol
```
public void writeSymbol(java.lang.String value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON Symbol to the writer.
    
    Specified by:
    
    writeSymbol in class BSONWriter
    
    Parameters:
    
    value - The symbol.
  - writeTimestamp
```
public void writeTimestamp(BSONTimestamp value)
```
    Description copied from class: BSONWriter
    
    Writes a BSON Timestamp to the writer.
    
    Specified by:
    
    writeTimestamp in class BSONWriter
    
    Parameters:
    
    value - The combined timestamp/increment value.
  - writeUndefined
```
public void writeUndefined()
```
    Description copied from class: BSONWriter
    
    Writes a BSON undefined to the writer.
    
    Specified by:
    
    writeUndefined in class BSONWriter
  - writeStartArray
```
public void writeStartArray()
```
    Description copied from class: BSONWriter
    
    Writes the start of a BSON array to the writer.
    
    Overrides:
    
    writeStartArray in class BSONWriter
  - writeStartDocument
```
public void writeStartDocument()
```
    Description copied from class: BSONWriter
    
    Writes the start of a BSON document to the writer.
    
    Overrides:
    
    writeStartDocument in class BSONWriter
  - writeEndArray
```
public void writeEndArray()
```
    Description copied from class: BSONWriter
    
    Writes the end of a BSON array to the writer.
    
    Overrides:
    
    writeEndArray in class BSONWriter
  - writeEndDocument
```
public void writeEndDocument()
```
    Description copied from class: BSONWriter
    
    Writes the end of a BSON document to the writer.
    
    Overrides:
    
    writeEndDocument in class BSONWriter
  - encodeDocument
```
public void encodeDocument(DBEncoder encoder,
                           DBObject dbObject)
```
  - pushMaxDocumentSize
```
public void pushMaxDocumentSize(int maxDocumentSize)
```
  - popMaxDocumentSize
```
public void popMaxDocumentSize()
```
  - mark
```
public void mark()
```
  - reset
```
public void reset()
```
  - writeCurrentName
```
private void writeCurrentName()
```
  - backpatchSize
```
private void backpatchSize()
```
  - throwIfSizeExceedsLimit
```
private void throwIfSizeExceedsLimit(int size)
```

Class BSONBinaryWriter

Nested Class Summary

Nested classes/interfaces inherited from class com.mongodb.BSONWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.mongodb.BSONWriter

Methods inherited from class java.lang.Object

Field Detail

binaryWriterSettings

buffer

maxDocumentSizeStack

mark

Constructor Detail

BSONBinaryWriter

BSONBinaryWriter

Method Detail

close

getBuffer

flush

getContext

writeBinaryData

writeBoolean

writeDateTime

writeDouble

writeInt32

writeInt64

writeJavaScript

writeJavaScriptWithScope

writeMaxKey

writeMinKey

writeNull

writeObjectId

writeString

writeSymbol

writeTimestamp

writeUndefined

writeStartArray

writeStartDocument

writeEndArray

writeEndDocument

encodeDocument

pushMaxDocumentSize

popMaxDocumentSize

mark

reset

writeCurrentName

backpatchSize

throwIfSizeExceedsLimit