org.bson.json

Class 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

Constructor Summary

Constructors

Constructor and Description
JsonWriterSettings() Creates a new instance with default values for all properties.
JsonWriterSettings(boolean indent) Creates a new instance with indent mode enabled, and the default value for all other properties.
JsonWriterSettings(JsonMode outputMode) Creates a new instance with the given output mode and default values for all other properties.
JsonWriterSettings(JsonMode outputMode, boolean indent) Creates a new instance with the given output mode, indent mode enabled, and the default value for all other properties.
JsonWriterSettings(JsonMode outputMode, String indentCharacters) Creates a new instance with the given values for all properties, indent mode enabled and the default value of newLineCharacters.
JsonWriterSettings(JsonMode outputMode, String indentCharacters, String newLineCharacters) Creates a new instance with the given values for all properties and indent mode enabled.

Method Summary

Modifier and Type	Method and Description
String	getIndentCharacters() The indent characters to use if indent mode is enabled.
String	getNewLineCharacters() The new line character(s) to use if indent mode is enabled.
JsonMode	getOutputMode() The output mode to use.
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

public JsonWriterSettings()

Creates a new instance with default values for all properties.

JsonWriterSettings

public JsonWriterSettings(JsonMode outputMode)

Creates a new instance with the given output mode and default values for all other properties.

Parameters:

outputMode - the output mode

JsonWriterSettings

public JsonWriterSettings(boolean indent)

Creates a new instance with indent mode enabled, and the default value for all other properties.

Parameters:

indent - whether indent mode is enabled

JsonWriterSettings

public JsonWriterSettings(JsonMode outputMode,
                          boolean indent)

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

public JsonWriterSettings(JsonMode outputMode,
                          String indentCharacters)

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

public JsonWriterSettings(JsonMode outputMode,
                          String indentCharacters,
                          String newLineCharacters)

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

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 characters to use.

getOutputMode

public JsonMode getOutputMode()

The output mode to use. The default value is JSONMode.STRICT}.

Returns:

the output mode.