net.openhft.saxophone.json

Enum JsonParserTopLevelStrategy

java.lang.Object

java.lang.Enum<JsonParserTopLevelStrategy>

net.openhft.saxophone.json.JsonParserTopLevelStrategy

All Implemented Interfaces:

Serializable, Comparable<JsonParserTopLevelStrategy>

public enum JsonParserTopLevelStrategy
extends Enum<JsonParserTopLevelStrategy>

JsonParser strategies of treating of top-level JSON objects in the input and throwing ParseExceptions.

See Also:

JsonParserBuilder.topLevelStrategy(JsonParserTopLevelStrategy)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_JUST_A_SINGLE_OBJECT Bytes input must end exactly on the single JSON object end, otherwise ParseException is thrown.
ALLOW_MULTIPLE_VALUES Allow multiple values to be parsed by a single JsonParser between JsonParser.reset() calls and since JsonParser construction.
ALLOW_TRAILING_GARBAGE After parsing a single top-level JSON object JsonParser.parse(Bytes) returns true and the (last) input Bytes might have some remaining bytes.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALLOW_JUST_A_SINGLE_OBJECT

public static final JsonParserTopLevelStrategy ALLOW_JUST_A_SINGLE_OBJECT

Bytes input must end exactly on the single JSON object end, otherwise ParseException is thrown. Even trailing whitespaces are disallowed (the contests of the remaining input are not checked indeed).

This strategy is default.

See Also:

JsonParserBuilder.topLevelStrategy()

ALLOW_TRAILING_GARBAGE

public static final JsonParserTopLevelStrategy ALLOW_TRAILING_GARBAGE

After parsing a single top-level JSON object JsonParser.parse(Bytes) returns true and the (last) input Bytes might have some remaining bytes.

This option is useful when you are parsing multiple JSON objects from the stream (see ALLOW_MULTIPLE_VALUES), but need to do some per-top-level-object work.

ALLOW_MULTIPLE_VALUES

public static final JsonParserTopLevelStrategy ALLOW_MULTIPLE_VALUES

Allow multiple values to be parsed by a single JsonParser between JsonParser.reset() calls and since JsonParser construction. The entire text must be valid JSON, and values can be separated by any kind of whitespace.

Example of the valid input for a parser with this strategy:

 {"foo": 1} // first top-level JSON object

 "bar" 42 3.14
 []
 

Method Detail

values

public static JsonParserTopLevelStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JsonParserTopLevelStrategy c : JsonParserTopLevelStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JsonParserTopLevelStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null