Class JsonReader
- java.lang.Object
-
- com.google.gson.stream.JsonReader
-
- All Implemented Interfaces:
java.io.Closeable,java.lang.AutoCloseable
- Direct Known Subclasses:
JsonTreeReader
public class JsonReader extends java.lang.Object implements java.io.CloseableReads a JSON (RFC 8259) encoded value as a stream of tokens. This stream includes both literal values (strings, numbers, booleans, and nulls) as well as the begin and end delimiters of objects and arrays. The tokens are traversed in depth-first order, the same order that they appear in the JSON document. Within JSON objects, name/value pairs are represented by a single token.Parsing JSON
To create a recursive descent parser for your own JSON streams, first create an entry point method that creates aJsonReader.Next, create handler methods for each structure in your JSON text. You'll need a method for each object type and for each array type.
- Within array handling methods, first call
beginArray()to consume the array's opening bracket. Then create a while loop that accumulates values, terminating whenhasNext()is false. Finally, read the array's closing bracket by callingendArray(). - Within object handling methods, first call
beginObject()to consume the object's opening brace. Then create a while loop that assigns values to local variables based on their name. This loop should terminate whenhasNext()is false. Finally, read the object's closing brace by callingendObject().
When a nested object or array is encountered, delegate to the corresponding handler method.
When an unknown name is encountered, strict parsers should fail with an exception. Lenient parsers should call
skipValue()to recursively skip the value's nested tokens, which may otherwise conflict.If a value may be null, you should first check using
peek(). Null literals can be consumed using eithernextNull()orskipValue().Configuration
The behavior of this reader can be customized with the following methods:setStrictness(Strictness), the default isStrictness.LEGACY_STRICTsetNestingLimit(int), the default is 255
JsonReaderinstances used internally by theGsonclass differs, and can be adjusted with the variousGsonBuildermethods.Example
Suppose we'd like to parse a stream of messages such as the following:
This code implements the parser for the above structure:[ { "id": 912345678901, "text": "How do I read a JSON stream in Java?", "geo": null, "user": { "name": "json_newb", "followers_count": 41 } }, { "id": 912345678902, "text": "@json_newb just use JsonReader!", "geo": [50.454722, -104.606667], "user": { "name": "jesse", "followers_count": 2 } } ]public List<Message> readJsonStream(InputStream in) throws IOException { JsonReader reader = new JsonReader(new InputStreamReader(in, "UTF-8")); try { return readMessagesArray(reader); } finally { reader.close(); } } public List<Message> readMessagesArray(JsonReader reader) throws IOException { List<Message> messages = new ArrayList<>(); reader.beginArray(); while (reader.hasNext()) { messages.add(readMessage(reader)); } reader.endArray(); return messages; } public Message readMessage(JsonReader reader) throws IOException { long id = -1; String text = null; User user = null; List<Double> geo = null; reader.beginObject(); while (reader.hasNext()) { String name = reader.nextName(); if (name.equals("id")) { id = reader.nextLong(); } else if (name.equals("text")) { text = reader.nextString(); } else if (name.equals("geo") && reader.peek() != JsonToken.NULL) { geo = readDoublesArray(reader); } else if (name.equals("user")) { user = readUser(reader); } else { reader.skipValue(); } } reader.endObject(); return new Message(id, text, user, geo); } public List<Double> readDoublesArray(JsonReader reader) throws IOException { List<Double> doubles = new ArrayList<>(); reader.beginArray(); while (reader.hasNext()) { doubles.add(reader.nextDouble()); } reader.endArray(); return doubles; } public User readUser(JsonReader reader) throws IOException { String username = null; int followersCount = -1; reader.beginObject(); while (reader.hasNext()) { String name = reader.nextName(); if (name.equals("name")) { username = reader.nextString(); } else if (name.equals("followers_count")) { followersCount = reader.nextInt(); } else { reader.skipValue(); } } reader.endObject(); return new User(username, followersCount); }Number Handling
This reader permits numeric values to be read as strings and string values to be read as numbers. For example, both elements of the JSON array[1, "1"]may be read using eithernextInt()ornextString(). This behavior is intended to prevent lossy numeric conversions: double is JavaScript's only numeric type and very large values like9007199254740993cannot be represented exactly on that platform. To minimize precision loss, extremely large values should be written and read as strings in JSON.Non-Execute Prefix
Web servers that serve private data using JSON may be vulnerable to Cross-site request forgery attacks. In such an attack, a malicious site gains access to a private JSON file by executing it with an HTML<script>tag.Prefixing JSON files with
")]}'\n"makes them non-executable by<script>tags, disarming the attack. Since the prefix is malformed JSON, strict parsing fails when it is encountered. This class permits the non-execute prefix when lenient parsing is enabled.Each
JsonReadermay be used to read a single JSON stream. Instances of this class are not thread safe.- Since:
- 1.6
-
-
Field Summary
Fields Modifier and Type Field Description private char[]bufferUse a manual buffer to easily read and unread upcoming characters, and also so we can create strings without an intermediate StringBuilder.(package private) static intBUFFER_SIZE(package private) static intDEFAULT_NESTING_LIMITprivate java.io.ReaderinThe input JSON.private intlimitprivate intlineNumberprivate intlineStartprivate static longMIN_INCOMPLETE_INTEGERprivate intnestingLimitprivate static intNUMBER_CHAR_DECIMALprivate static intNUMBER_CHAR_DIGITprivate static intNUMBER_CHAR_EXP_DIGITprivate static intNUMBER_CHAR_EXP_Eprivate static intNUMBER_CHAR_EXP_SIGNprivate static intNUMBER_CHAR_FRACTION_DIGITprivate static intNUMBER_CHAR_NONEprivate static intNUMBER_CHAR_SIGNprivate int[]pathIndicesprivate java.lang.String[]pathNames(package private) intpeekedprivate static intPEEKED_BEGIN_ARRAYprivate static intPEEKED_BEGIN_OBJECTprivate static intPEEKED_BUFFEREDWhen this is returned, the string value is stored in peekedString.private static intPEEKED_DOUBLE_QUOTEDprivate static intPEEKED_DOUBLE_QUOTED_NAMEprivate static intPEEKED_END_ARRAYprivate static intPEEKED_END_OBJECTprivate static intPEEKED_EOFprivate static intPEEKED_FALSEprivate static intPEEKED_LONGWhen this is returned, the integer value is stored in peekedLong.private static intPEEKED_NONEprivate static intPEEKED_NULLprivate static intPEEKED_NUMBERprivate static intPEEKED_SINGLE_QUOTEDprivate static intPEEKED_SINGLE_QUOTED_NAMEprivate static intPEEKED_TRUEprivate static intPEEKED_UNQUOTEDprivate static intPEEKED_UNQUOTED_NAMEprivate longpeekedLongA peeked value that was composed entirely of digits with an optional leading dash.private intpeekedNumberLengthThe number of characters in a peeked number literal.private java.lang.StringpeekedStringA peeked string that should be parsed on the next double, long or string.private intposprivate int[]stackThe nesting stack.private intstackSizeprivate Strictnessstrictness
-
Constructor Summary
Constructors Constructor Description JsonReader(java.io.Reader in)Creates a new instance that reads a JSON-encoded stream fromin.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidbeginArray()Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.voidbeginObject()Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.private voidcheckLenient()voidclose()Closes this JSON reader and the underlyingReader.private voidconsumeNonExecutePrefix()Consumes the non-execute prefix if it exists.(package private) intdoPeek()voidendArray()Consumes the next token from the JSON stream and asserts that it is the end of the current array.voidendObject()Consumes the next token from the JSON stream and asserts that it is the end of the current object.private booleanfillBuffer(int minimum)Returns true oncelimit - pos >= minimum.intgetNestingLimit()Returns the nesting limit of this reader.java.lang.StringgetPath()Returns a JSONPath in dot-notation to the next (or current) location in the JSON document.private java.lang.StringgetPath(boolean usePreviousPath)java.lang.StringgetPreviousPath()Returns a JSONPath in dot-notation to the previous (or current) location in the JSON document.StrictnessgetStrictness()Returns the strictness of this reader.booleanhasNext()Returns true if the current array or object has another element.booleanisLenient()Returns true if theStrictnessof this reader is equal toStrictness.LENIENT.private booleanisLiteral(char c)(package private) java.lang.StringlocationString()booleannextBoolean()Returns thebooleanvalue of the next token, consuming it.doublenextDouble()Returns thedoublevalue of the next token, consuming it.intnextInt()Returns theintvalue of the next token, consuming it.longnextLong()Returns thelongvalue of the next token, consuming it.java.lang.StringnextName()Returns the next token, aproperty name, and consumes it.private intnextNonWhitespace(boolean throwOnEof)Returns the next character in the stream that is neither whitespace nor a part of a comment.voidnextNull()Consumes the next token from the JSON stream and asserts that it is a literal null.private java.lang.StringnextQuotedValue(char quote)Returns the string up to but not includingquote, unescaping any character escape sequences encountered along the way.java.lang.StringnextString()Returns thestringvalue of the next token, consuming it.private java.lang.StringnextUnquotedValue()Returns an unquoted value as a string.JsonTokenpeek()Returns the type of the next token without consuming it.private intpeekKeyword()private intpeekNumber()private voidpush(int newTop)private charreadEscapeCharacter()Unescapes the character identified by the character or characters that immediately follow a backslash.voidsetLenient(boolean lenient)Deprecated.Please usesetStrictness(Strictness)instead.voidsetNestingLimit(int limit)Sets the nesting limit of this reader.voidsetStrictness(Strictness strictness)Configures how liberal this parser is in what it accepts.private voidskipQuotedValue(char quote)private booleanskipTo(java.lang.String toFind)private voidskipToEndOfLine()Advances the position until after the next newline character.private voidskipUnquotedValue()voidskipValue()Skips the next value recursively.private MalformedJsonExceptionsyntaxError(java.lang.String message)Throws a newMalformedJsonExceptionwith the given message and information about the current location.java.lang.StringtoString()private java.lang.IllegalStateExceptionunexpectedTokenError(java.lang.String expected)
-
-
-
Field Detail
-
MIN_INCOMPLETE_INTEGER
private static final long MIN_INCOMPLETE_INTEGER
- See Also:
- Constant Field Values
-
PEEKED_NONE
private static final int PEEKED_NONE
- See Also:
- Constant Field Values
-
PEEKED_BEGIN_OBJECT
private static final int PEEKED_BEGIN_OBJECT
- See Also:
- Constant Field Values
-
PEEKED_END_OBJECT
private static final int PEEKED_END_OBJECT
- See Also:
- Constant Field Values
-
PEEKED_BEGIN_ARRAY
private static final int PEEKED_BEGIN_ARRAY
- See Also:
- Constant Field Values
-
PEEKED_END_ARRAY
private static final int PEEKED_END_ARRAY
- See Also:
- Constant Field Values
-
PEEKED_TRUE
private static final int PEEKED_TRUE
- See Also:
- Constant Field Values
-
PEEKED_FALSE
private static final int PEEKED_FALSE
- See Also:
- Constant Field Values
-
PEEKED_NULL
private static final int PEEKED_NULL
- See Also:
- Constant Field Values
-
PEEKED_SINGLE_QUOTED
private static final int PEEKED_SINGLE_QUOTED
- See Also:
- Constant Field Values
-
PEEKED_DOUBLE_QUOTED
private static final int PEEKED_DOUBLE_QUOTED
- See Also:
- Constant Field Values
-
PEEKED_UNQUOTED
private static final int PEEKED_UNQUOTED
- See Also:
- Constant Field Values
-
PEEKED_BUFFERED
private static final int PEEKED_BUFFERED
When this is returned, the string value is stored in peekedString.- See Also:
- Constant Field Values
-
PEEKED_SINGLE_QUOTED_NAME
private static final int PEEKED_SINGLE_QUOTED_NAME
- See Also:
- Constant Field Values
-
PEEKED_DOUBLE_QUOTED_NAME
private static final int PEEKED_DOUBLE_QUOTED_NAME
- See Also:
- Constant Field Values
-
PEEKED_UNQUOTED_NAME
private static final int PEEKED_UNQUOTED_NAME
- See Also:
- Constant Field Values
-
PEEKED_LONG
private static final int PEEKED_LONG
When this is returned, the integer value is stored in peekedLong.- See Also:
- Constant Field Values
-
PEEKED_NUMBER
private static final int PEEKED_NUMBER
- See Also:
- Constant Field Values
-
PEEKED_EOF
private static final int PEEKED_EOF
- See Also:
- Constant Field Values
-
NUMBER_CHAR_NONE
private static final int NUMBER_CHAR_NONE
- See Also:
- Constant Field Values
-
NUMBER_CHAR_SIGN
private static final int NUMBER_CHAR_SIGN
- See Also:
- Constant Field Values
-
NUMBER_CHAR_DIGIT
private static final int NUMBER_CHAR_DIGIT
- See Also:
- Constant Field Values
-
NUMBER_CHAR_DECIMAL
private static final int NUMBER_CHAR_DECIMAL
- See Also:
- Constant Field Values
-
NUMBER_CHAR_FRACTION_DIGIT
private static final int NUMBER_CHAR_FRACTION_DIGIT
- See Also:
- Constant Field Values
-
NUMBER_CHAR_EXP_E
private static final int NUMBER_CHAR_EXP_E
- See Also:
- Constant Field Values
-
NUMBER_CHAR_EXP_SIGN
private static final int NUMBER_CHAR_EXP_SIGN
- See Also:
- Constant Field Values
-
NUMBER_CHAR_EXP_DIGIT
private static final int NUMBER_CHAR_EXP_DIGIT
- See Also:
- Constant Field Values
-
in
private final java.io.Reader in
The input JSON.
-
strictness
private Strictness strictness
-
DEFAULT_NESTING_LIMIT
static final int DEFAULT_NESTING_LIMIT
- See Also:
- Constant Field Values
-
nestingLimit
private int nestingLimit
-
BUFFER_SIZE
static final int BUFFER_SIZE
- See Also:
- Constant Field Values
-
buffer
private final char[] buffer
Use a manual buffer to easily read and unread upcoming characters, and also so we can create strings without an intermediate StringBuilder. We decode literals directly out of this buffer, so it must be at least as long as the longest token that can be reported as a number.
-
pos
private int pos
-
limit
private int limit
-
lineNumber
private int lineNumber
-
lineStart
private int lineStart
-
peeked
int peeked
-
peekedLong
private long peekedLong
A peeked value that was composed entirely of digits with an optional leading dash. Positive values may not have a leading 0.
-
peekedNumberLength
private int peekedNumberLength
The number of characters in a peeked number literal. Increment 'pos' by this after reading a number.
-
peekedString
private java.lang.String peekedString
A peeked string that should be parsed on the next double, long or string. This is populated before a numeric value is parsed and used if that parsing fails.
-
stack
private int[] stack
The nesting stack. Using a manual array rather than an ArrayList saves 20%.
-
stackSize
private int stackSize
-
pathNames
private java.lang.String[] pathNames
-
pathIndices
private int[] pathIndices
-
-
Method Detail
-
setLenient
@Deprecated public final void setLenient(boolean lenient)
Deprecated.Please usesetStrictness(Strictness)instead.JsonReader.setLenient(true)should be replaced byJsonReader.setStrictness(Strictness.LENIENT)andJsonReader.setLenient(false)should be replaced byJsonReader.setStrictness(Strictness.LEGACY_STRICT).
However, if you usedsetLenient(false)before, you might preferStrictness.STRICTnow instead.Sets the strictness of this reader.- Parameters:
lenient- whether this reader should be lenient. If true, the strictness is set toStrictness.LENIENT. If false, the strictness is set toStrictness.LEGACY_STRICT.- See Also:
setStrictness(Strictness)
-
isLenient
public final boolean isLenient()
Returns true if theStrictnessof this reader is equal toStrictness.LENIENT.- See Also:
getStrictness()
-
setStrictness
public final void setStrictness(Strictness strictness)
Configures how liberal this parser is in what it accepts.In strict mode, the parser only accepts JSON in accordance with RFC 8259. In legacy strict mode (the default), only JSON in accordance with the RFC 8259 is accepted, with a few exceptions denoted below for backwards compatibility reasons. In lenient mode, all sort of non-spec compliant JSON is accepted (see below).
Strictness.STRICT- In strict mode, only input compliant with RFC 8259 is accepted.
Strictness.LEGACY_STRICT- In legacy strict mode, the following departures from RFC 8259 are accepted:
- JsonReader allows the literals
true,falseandnullto have any capitalization, for examplefAlSeorNULL - JsonReader supports the escape sequence
\', representing a'(single-quote) - JsonReader supports the escape sequence
\LF(withLFbeing the Unicode characterU+000A), resulting in aLFwithin the read JSON string - JsonReader allows unescaped control characters (
U+0000throughU+001F)
- JsonReader allows the literals
Strictness.LENIENT- In lenient mode, all input that is accepted in legacy strict mode is accepted in addition
to the following departures from RFC 8259:
- Streams that start with the non-execute prefix,
")]'\n"} - Streams that include multiple top-level values. With legacy strict or strict parsing, each stream must contain exactly one top-level value.
- Numbers may be
NaNsorinfinitiesrepresented byNaNand(-)Infinityrespectively. - End of line comments starting with
//or#and ending with a newline character. - C-style comments starting with
/*and ending with*/. Such comments may not be nested. - Names that are unquoted or
'single quoted'. - Strings that are unquoted or
'single quoted'. - Array elements separated by
;instead of,. - Unnecessary array separators. These are interpreted as if null was the omitted value.
- Names and values separated by
=or=>instead of:. - Name/value pairs separated by
;instead of,.
- Streams that start with the non-execute prefix,
- Parameters:
strictness- the new strictness value of this reader. May not benull.- Since:
- 2.11.0
- See Also:
getStrictness()
-
getStrictness
public final Strictness getStrictness()
Returns the strictness of this reader.- Since:
- 2.11.0
- See Also:
setStrictness(Strictness)
-
setNestingLimit
public final void setNestingLimit(int limit)
Sets the nesting limit of this reader.The nesting limit defines how many JSON arrays or objects may be open at the same time. For example a nesting limit of 0 means no arrays or objects may be opened at all, a nesting limit of 1 means one array or object may be open at the same time, and so on. So a nesting limit of 3 allows reading the JSON data
[{"a":[true]}], but for a nesting limit of 2 it would fail at the inner[true].The nesting limit can help to protect against a
StackOverflowErrorwhen recursiveTypeAdapterimplementations process deeply nested JSON data.The default nesting limit is 255.
- Throws:
java.lang.IllegalArgumentException- if the nesting limit is negative.- Since:
- 2.12.0
- See Also:
getNestingLimit()
-
getNestingLimit
public final int getNestingLimit()
Returns the nesting limit of this reader.- Since:
- 2.12.0
- See Also:
setNestingLimit(int)
-
beginArray
public void beginArray() throws java.io.IOExceptionConsumes the next token from the JSON stream and asserts that it is the beginning of a new array.- Throws:
java.lang.IllegalStateException- if the next token is not the beginning of an array.java.io.IOException
-
endArray
public void endArray() throws java.io.IOExceptionConsumes the next token from the JSON stream and asserts that it is the end of the current array.- Throws:
java.lang.IllegalStateException- if the next token is not the end of an array.java.io.IOException
-
beginObject
public void beginObject() throws java.io.IOExceptionConsumes the next token from the JSON stream and asserts that it is the beginning of a new object.- Throws:
java.lang.IllegalStateException- if the next token is not the beginning of an object.java.io.IOException
-
endObject
public void endObject() throws java.io.IOExceptionConsumes the next token from the JSON stream and asserts that it is the end of the current object.- Throws:
java.lang.IllegalStateException- if the next token is not the end of an object.java.io.IOException
-
hasNext
public boolean hasNext() throws java.io.IOExceptionReturns true if the current array or object has another element.- Throws:
java.io.IOException
-
peek
public JsonToken peek() throws java.io.IOException
Returns the type of the next token without consuming it.- Throws:
java.io.IOException
-
doPeek
int doPeek() throws java.io.IOException- Throws:
java.io.IOException
-
peekKeyword
private int peekKeyword() throws java.io.IOException- Throws:
java.io.IOException
-
peekNumber
private int peekNumber() throws java.io.IOException- Throws:
java.io.IOException
-
isLiteral
private boolean isLiteral(char c) throws java.io.IOException- Throws:
java.io.IOException
-
nextName
public java.lang.String nextName() throws java.io.IOExceptionReturns the next token, aproperty name, and consumes it.- Throws:
java.lang.IllegalStateException- if the next token is not a property name.java.io.IOException
-
nextString
public java.lang.String nextString() throws java.io.IOExceptionReturns thestringvalue of the next token, consuming it. If the next token is a number, this method will return its string form.- Throws:
java.lang.IllegalStateException- if the next token is not a string.java.io.IOException
-
nextBoolean
public boolean nextBoolean() throws java.io.IOExceptionReturns thebooleanvalue of the next token, consuming it.- Throws:
java.lang.IllegalStateException- if the next token is not a boolean.java.io.IOException
-
nextNull
public void nextNull() throws java.io.IOExceptionConsumes the next token from the JSON stream and asserts that it is a literal null.- Throws:
java.lang.IllegalStateException- if the next token is not a JSON null.java.io.IOException
-
nextDouble
public double nextDouble() throws java.io.IOExceptionReturns thedoublevalue of the next token, consuming it. If the next token is a string, this method will attempt to parse it as a double usingDouble.parseDouble(String).- Throws:
java.lang.IllegalStateException- if the next token is neither a number nor a string.java.lang.NumberFormatException- if the next literal value cannot be parsed as a double.MalformedJsonException- if the next literal value is NaN or Infinity and this reader is notlenient.java.io.IOException
-
nextLong
public long nextLong() throws java.io.IOExceptionReturns thelongvalue of the next token, consuming it. If the next token is a string, this method will attempt to parse it as a long. If the next token's numeric value cannot be exactly represented by a Javalong, this method throws.- Throws:
java.lang.IllegalStateException- if the next token is neither a number nor a string.java.lang.NumberFormatException- if the next literal value cannot be parsed as a number, or exactly represented as a long.java.io.IOException
-
nextQuotedValue
private java.lang.String nextQuotedValue(char quote) throws java.io.IOExceptionReturns the string up to but not includingquote, unescaping any character escape sequences encountered along the way. The opening quote should have already been read. This consumes the closing quote, but does not include it in the returned string.- Parameters:
quote- either ' or ".- Throws:
java.io.IOException
-
nextUnquotedValue
private java.lang.String nextUnquotedValue() throws java.io.IOExceptionReturns an unquoted value as a string.- Throws:
java.io.IOException
-
skipQuotedValue
private void skipQuotedValue(char quote) throws java.io.IOException- Throws:
java.io.IOException
-
skipUnquotedValue
private void skipUnquotedValue() throws java.io.IOException- Throws:
java.io.IOException
-
nextInt
public int nextInt() throws java.io.IOExceptionReturns theintvalue of the next token, consuming it. If the next token is a string, this method will attempt to parse it as an int. If the next token's numeric value cannot be exactly represented by a Javaint, this method throws.- Throws:
java.lang.IllegalStateException- if the next token is neither a number nor a string.java.lang.NumberFormatException- if the next literal value cannot be parsed as a number, or exactly represented as an int.java.io.IOException
-
close
public void close() throws java.io.IOExceptionCloses this JSON reader and the underlyingReader.Using the JSON reader after it has been closed will throw an
IllegalStateExceptionin most cases.- Specified by:
closein interfacejava.lang.AutoCloseable- Specified by:
closein interfacejava.io.Closeable- Throws:
java.io.IOException
-
skipValue
public void skipValue() throws java.io.IOExceptionSkips the next value recursively. This method is intended for use when the JSON token stream contains unrecognized or unhandled values.The behavior depends on the type of the next JSON token:
- Start of a JSON array or object: It and all of its nested values are skipped.
- Primitive value (for example a JSON number): The primitive value is skipped.
- Property name: Only the name but not the value of the property is skipped.
skipValue()has to be called again to skip the property value as well. - End of a JSON array or object: Only this end token is skipped.
- End of JSON document: Skipping has no effect, the next token continues to be the end of the document.
- Throws:
java.io.IOException
-
push
private void push(int newTop) throws MalformedJsonException- Throws:
MalformedJsonException
-
fillBuffer
private boolean fillBuffer(int minimum) throws java.io.IOExceptionReturns true oncelimit - pos >= minimum. If the data is exhausted before that many characters are available, this returns false.- Throws:
java.io.IOException
-
nextNonWhitespace
private int nextNonWhitespace(boolean throwOnEof) throws java.io.IOExceptionReturns the next character in the stream that is neither whitespace nor a part of a comment. When this returns, the returned character is always atbuffer[pos-1]; this means the caller can always push back the returned character by decrementingpos.- Throws:
java.io.IOException
-
checkLenient
private void checkLenient() throws MalformedJsonException- Throws:
MalformedJsonException
-
skipToEndOfLine
private void skipToEndOfLine() throws java.io.IOExceptionAdvances the position until after the next newline character. If the line is terminated by "\r\n", the '\n' must be consumed as whitespace by the caller.- Throws:
java.io.IOException
-
skipTo
private boolean skipTo(java.lang.String toFind) throws java.io.IOException- Parameters:
toFind- a string to search for. Must not contain a newline.- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
locationString
java.lang.String locationString()
-
getPath
private java.lang.String getPath(boolean usePreviousPath)
-
getPath
public java.lang.String getPath()
Returns a JSONPath in dot-notation to the next (or current) location in the JSON document. That means:- For JSON arrays the path points to the index of the next element (even if there are no further elements).
- For JSON objects the path points to the last property, or to the current property if its name has already been consumed.
This method can be useful to add additional context to exception messages before a value is consumed, for example when the peeked token is unexpected.
-
getPreviousPath
public java.lang.String getPreviousPath()
Returns a JSONPath in dot-notation to the previous (or current) location in the JSON document. That means:- For JSON arrays the path points to the index of the previous element.
If no element has been consumed yet it uses the index 0 (even if there are no elements). - For JSON objects the path points to the last property, or to the current property if its name has already been consumed.
This method can be useful to add additional context to exception messages after a value has been consumed.
- For JSON arrays the path points to the index of the previous element.
-
readEscapeCharacter
private char readEscapeCharacter() throws java.io.IOExceptionUnescapes the character identified by the character or characters that immediately follow a backslash. The backslash '\' should have already been read. This supports both Unicode escapes "u000A" and two-character escapes "\n".- Throws:
MalformedJsonException- if the escape sequence is malformedjava.io.IOException
-
syntaxError
private MalformedJsonException syntaxError(java.lang.String message) throws MalformedJsonException
Throws a newMalformedJsonExceptionwith the given message and information about the current location.- Throws:
MalformedJsonException
-
unexpectedTokenError
private java.lang.IllegalStateException unexpectedTokenError(java.lang.String expected) throws java.io.IOException- Throws:
java.io.IOException
-
consumeNonExecutePrefix
private void consumeNonExecutePrefix() throws java.io.IOExceptionConsumes the non-execute prefix if it exists.- Throws:
java.io.IOException
-
-