java.lang.Object
- org.bson.AbstractBsonWriter
- - org.bson.json.JsonWriter

All Implemented Interfaces:

Closeable, AutoCloseable, BsonWriter
```
public class JsonWriter
extends AbstractBsonWriter
```
A BsonWriter implementation that outputs a JSON representation of BSON.

Since:

3.0

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`class`	`JsonWriter.Context`	The context for the writer, inheriting all the values from `AbstractBsonWriter.Context`, and additionally providing settings for the indentation level and whether there are any child elements at this level.

Nested classes/interfaces inherited from class org.bson.AbstractBsonWriter
AbstractBsonWriter.Mark, AbstractBsonWriter.State

Constructor Summary

Constructors
Constructor	Description
`JsonWriter(Writer writer)`	Creates a new instance which uses `writer` to write JSON to.
`JsonWriter(Writer writer, JsonWriterSettings settings)`	Creates a new instance which uses `writer` to write JSON to and uses the given settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`abortPipe()`	Return true if the current execution of the pipe method should be aborted.
`protected void`	`doWriteBinaryData(BsonBinary binary)`	Handles the logic of writing a `BsonBinary` value
`void`	`doWriteBoolean(boolean value)`	Handles the logic of writing a boolean value
`protected void`	`doWriteDateTime(long value)`	Handles the logic of writing a date time value
`protected void`	`doWriteDBPointer(BsonDbPointer value)`	Handles the logic of writing a DbPointer value
`protected void`	`doWriteDecimal128(Decimal128 value)`	Handles the logic of writing a Decimal128 value
`protected void`	`doWriteDouble(double value)`	Handles the logic of writing a Double value
`protected void`	`doWriteEndArray()`	Handles the logic of writing the end of an array
`protected void`	`doWriteEndDocument()`	Handles the logic of writing the end of a document
`protected void`	`doWriteInt32(int value)`	Handles the logic of writing an int32 value
`protected void`	`doWriteInt64(long value)`	Handles the logic of writing an int64 value
`protected void`	`doWriteJavaScript(String code)`	Handles the logic of writing a JavaScript function
`protected void`	`doWriteJavaScriptWithScope(String code)`	Handles the logic of writing a scoped JavaScript function
`protected void`	`doWriteMaxKey()`	Handles the logic of writing a Max key
`protected void`	`doWriteMinKey()`	Handles the logic of writing a Min key
`protected void`	`doWriteName(String name)`	Handles the logic of writing the element name.
`void`	`doWriteNull()`	Handles the logic of writing a Null value
`void`	`doWriteObjectId(ObjectId objectId)`	Handles the logic of writing an ObjectId
`void`	`doWriteRegularExpression(BsonRegularExpression regularExpression)`	Handles the logic of writing a regular expression
`protected void`	`doWriteStartArray()`	Handles the logic to start writing an array
`protected void`	`doWriteStartDocument()`	Handles the logic to start writing a document
`void`	`doWriteString(String value)`	Handles the logic of writing a String
`void`	`doWriteSymbol(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.
`protected JsonWriter.Context`	`getContext()`	Get the context, which will indicate which state the writer is in, for example which part of a document it's currently writing.
`Writer`	`getWriter()`	Gets the `Writer`.
`boolean`	`isTruncated()`	Return true if the output has been truncated due to exceeding the length specified in `JsonWriterSettings.maxLength`.

Methods inherited from class org.bson.AbstractBsonWriter
checkPreconditions, checkState, close, 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

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

- Constructor Detail
  - JsonWriter
```
public JsonWriter(Writer writer)
```
    Creates a new instance which uses writer to write JSON to.
    
    Parameters:
    
    writer - the writer to write JSON to.
  - JsonWriter
```
public JsonWriter(Writer writer,
                  JsonWriterSettings settings)
```
    Creates a new instance which uses writer to write JSON to and uses the given settings.
    
    Parameters:
    
    writer - the writer to write JSON to.
    
    settings - the settings to apply to this writer.
- Method Detail
  - getWriter
```
public Writer getWriter()
```
    Gets the Writer.
    
    Returns:
    
    the writer
  - getContext
```
protected JsonWriter.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 class AbstractBsonWriter
    
    Returns:
    
    the current context.
  - doWriteName
```
protected void doWriteName(String name)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing the element name.
    
    Overrides:
    
    doWriteName in class AbstractBsonWriter
    
    Parameters:
    
    name - the name of the element
  - doWriteStartDocument
```
protected void doWriteStartDocument()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic to start writing a document
    
    Specified by:
    
    doWriteStartDocument in class AbstractBsonWriter
  - doWriteEndDocument
```
protected void doWriteEndDocument()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing the end of a document
    
    Specified by:
    
    doWriteEndDocument in class AbstractBsonWriter
  - doWriteStartArray
```
protected void doWriteStartArray()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic to start writing an array
    
    Specified by:
    
    doWriteStartArray in class AbstractBsonWriter
  - doWriteEndArray
