org.json

Class JSONParserConfiguration

java.lang.Object

org.json.ParserConfiguration

org.json.JSONParserConfiguration

public class JSONParserConfiguration
extends ParserConfiguration

Configuration object for the JSON parser. The configuration is immutable.

Field Summary

Fields inherited from class org.json.ParserConfiguration

DEFAULT_MAXIMUM_NESTING_DEPTH, keepStrings, maxNestingDepth, UNDEFINED_MAXIMUM_NESTING_DEPTH

Constructor Summary

Constructors

Constructor and Description
JSONParserConfiguration() Configuration with the default values.

Method Summary

Modifier and Type	Method and Description
protected JSONParserConfiguration	clone() Provides a new instance of the same configuration.
boolean	isOverwriteDuplicateKey() The parser's behavior when meeting duplicate keys, controls whether the parser should overwrite duplicate keys or not.
boolean	isStrictMode()
JSONParserConfiguration	withMaxNestingDepth(int maxNestingDepth) Defines the maximum nesting depth that the parser will descend before throwing an exception when parsing a map into JSONObject or parsing a Collection instance into JSONArray.
JSONParserConfiguration	withOverwriteDuplicateKey(boolean overwriteDuplicateKey) Controls the parser's behavior when meeting duplicate keys.
JSONParserConfiguration	withStrictMode() Sets the strict mode configuration for the JSON parser with default true value
JSONParserConfiguration	withStrictMode(boolean mode) Sets the strict mode configuration for the JSON parser.

Methods inherited from class org.json.ParserConfiguration

getMaxNestingDepth, isKeepStrings, withKeepStrings

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONParserConfiguration

public JSONParserConfiguration()

Configuration with the default values.

Method Detail

clone

protected JSONParserConfiguration clone()

Description copied from class: ParserConfiguration

Provides a new instance of the same configuration.

Overrides:

clone in class ParserConfiguration

withMaxNestingDepth

public JSONParserConfiguration withMaxNestingDepth(int maxNestingDepth)

Defines the maximum nesting depth that the parser will descend before throwing an exception when parsing a map into JSONObject or parsing a Collection instance into JSONArray. The default max nesting depth is 512, which means the parser will throw a JsonException if the maximum depth is reached.

Overrides:

withMaxNestingDepth in class ParserConfiguration

Parameters:

maxNestingDepth - the maximum nesting depth allowed to the JSON parser

Returns:

The existing configuration will not be modified. A new configuration is returned.

withOverwriteDuplicateKey

public JSONParserConfiguration withOverwriteDuplicateKey(boolean overwriteDuplicateKey)

Controls the parser's behavior when meeting duplicate keys. If set to false, the parser will throw a JSONException when meeting a duplicate key. Or the duplicate key's value will be overwritten.

Parameters:

overwriteDuplicateKey - defines should the parser overwrite duplicate keys.

Returns:

The existing configuration will not be modified. A new configuration is returned.

withStrictMode

public JSONParserConfiguration withStrictMode()

Sets the strict mode configuration for the JSON parser with default true value

When strict mode is enabled, the parser will throw a JSONException if it encounters an invalid character immediately following the final ']' character in the input. This is useful for ensuring strict adherence to the JSON syntax, as any characters after the final closing bracket of a JSON array are considered invalid.

Returns:

a new JSONParserConfiguration instance with the updated strict mode setting

withStrictMode

public JSONParserConfiguration withStrictMode(boolean mode)

Sets the strict mode configuration for the JSON parser.

When strict mode is enabled, the parser will throw a JSONException if it encounters an invalid character immediately following the final ']' character in the input. This is useful for ensuring strict adherence to the JSON syntax, as any characters after the final closing bracket of a JSON array are considered invalid.

Parameters:

mode - a boolean value indicating whether strict mode should be enabled or not

Returns:

a new JSONParserConfiguration instance with the updated strict mode setting

isOverwriteDuplicateKey

public boolean isOverwriteDuplicateKey()

The parser's behavior when meeting duplicate keys, controls whether the parser should overwrite duplicate keys or not.

Returns:

The overwriteDuplicateKey configuration value.

isStrictMode

public boolean isStrictMode()

Returns:

the current strict mode setting.