JsonSyntaxError (net.markenwerk:utils-json-parser 3.0.0 API)

java.lang.Object
- java.lang.Enum<JsonSyntaxError>
- - net.markenwerk.utils.json.parser.JsonSyntaxError

All Implemented Interfaces:

Serializable, Comparable<JsonSyntaxError>
```
public enum JsonSyntaxError
extends Enum<JsonSyntaxError>
```
A JsonSyntaxError describes the kinds of syntax error a JSON parser may encounter.

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`INVALID_ARRAY_FIRST` Describes an invalid JSON array, where the initial `[` isn't followed by a JSON value or a `]`.
`INVALID_ARRAY_FOLLOW` Describes an invalid JSON array, where a value isn't followed by a JSON `,` or a `]`.
`INVALID_ARRAY_VALUE` Describes an invalid JSON array, where a `,` isn't followed by a JSON value.
`INVALID_DOCUMENT_END` Describes an invalid document, where the the last `}` or `]` is followed by further non-whitespace characters.
`INVALID_DOCUMENT_START` Describes an invalid document, where the initial character is neither `{` nor `[`.
`INVALID_ESCAPE_SEQUENCE` Describes an invalid JSON string, where a `\\` isn't followed by a valid escape sequence.
`INVALID_LITERAL` Describes an invalid JSON value, that does't begin with `[`, `{` or `"` and isn't a valid JSON literal.
`INVALID_OBJECT_FIRST` Describes an invalid JSON object, where the initial `{` isn't followed by a JSON name or a `}`.
`INVALID_OBJECT_FOLLOW` Describes an invalid JSON object, where a value isn't followed by a `.` or a `}`.
`INVALID_OBJECT_NAME` Describes an invalid JSON object, where a `,` isn't followed by a JSON name.
`INVALID_OBJECT_SEPARATION` Describes an invalid JSON object, where a JSON name isn't followed by a `:`.
`INVALID_OBJECT_VALUE` Describes an invalid JSON object, where a `:` isn't followed by a JSON value.
`INVALID_UNICODE_ESCAPE_SEQUENCE` Describes an invalid JSON string, where a `\\u` isn't followed by four hex characters.
`UNFINISHED_ESCAPE_SEQUENCE` Describes an invalid JSON string, where a `\` isn't followed by at least one character.
`UNFINISHED_UNICODE_ESCAPE_SEQUENCE` Describes an invalid JSON string, where a `\\u` isn't followed by four character.
`UNTERMINATED_STRING` Describes an invalid JSON string, that is not ended by a `"`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Returns a description of this `JsonSyntaxError`.
`String`	`getExpectation()` Returns a description of an unfulfilled expectation, that caused this `JsonSyntaxError`.
`static JsonSyntaxError`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static JsonSyntaxError[]`	`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
  - INVALID_DOCUMENT_START
```
public static final JsonSyntaxError INVALID_DOCUMENT_START
```
    Describes an invalid document, where the initial character is neither { nor [.
  - INVALID_DOCUMENT_END
```
public static final JsonSyntaxError INVALID_DOCUMENT_END
```
    Describes an invalid document, where the the last } or ] is followed by further non-whitespace characters.
  - INVALID_ARRAY_FIRST
```
public static final JsonSyntaxError INVALID_ARRAY_FIRST
```
    Describes an invalid JSON array, where the initial [ isn't followed by a JSON value or a ].
  - INVALID_ARRAY_FOLLOW
```
public static final JsonSyntaxError INVALID_ARRAY_FOLLOW
```
    Describes an invalid JSON array, where a value isn't followed by a JSON , or a ].
  - INVALID_ARRAY_VALUE
```
public static final JsonSyntaxError INVALID_ARRAY_VALUE
```
    Describes an invalid JSON array, where a , isn't followed by a JSON value.
  - INVALID_OBJECT_FIRST
```
public static final JsonSyntaxError INVALID_OBJECT_FIRST
```
    Describes an invalid JSON object, where the initial { isn't followed by a JSON name or a }.
  - INVALID_OBJECT_FOLLOW
```
public static final JsonSyntaxError INVALID_OBJECT_FOLLOW
```
    Describes an invalid JSON object, where a value isn't followed by a . or a }.
  - INVALID_OBJECT_NAME
```
public static final JsonSyntaxError INVALID_OBJECT_NAME
```
    Describes an invalid JSON object, where a , isn't followed by a JSON name.
  - INVALID_OBJECT_SEPARATION
```
public static final JsonSyntaxError INVALID_OBJECT_SEPARATION
```
    Describes an invalid JSON object, where a JSON name isn't followed by a :.
  - INVALID_OBJECT_VALUE
```
public static final JsonSyntaxError INVALID_OBJECT_VALUE
```
    Describes an invalid JSON object, where a : isn't followed by a JSON value.
  - UNTERMINATED_STRING
```
public static final JsonSyntaxError UNTERMINATED_STRING
```
    Describes an invalid JSON string, that is not ended by a ".
  - UNFINISHED_ESCAPE_SEQUENCE
```
public static final JsonSyntaxError UNFINISHED_ESCAPE_SEQUENCE
```
    Describes an invalid JSON string, where a \ isn't followed by at least one character.
  - INVALID_ESCAPE_SEQUENCE
```
public static final JsonSyntaxError INVALID_ESCAPE_SEQUENCE
```
    Describes an invalid JSON string, where a \\ isn't followed by a valid escape sequence.
  - UNFINISHED_UNICODE_ESCAPE_SEQUENCE
```
public static final JsonSyntaxError UNFINISHED_UNICODE_ESCAPE_SEQUENCE
```
    Describes an invalid JSON string, where a \\u isn't followed by four character.
  - INVALID_UNICODE_ESCAPE_SEQUENCE
```
public static final JsonSyntaxError INVALID_UNICODE_ESCAPE_SEQUENCE
```
    Describes an invalid JSON string, where a \\u isn't followed by four hex characters.
  - INVALID_LITERAL
```
public static final JsonSyntaxError INVALID_LITERAL
```
    Describes an invalid JSON value, that does't begin with [, { or " and isn't a valid JSON literal.
- Method Detail
  - values
```
public static JsonSyntaxError[] 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 (JsonSyntaxError c : JsonSyntaxError.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JsonSyntaxError 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
  - getDescription
```
public String getDescription()
```
    Returns a description of this JsonSyntaxError.
    
    Returns:
    
    A description of this JsonSyntaxError.
  - getExpectation
```
public String getExpectation()
```
    Returns a description of an unfulfilled expectation, that caused this JsonSyntaxError.
    
    Returns:
    
    a description of an unfulfilled expectation, that caused this JsonSyntaxError.

Enum JsonSyntaxError

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INVALID_DOCUMENT_START

INVALID_DOCUMENT_END

INVALID_ARRAY_FIRST

INVALID_ARRAY_FOLLOW

INVALID_ARRAY_VALUE

INVALID_OBJECT_FIRST

INVALID_OBJECT_FOLLOW

INVALID_OBJECT_NAME

INVALID_OBJECT_SEPARATION

INVALID_OBJECT_VALUE

UNTERMINATED_STRING

UNFINISHED_ESCAPE_SEQUENCE

INVALID_ESCAPE_SEQUENCE

UNFINISHED_UNICODE_ESCAPE_SEQUENCE

INVALID_UNICODE_ESCAPE_SEQUENCE

INVALID_LITERAL

Method Detail

values

valueOf

getDescription

getExpectation