Package org.bson.json

Class StrictCharacterStreamJsonWriterSettings

java.lang.Object

org.bson.json.StrictCharacterStreamJsonWriterSettings

public final class StrictCharacterStreamJsonWriterSettings
extends Object

Settings to control the behavior of a JSONWriter instance.

Since:

3.5

See Also:

StrictCharacterStreamJsonWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StrictCharacterStreamJsonWriterSettings.Builder	A builder for StrictCharacterStreamJsonWriterSettings

Method Summary

Modifier and Type	Method	Description
static StrictCharacterStreamJsonWriterSettings.Builder	builder()	Create a builder for StrictCharacterStreamJsonWriterSettings, which are immutable.
String	getIndentCharacters()	The indent characters to use if indent mode is enabled.
int	getMaxLength()	The maximum length of the JSON string.
String	getNewLineCharacters()	The new line character(s) to use if indent mode is enabled.
boolean	isIndent()	The indentation mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static StrictCharacterStreamJsonWriterSettings.Builder builder()

Create a builder for StrictCharacterStreamJsonWriterSettings, which are immutable.

Returns:

a Builder instance

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.

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