BSONWriter

java.lang.Object
- com.mongodb.BSONWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

BSONBinaryWriter
```
abstract class BSONWriter
extends java.lang.Object
implements java.io.Closeable
```

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`closed`
`private BSONWriter.Context`	`context`
`private java.lang.String`	`currentName`
`private int`	`serializationDepth`
`private BSONWriterSettings`	`settings`
`private BSONWriter.State`	`state`

Constructor Summary

Constructors
Modifier Constructor and Description

protected BSONWriter(BSONWriterSettings settings)
Initializes a new instance of the BSONWriter class.

Constructors
Modifier	Constructor and Description
`protected`	`BSONWriter(BSONWriterSettings settings)` Initializes a new instance of the BSONWriter class.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkPreconditions(java.lang.String methodName, BSONWriter.State... validStates)`
`protected boolean`	`checkState(BSONWriter.State[] validStates)`
`void`	`close()` Closes the writer.
`abstract void`	`flush()` Flushes any pending data to the output destination.
`protected BSONWriter.Context`	`getContext()`
`protected java.lang.String`	`getName()`
`protected BSONWriter.State`	`getNextState()`
`protected BSONWriter.State`	`getState()`
`protected boolean`	`isClosed()`
`protected void`	`setContext(BSONWriter.Context context)`
`protected void`	`setState(BSONWriter.State state)`
`protected void`	`throwInvalidContextType(java.lang.String methodName, BSONContextType actualContextType, BSONContextType... validContextTypes)` Throws an InvalidOperationException when the method called is not valid for the current ContextType.
`protected void`	`throwInvalidState(java.lang.String methodName, BSONWriter.State... validStates)` Throws an InvalidOperationException when the method called is not valid for the current state.
`abstract void`	`writeBinaryData(Binary binary)` Writes a BSON Binary data element to the writer.
`void`	`writeBinaryData(java.lang.String name, Binary binary)` Writes a BSON Binary data element to the writer.
`abstract void`	`writeBoolean(boolean value)` Writes a BSON Boolean to the writer.
`void`	`writeBoolean(java.lang.String name, boolean value)` Writes a BSON Boolean element to the writer.
`abstract void`	`writeDateTime(long value)` Writes a BSON DateTime to the writer.
`void`	`writeDateTime(java.lang.String name, long value)` Writes a BSON DateTime element to the writer.
`abstract void`	`writeDouble(double value)` Writes a BSON Double to the writer.
`void`	`writeDouble(java.lang.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.
`abstract void`	`writeInt32(int value)` Writes a BSON Int32 to the writer.
`void`	`writeInt32(java.lang.String name, int value)` Writes a BSON Int32 element to the writer.
`abstract void`	`writeInt64(long value)` Writes a BSON Int64 to the writer.
`void`	`writeInt64(java.lang.String name, long value)` Writes a BSON Int64 element to the writer.
`abstract void`	`writeJavaScript(java.lang.String code)` Writes a BSON JavaScript to the writer.
`void`	`writeJavaScript(java.lang.String name, java.lang.String code)` Writes a BSON JavaScript element to the writer.
`abstract void`	`writeJavaScriptWithScope(java.lang.String code)` Writes a BSON JavaScript to the writer (call WriteStartDocument to start writing the scope).
`void`	`writeJavaScriptWithScope(java.lang.String name, java.lang.String code)` Writes a BSON JavaScript element to the writer (call WriteStartDocument to start writing the scope).
`abstract void`	`writeMaxKey()` Writes a BSON MaxKey to the writer.
`void`	`writeMaxKey(java.lang.String name)` Writes a BSON MaxKey element to the writer.
`abstract void`	`writeMinKey()` Writes a BSON MinKey to the writer.
`void`	`writeMinKey(java.lang.String name)` Writes a BSON MinKey element to the writer.
`void`	`writeName(java.lang.String name)` Writes the name of an element to the writer.
`abstract void`	`writeNull()` Writes a BSON null to the writer.
`void`	`writeNull(java.lang.String name)` Writes a BSON null element to the writer.
`abstract void`	`writeObjectId(ObjectId objectId)` Writes a BSON ObjectId to the writer.
`void`	`writeObjectId(java.lang.String name, ObjectId objectId)` Writes a BSON ObjectId element to the writer.
`void`	`writeStartArray()` Writes the start of a BSON array to the writer.
`void`	`writeStartArray(java.lang.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(java.lang.String name)` Writes the start of a BSON document element to the writer.
`abstract void`	`writeString(java.lang.String value)` Writes a BSON String to the writer.
`void`	`writeString(java.lang.String name, java.lang.String value)` Writes a BSON String element to the writer.
`abstract void`	`writeSymbol(java.lang.String value)` Writes a BSON Symbol to the writer.
`void`	`writeSymbol(java.lang.String name, java.lang.String value)` Writes a BSON Symbol element to the writer.
`abstract void`	`writeTimestamp(BSONTimestamp value)` Writes a BSON Timestamp to the writer.
`void`	`writeTimestamp(java.lang.String name, BSONTimestamp value)` Writes a BSON Timestamp element to the writer.
`abstract void`	`writeUndefined()` Writes a BSON undefined to the writer.
`void`	`writeUndefined(java.lang.String name)` Writes a BSON undefined element to the writer.

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

- Field Detail
  - settings
```
private final BSONWriterSettings settings
```
  - state
```
private BSONWriter.State state
```
  - context
```
private BSONWriter.Context context
```
  - currentName
```
private java.lang.String currentName
```
  - serializationDepth
```
private int serializationDepth
```
  - closed
```
private boolean closed
```
- Constructor Detail
  - BSONWriter
```
protected BSONWriter(BSONWriterSettings settings)
```
    Initializes a new instance of the BSONWriter class.
    
    Parameters:
    
    settings - The writer settings.
- Method Detail
  - getName
```
protected java.lang.String getName()
```
  - isClosed
```
protected boolean isClosed()
```
  - setState
```
protected void setState(BSONWriter.State state)
```
  - getState
```
protected BSONWriter.State getState()
```
  - getContext
```
protected BSONWriter.Context getContext()
```
  - setContext
```
protected void setContext(BSONWriter.Context context)
```
  - flush
```
public abstract void flush()
```
    Flushes any pending data to the output destination.
  - writeBinaryData
```
public abstract void writeBinaryData(Binary binary)
```
    Writes a BSON Binary data element to the writer.
    
    Parameters:
    
    binary - The Binary data.
  - writeBinaryData
```
public void writeBinaryData(java.lang.String name,
                            Binary binary)
```
    Writes a BSON Binary data element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    binary - The Binary data value.
  - writeBoolean
```
public abstract void writeBoolean(boolean value)
```
    Writes a BSON Boolean to the writer.
    
    Parameters:
    
    value - The Boolean value.
  - writeBoolean
```
public void writeBoolean(java.lang.String name,
                         boolean value)
```
    Writes a BSON Boolean element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Boolean value.
  - writeDateTime
```
public abstract void writeDateTime(long value)
```
    Writes a BSON DateTime to the writer.
    
    Parameters:
    
    value - The number of milliseconds since the Unix epoch.
  - writeDateTime
```
public void writeDateTime(java.lang.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.
  - writeDouble
```
public abstract void writeDouble(double value)
```
    Writes a BSON Double to the writer.
    
    Parameters:
    
    value - The Double value.
  - writeDouble
```
public void writeDouble(java.lang.String name,
                        double value)
```
    Writes a BSON Double element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Double value.
  - writeEndArray
```
public void writeEndArray()
```
    Writes the end of a BSON array to the writer.
  - writeEndDocument
```
public void writeEndDocument()
```
    Writes the end of a BSON document to the writer.
  - writeInt32
```
public abstract void writeInt32(int value)
```
    Writes a BSON Int32 to the writer.
    
    Parameters:
    
    value - The Int32 value.
  - writeInt32
```
public void writeInt32(java.lang.String name,
                       int value)
```
    Writes a BSON Int32 element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Int32 value.
  - writeInt64
```
public abstract void writeInt64(long value)
```
    Writes a BSON Int64 to the writer.
    
    Parameters:
    
    value - The Int64 value.
  - writeInt64
```
public void writeInt64(java.lang.String name,
                       long value)
```
    Writes a BSON Int64 element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The Int64 value.
  - writeJavaScript
```
public abstract void writeJavaScript(java.lang.String code)
```
    Writes a BSON JavaScript to the writer.
    
    Parameters:
    
    code - The JavaScript code.
  - writeJavaScript
```
public void writeJavaScript(java.lang.String name,
                            java.lang.String code)
```
    Writes a BSON JavaScript element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    code - The JavaScript code.
  - writeJavaScriptWithScope
```
public abstract void writeJavaScriptWithScope(java.lang.String code)
```
    Writes a BSON JavaScript to the writer (call WriteStartDocument to start writing the scope).
    
    Parameters:
    
    code - The JavaScript code.
  - writeJavaScriptWithScope
```
public void writeJavaScriptWithScope(java.lang.String name,
                                     java.lang.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
```
public abstract void writeMaxKey()
```
    Writes a BSON MaxKey to the writer.
  - writeMaxKey
```
public void writeMaxKey(java.lang.String name)
```
    Writes a BSON MaxKey element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeMinKey
```
public abstract void writeMinKey()
```
    Writes a BSON MinKey to the writer.
  - writeMinKey
```
public void writeMinKey(java.lang.String name)
```
    Writes a BSON MinKey element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeName
```
public void writeName(java.lang.String name)
```
    Writes the name of an element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeNull
```
public abstract void writeNull()
```
    Writes a BSON null to the writer.
  - writeNull
```
public void writeNull(java.lang.String name)
```
    Writes a BSON null element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeObjectId
```
public abstract void writeObjectId(ObjectId objectId)
```
    Writes a BSON ObjectId to the writer.
    
    Parameters:
    
    objectId - The ObjectId value.
  - writeObjectId
```
public void writeObjectId(java.lang.String name,
                          ObjectId objectId)
```
    Writes a BSON ObjectId element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    objectId - The ObjectId value.
  - writeStartArray
```
public void writeStartArray()
```
    Writes the start of a BSON array to the writer.
    
    Throws:
    
    BSONException - if maximum serialization depth exceeded.
  - writeStartArray
```
public void writeStartArray(java.lang.String name)
```
    Writes the start of a BSON array element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeStartDocument
```
public void writeStartDocument()
```
    Writes the start of a BSON document to the writer.
    
    Throws:
    
    BSONException - if maximum serialization depth exceeded.
  - writeStartDocument
```
public void writeStartDocument(java.lang.String name)
```
    Writes the start of a BSON document element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - writeString
```
public abstract void writeString(java.lang.String value)
```
    Writes a BSON String to the writer.
    
    Parameters:
    
    value - The String value.
  - writeString
```
public void writeString(java.lang.String name,
                        java.lang.String value)
```
    Writes a BSON String element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The String value.
  - writeSymbol
```
public abstract void writeSymbol(java.lang.String value)
```
    Writes a BSON Symbol to the writer.
    
    Parameters:
    
    value - The symbol.
  - writeSymbol
```
public void writeSymbol(java.lang.String name,
                        java.lang.String value)
```
    Writes a BSON Symbol element to the writer.
    
    Parameters:
    
    name - The name of the element.
    
    value - The symbol.
  - writeTimestamp
```
public abstract void writeTimestamp(BSONTimestamp value)
```
    Writes a BSON Timestamp to the writer.
    
    Parameters:
    
    value - The combined timestamp/increment value.
  - writeTimestamp
```
public void writeTimestamp(java.lang.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
```
public abstract void writeUndefined()
```
    Writes a BSON undefined to the writer.
  - writeUndefined
```
public void writeUndefined(java.lang.String name)
```
    Writes a BSON undefined element to the writer.
    
    Parameters:
    
    name - The name of the element.
  - getNextState
```
protected BSONWriter.State getNextState()
```
  - checkState
```
protected boolean checkState(BSONWriter.State[] validStates)
```
  - checkPreconditions
```
protected void checkPreconditions(java.lang.String methodName,
                                  BSONWriter.State... validStates)
```
  - throwInvalidContextType
```
protected void throwInvalidContextType(java.lang.String methodName,
                                       BSONContextType actualContextType,
                                       BSONContextType... validContextTypes)
```
    Throws an InvalidOperationException when the method called is not valid for the current ContextType.
    
    Parameters:
    
    methodName - The name of the method.
    
    actualContextType - The actual ContextType.
    
    validContextTypes - The valid ContextTypes.
    
    Throws:
    
    BSONException
  - throwInvalidState
```
protected void throwInvalidState(java.lang.String methodName,
                                 BSONWriter.State... validStates)
```
    Throws an InvalidOperationException when the method called is not valid for the current state.
    
    Parameters:
    
    methodName - The name of the method.
    
    validStates - The valid states.
    
    Throws:
    
    BSONException
  - close
```
public void close()
```
    Closes the writer.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable

Class BSONWriter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

settings

state

context

currentName

serializationDepth

closed

Constructor Detail

BSONWriter

Method Detail

getName

isClosed

setState

getState

getContext

setContext

flush

writeBinaryData

writeBinaryData

writeBoolean

writeBoolean

writeDateTime

writeDateTime

writeDouble

writeDouble

writeEndArray

writeEndDocument

writeInt32

writeInt32

writeInt64

writeInt64

writeJavaScript

writeJavaScript

writeJavaScriptWithScope

writeJavaScriptWithScope

writeMaxKey

writeMaxKey

writeMinKey

writeMinKey

writeName

writeNull

writeNull

writeObjectId

writeObjectId

writeStartArray

writeStartArray

writeStartDocument

writeStartDocument

writeString

writeString

writeSymbol

writeSymbol

writeTimestamp

writeTimestamp

writeUndefined

writeUndefined

getNextState

checkState

checkPreconditions

throwInvalidContextType

throwInvalidState

close