JsonWriterSettings

java.lang.Object
- org.bson.BsonWriterSettings
- - org.bson.json.JsonWriterSettings

```
public class JsonWriterSettings
extends BsonWriterSettings
```
Settings to control the behavior of a JSONWriter instance.

Since:

3.0

See Also:

JsonWriter

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class JsonWriterSettings.Builder
A builder for JsonWriterSettings

Nested Classes
Modifier and Type	Class	Description
`static class`	`JsonWriterSettings.Builder`	A builder for JsonWriterSettings

Constructor Summary

Constructors
Constructor	Description
`JsonWriterSettings()`	Deprecated. Prefer `builder()`, but note that the default output mode is different for that method
`JsonWriterSettings(boolean indent)`	Deprecated. Use the `JsonWriterSettings.Builder` instead
`JsonWriterSettings(JsonMode outputMode)`	Deprecated. Use the `JsonWriterSettings.Builder` instead
`JsonWriterSettings(JsonMode outputMode, boolean indent)`	Deprecated. Use the `JsonWriterSettings.Builder` instead
`JsonWriterSettings(JsonMode outputMode, String indentCharacters)`	Deprecated. Use the `JsonWriterSettings.Builder` instead
`JsonWriterSettings(JsonMode outputMode, String indentCharacters, String newLineCharacters)`	Deprecated. Use the `JsonWriterSettings.Builder` instead

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JsonWriterSettings.Builder`	`builder()`	Create a builder for JsonWriterSettings, which are immutable.
`Converter<BsonBinary>`	`getBinaryConverter()`	A converter from BSON Binary values to JSON.
`Converter<Boolean>`	`getBooleanConverter()`	A converter from BSON Boolean values to JSON.
`Converter<Long>`	`getDateTimeConverter()`	A converter from BSON DateTime values to JSON.
`Converter<Decimal128>`	`getDecimal128Converter()`	A converter from BSON Decimal128 values to JSON.
`Converter<Double>`	`getDoubleConverter()`	A converter from BSON Double values to JSON.
`String`	`getIndentCharacters()`	The indent characters to use if indent mode is enabled.
`Converter<Integer>`	`getInt32Converter()`	A converter from BSON Int32 values to JSON.
`Converter<Long>`	`getInt64Converter()`	A converter from BSON Int64 values to JSON.
`Converter<String>`	`getJavaScriptConverter()`	A converter from BSON JavaScript values to JSON.
`Converter<BsonMaxKey>`	`getMaxKeyConverter()`	A converter from BSON MaxKey values to JSON.
`int`	`getMaxLength()`	The maximum length of the JSON string.
`Converter<BsonMinKey>`	`getMinKeyConverter()`	A converter from BSON MinKey values to JSON.
`String`	`getNewLineCharacters()`	The new line character(s) to use if indent mode is enabled.
`Converter<BsonNull>`	`getNullConverter()`	A converter from BSON Null values to JSON.
`Converter<ObjectId>`	`getObjectIdConverter()`	A converter from BSON ObjectId values to JSON.
`JsonMode`	`getOutputMode()`	The output mode to use.
`Converter<BsonRegularExpression>`	`getRegularExpressionConverter()`	A converter from BSON RegularExpression values to JSON.
`Converter<String>`	`getStringConverter()`	A converter from BSON String values to JSON.
`Converter<String>`	`getSymbolConverter()`	A converter from BSON Symbol values to JSON.
`Converter<BsonTimestamp>`	`getTimestampConverter()`	A converter from BSON Timestamp values to JSON.
`Converter<BsonUndefined>`	`getUndefinedConverter()`	A converter from BSON Undefined values to JSON.
`boolean`	`isIndent()`	The indentation mode.

Methods inherited from class org.bson.BsonWriterSettings
getMaxSerializationDepth

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

- Constructor Detail
  - JsonWriterSettings
```
@Deprecated
public JsonWriterSettings()
```
    Deprecated. Prefer builder(), but note that the default output mode is different for that method
    
    Creates a new instance with default values for all properties.
    Defaults to JsonMode.STRICT
  - JsonWriterSettings
```
@Deprecated
public JsonWriterSettings(JsonMode outputMode)
```
    Deprecated. Use the JsonWriterSettings.Builder instead
    
    Creates a new instance with the given output mode and default values for all other properties.
    
    Parameters:
    
    outputMode - the output mode
  - JsonWriterSettings
```
@Deprecated
public JsonWriterSettings(boolean indent)
```
    Deprecated. Use the JsonWriterSettings.Builder instead
    
    Creates a new instance with indent mode enabled, and the default value for all other properties.
    
    Parameters:
    
    indent - whether indent mode is enabled
  - JsonWriterSettings
```
@Deprecated
public JsonWriterSettings(JsonMode outputMode,
                          boolean indent)
```
    Deprecated. Use the JsonWriterSettings.Builder instead
    
    Creates a new instance with the given output mode, indent mode enabled, and the default value for all other properties.
    
    Parameters:
    
    outputMode - the output mode
    
    indent - whether indent mode is enabled
  - JsonWriterSettings
```
@Deprecated
public JsonWriterSettings(JsonMode outputMode,
                          String indentCharacters)
