UTF8StreamJsonParser

Flag that indicates whether the input buffer is recycable (and needs to be returned to recycler once we are done) or not.

If it is not, it also means that parser can NOT modify underlying buffer.

Current buffer from which data is read; generally data is read into buffer from input source, but in some cases pre-loaded buffer is handed to the parser.

Codec used for data binding when (if) requested; typically full ObjectMapper, but that abstract is not part of core package.

Temporary buffer used for name parsing.

Symbol table that contains field names encountered so far

Flag that indicates that the current token has not yet been fully processed, and needs to be finished for some access (or skipped to obtain the next token)

Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature AUTO_CLOSE_SOURCE is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so check JsonFactory for details, but the general idea is that if caller passes in closable resource (such as InputStream or Reader) parser does NOT own the source; but if it passes a reference (such as java.io.File or java.net.URL and creates stream or reader it does own them.

Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value. It works similar to getting String value via getText() and decoding result (except for decoding part), but should be significantly more performant.

Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.

Accessor for ObjectCodec associated with this parser, if any. Codec is used by readValueAs(Class) method (and its variants).

Accessor that can be called if (and only if) the current token is VALUE_EMBEDDED_OBJECT. For other token types, null is returned.

Note: only some specialized parser implementations support embedding of objects (usually ones that are facades on top of non-streaming sources, such as object trees).

Method that can be used to get access to object that is used to access input being parsed; this is usually either InputStream or Reader, depending on what parser was constructed with. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object.

In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.

Method for accessing textual representation of the current token; if no current token (before first call to nextToken(), or after encountering end-of-input), returns null. Method can be called for any token type.

Method similar to getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:

• Textual contents are not guaranteed to start at index 0 (rather, call getTextOffset()) to know the actual offset
• Length of textual contents may be less than the length of returned buffer: call getTextLength() for actual length of returned content.

Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.

The only reason to call this method (over getText()) is to avoid construction of a String object (which will make a copy of contents).

Accessor used with getTextCharacters(), to know length of String stored in returned buffer.

Accessor used with getTextCharacters(), to know offset of the first text content character within buffer.

Method that fetches next token (as if calling nextToken()) and if it is VALUE_TRUE or VALUE_FALSE returns matching Boolean value; otherwise return null. It is functionally equivalent to:

  JsonToken t = nextToken();
  if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE;
  if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE;
  return null;

Method that fetches next token (as if calling nextToken()) and verifies whether it is FIELD_NAME with specified name and returns result of that comparison. It is functionally equivalent to:

  return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(getCurrentName());

Method that fetches next token (as if calling nextToken()) and if it is VALUE_NUMBER_INT returns 32-bit int value; otherwise returns specified default value It is functionally equivalent to:

  return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getIntValue() : defaultValue;

Method that fetches next token (as if calling nextToken()) and if it is VALUE_NUMBER_INT returns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:

  return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getLongValue() : defaultValue;

Method that fetches next token (as if calling nextToken()) and if it is VALUE_STRING returns contained String value; otherwise returns null. It is functionally equivalent to:

  return (nextToken() == JsonToken.VALUE_STRING) ? getText() : null;

Main iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.

Similar to readBinaryValue(OutputStream) but allows explicitly specifying base64 variant to use.

Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given stream if possible; if underlying input is byte-based it can released, if not (char-based) it can not.

Setter that allows defining ObjectCodec associated with this parser, if any. Codec is used by readValueAs(Class) method (and its variants).

Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.

Efficient handling for incremental parsing of base64-encoded textual content.

Method that sub-classes must implement to support escaped sequences in base64-encoded sections. Sub-classes that do not need base64 support can leave this as is

Method called if expected numeric value (due to leading sign) does not look like a number

Method for handling cases where first non-space character of an expected value token is not legal for standard JSON content.

Method called when we see non-white space character other than double quote, when expecting a field name. In standard mode will just throw an expection; but in non-standard modes may be able to parse name.

Helper method that will try to load at least specified number bytes in input buffer, possible moving existing data around if necessary

Method called to release internal buffers owned by the base reader. This may be called along with _closeInput() (for example, when explicitly closing this reader instance), or separately (if need be).

We actually need to check the character value here (to see if we have \n following \r).

Method called to skim through rest of unparsed String value, if it is not needed. This can be done bit faster if contents need not be stored for future access.

Slower parsing method which is generally branched to when an escape sequence is detected (or alternatively for long names, or ones crossing input buffer boundary). In any case, needs to be able to handle more exceptional cases, gets slower, and hance is offlined to a separate method.

Initial parsing method for number values. It needs to be able to parse enough input to be able to determine whether the value is to be considered a simple integer value, or a more generic decimal value: latter of which needs to be expressed as a floating point number. The basic rule is that if the number has no fractional or exponential part, it is an integer; otherwise a floating point number.

Because much of input has to be processed in any case, no partial parsing is done: all input text will be stored for further processing. However, actual numeric value conversion will be deferred, since it is usually the most complicated and costliest part of processing.

Method called when not even first 8 bytes are guaranteed to come consequtively. Happens rarely, so this is offlined; plus we'll also do full checks for escaping etc.