Package org.bson.json

Enum Class JsonMode

java.lang.Object
java.lang.Enum<JsonMode>
org.bson.json.JsonMode
All Implemented Interfaces:
Serializable, Comparable<JsonMode>, java.lang.constant.Constable
public enum JsonMode extends Enum<JsonMode>
An enumeration of the supported output modes of JSONWriter.
Since:
3.0
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    EXTENDED
    Standard extended JSON representation.
    RELAXED
    Standard relaxed extended JSON representation.
    SHELL
    While not formally documented, this output mode will attempt to produce output that corresponds to what the MongoDB shell actually produces when showing query results.
    STRICT
    Deprecated.
    The format generated with this mode is no longer considered standard for MongoDB tools.

  • Method Summary

    Modifier and Type
    Method
    Description
    static JsonMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static JsonMode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • STRICT

      @Deprecated public static final JsonMode STRICT
      Deprecated.
      The format generated with this mode is no longer considered standard for MongoDB tools. This value is not currently scheduled for removal.
      Strict mode representations of BSON types conform to the JSON RFC spec.

    • SHELL

      public static final JsonMode SHELL
      While not formally documented, this output mode will attempt to produce output that corresponds to what the MongoDB shell actually produces when showing query results.

    • EXTENDED

      public static final JsonMode EXTENDED
      Standard extended JSON representation.
      Since:
      3.5
      See Also:

    • RELAXED

      public static final JsonMode RELAXED
      Standard relaxed extended JSON representation.
      Since:
      3.5
      See Also:

  • Method Details

    • values

      public static JsonMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static JsonMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null