```
    Deprecated. Use the JsonWriterSettings.Builder instead
    
    Creates a new instance with the given values for all properties, indent mode enabled and the default value of newLineCharacters.
    
    Parameters:
    
    outputMode - the output mode
    
    indentCharacters - the indent characters
  - JsonWriterSettings
```
@Deprecated
public JsonWriterSettings(JsonMode outputMode,
                          String indentCharacters,
                          String newLineCharacters)
```
    Deprecated. Use the JsonWriterSettings.Builder instead
    
    Creates a new instance with the given values for all properties and indent mode enabled.
    
    Parameters:
    
    outputMode - the output mode
    
    indentCharacters - the indent characters
    
    newLineCharacters - the new line character(s) to use
- Method Detail
  - builder
```
public static JsonWriterSettings.Builder builder()
```
    Create a builder for JsonWriterSettings, which are immutable.
    Defaults to JsonMode.RELAXED
    
    Returns:
    
    a Builder instance
    
    Since:
    
    3.5
  - isIndent
```
public boolean isIndent()
```
    The indentation mode. If true, output will be indented. Otherwise, it will all be on the same line. The default value is false.
    
    Returns:
    
    whether output should be indented.
  - getNewLineCharacters
```
public String getNewLineCharacters()
```
    The new line character(s) to use if indent mode is enabled. The default value is System.getProperty("line.separator").
    
    Returns:
    
    the new line character(s) to use.
  - getIndentCharacters
```
public String getIndentCharacters()
```
    The indent characters to use if indent mode is enabled. The default value is two spaces.
    
    Returns:
    
    the indent character(s) to use.
  - getOutputMode
```
public JsonMode getOutputMode()
```
    The output mode to use. The default value is JSONMode.STRICT}.
    
    Returns:
    
    the output mode.
  - getMaxLength
```
public int getMaxLength()
```
    The maximum length of the JSON string. The string will be truncated at this length.
    
    Returns:
    
    the maximum length of the JSON string
    
    Since:
    
    3.7
  - getNullConverter
```
public Converter<BsonNull> getNullConverter()
```
    A converter from BSON Null values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getStringConverter
```
public Converter<String> getStringConverter()
```
    A converter from BSON String values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getBinaryConverter
```
public Converter<BsonBinary> getBinaryConverter()
```
    A converter from BSON Binary values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getBooleanConverter
```
public Converter<Boolean> getBooleanConverter()
```
    A converter from BSON Boolean values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getDateTimeConverter
```
public Converter<Long> getDateTimeConverter()
```
    A converter from BSON DateTime values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getDoubleConverter
```
public Converter<Double> getDoubleConverter()
```
    A converter from BSON Double values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getInt32Converter
```
public Converter<Integer> getInt32Converter()
```
    A converter from BSON Int32 values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getInt64Converter
```
public Converter<Long> getInt64Converter()
```
    A converter from BSON Int64 values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getDecimal128Converter
```
public Converter<Decimal128> getDecimal128Converter()
```
    A converter from BSON Decimal128 values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getObjectIdConverter
```
public Converter<ObjectId> getObjectIdConverter()
```
    A converter from BSON ObjectId values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getRegularExpressionConverter
```
public Converter<BsonRegularExpression> getRegularExpressionConverter()
```
    A converter from BSON RegularExpression values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getTimestampConverter
```
public Converter<BsonTimestamp> getTimestampConverter()
```
    A converter from BSON Timestamp values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getSymbolConverter
```
public Converter<String> getSymbolConverter()
```
    A converter from BSON Symbol values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getMinKeyConverter
```
public Converter<BsonMinKey> getMinKeyConverter()
```
    A converter from BSON MinKey values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getMaxKeyConverter
```
public Converter<BsonMaxKey> getMaxKeyConverter()
```
    A converter from BSON MaxKey values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getUndefinedConverter
```
public Converter<BsonUndefined> getUndefinedConverter()
```
    A converter from BSON Undefined values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getJavaScriptConverter
```
public Converter<String> getJavaScriptConverter()
```
    A converter from BSON JavaScript values to JSON.
    
    Returns:
    
    this
    
    Since:
    
    3.5

Class JsonWriterSettings

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.bson.BsonWriterSettings

Methods inherited from class java.lang.Object

Constructor Detail

JsonWriterSettings

JsonWriterSettings

JsonWriterSettings

JsonWriterSettings

JsonWriterSettings

JsonWriterSettings

Method Detail

builder

isIndent

getNewLineCharacters

getIndentCharacters

getOutputMode

getMaxLength

getNullConverter

getStringConverter

getBinaryConverter

getBooleanConverter

getDateTimeConverter

getDoubleConverter

getInt32Converter

getInt64Converter

getDecimal128Converter

getObjectIdConverter

getRegularExpressionConverter

getTimestampConverter

getSymbolConverter

getMinKeyConverter

getMaxKeyConverter

getUndefinedConverter

getJavaScriptConverter