Package org.bson.json

Class JsonWriterSettings

java.lang.Object
org.bson.BsonWriterSettings
org.bson.json.JsonWriterSettings
public final class JsonWriterSettings extends BsonWriterSettings
Settings to control the behavior of a JSONWriter instance.
Since:
3.0
See Also:

  • Method Details

    • 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.RELAXED}.
      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