org.bson.json.JsonMode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation

The MongoDB Java Driver uber-artifact, containing mongodb-driver, mongodb-driver-core, and bson

The newest version!

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.bson.json;

/**
 * An enumeration of the supported output modes of {@code JSONWriter}.
 *
 * @see JsonWriter
 * @since 3.0
 */
public enum JsonMode {

    /**
     * Strict mode representations of BSON types conform to the JSON RFC spec.
     *
     * @deprecated  The format generated with this mode is no longer considered standard for MongoDB tools. This value is not currently
     * scheduled for removal.
     */
    @Deprecated // NOT CURRENTLY INTENDED FOR REMOVAL
    STRICT,

    /**
     * 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.
     */
    SHELL,

    /**
     * Standard extended JSON representation.
     *
     * @since 3.5
     * @see Extended JSON Specification
     */
    EXTENDED,

    /**
     * Standard relaxed extended JSON representation.
     *
     * @since 3.5
     * @see Extended JSON Specification
     */
    RELAXED
}