```
protected void doWriteEndArray()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing the end of an array
    
    Specified by:
    
    doWriteEndArray in class AbstractBsonWriter
  - doWriteBinaryData
```
protected void doWriteBinaryData(BsonBinary binary)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a BsonBinary value
    
    Specified by:
    
    doWriteBinaryData in class AbstractBsonWriter
    
    Parameters:
    
    binary - the BsonBinary 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 class AbstractBsonWriter
    
    Parameters:
    
    value - the boolean 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 class AbstractBsonWriter
    
    Parameters:
    
    value - the long value to write
  - doWriteDBPointer
```
protected void doWriteDBPointer(BsonDbPointer value)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a DbPointer value
    
    Specified by:
    
    doWriteDBPointer in class AbstractBsonWriter
    
    Parameters:
    
    value - the BsonDbPointer 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 class AbstractBsonWriter
    
    Parameters:
    
    value - the double 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 class AbstractBsonWriter
    
    Parameters:
    
    value - the int 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 class AbstractBsonWriter
    
    Parameters:
    
    value - the long value to write
  - doWriteDecimal128
```
protected void doWriteDecimal128(Decimal128 value)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a Decimal128 value
    
    Specified by:
    
    doWriteDecimal128 in class AbstractBsonWriter
    
    Parameters:
    
    value - the Decimal128 value to write
  - doWriteJavaScript
```
protected void doWriteJavaScript(String code)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a JavaScript function
    
    Specified by:
    
    doWriteJavaScript in class AbstractBsonWriter
    
    Parameters:
    
    code - the String value to write
  - doWriteJavaScriptWithScope
```
protected void doWriteJavaScriptWithScope(String code)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a scoped JavaScript function
    
    Specified by:
    
    doWriteJavaScriptWithScope in class AbstractBsonWriter
    
    Parameters:
    
    code - the boolean value to write
  - doWriteMaxKey
```
protected void doWriteMaxKey()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a Max key
    
    Specified by:
    
    doWriteMaxKey in class AbstractBsonWriter
  - doWriteMinKey
```
protected void doWriteMinKey()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a Min key
    
    Specified by:
    
    doWriteMinKey in class AbstractBsonWriter
  - doWriteNull
```
public void doWriteNull()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a Null value
    
    Specified by:
    
    doWriteNull in class AbstractBsonWriter
  - doWriteObjectId
```
public void doWriteObjectId(ObjectId objectId)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing an ObjectId
    
    Specified by:
    
    doWriteObjectId in class AbstractBsonWriter
    
    Parameters:
    
    objectId - the ObjectId value to write
  - doWriteRegularExpression
```
public void doWriteRegularExpression(BsonRegularExpression regularExpression)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a regular expression
    
    Specified by:
    
    doWriteRegularExpression in class AbstractBsonWriter
    
    Parameters:
    
    regularExpression - the BsonRegularExpression value to write
  - doWriteString
```
public void doWriteString(String value)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a String
    
    Specified by:
    
    doWriteString in class AbstractBsonWriter
    
    Parameters:
    
    value - the String value to write
  - doWriteSymbol
```
public void doWriteSymbol(String value)
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing a Symbol
    
    Specified by:
    
    doWriteSymbol in class AbstractBsonWriter
    
    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
    
    Specified by:
    
    doWriteTimestamp in class AbstractBsonWriter
    
    Parameters:
    
    value - the BsonTimestamp value to write
  - doWriteUndefined
```
public void doWriteUndefined()
```
    Description copied from class: AbstractBsonWriter
    
    Handles the logic of writing an Undefined value
    
    Specified by:
    
    doWriteUndefined in class AbstractBsonWriter
  - flush
```
public void flush()
```
    Description copied from interface: BsonWriter
    
    Flushes any pending data to the output destination.
  - isTruncated
```
public boolean isTruncated()
```
    Return true if the output has been truncated due to exceeding the length specified in JsonWriterSettings.maxLength.
    
    Returns:
    
    true if the output has been truncated
    
    Since:
    
    3.7
    
    See Also:
    
    JsonWriterSettings.maxLength
  - abortPipe
```
protected boolean abortPipe()
```
    Description copied from class: AbstractBsonWriter
    
    Return true if the current execution of the pipe method should be aborted.
    
    Overrides:
    
    abortPipe in class AbstractBsonWriter
    
    Returns:
    
    true if the current execution of the pipe method should be aborted.

Class JsonWriter

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.bson.AbstractBsonWriter

Methods inherited from class java.lang.Object

Constructor Detail

JsonWriter

JsonWriter

Method Detail

getWriter

getContext

doWriteName

doWriteStartDocument

doWriteEndDocument

doWriteStartArray

doWriteEndArray

doWriteBinaryData

doWriteBoolean

doWriteDateTime

doWriteDBPointer

doWriteDouble

doWriteInt32

doWriteInt64

doWriteDecimal128

doWriteJavaScript

doWriteJavaScriptWithScope

doWriteMaxKey

doWriteMinKey

doWriteNull

doWriteObjectId

doWriteRegularExpression

doWriteString

doWriteSymbol

doWriteTimestamp

doWriteUndefined

flush

isTruncated

abortPipe