Module tools.jackson.core
Package tools.jackson.core.json.async

Class NonBlockingJsonParserBase

java.lang.Object
tools.jackson.core.JsonParser
tools.jackson.core.base.ParserMinimalBase
tools.jackson.core.base.ParserBase
tools.jackson.core.json.JsonParserBase
tools.jackson.core.json.async.NonBlockingJsonParserBase
All Implemented Interfaces:
Closeable, AutoCloseable, Versioned
Direct Known Subclasses:
NonBlockingUtf8JsonParserBase
public abstract class NonBlockingJsonParserBase extends JsonParserBase
Intermediate base class for non-blocking JSON parsers.

  • Field Details

    • MAJOR_INITIAL

      protected static final int MAJOR_INITIAL
      State right after parser has been constructed, before seeing the first byte to handle possible (but optional) BOM.
      See Also:

    • MAJOR_ROOT

      protected static final int MAJOR_ROOT
      State right after parser a root value has been finished, but next token has not yet been recognized.
      See Also:

    • MAJOR_OBJECT_PROPERTY_FIRST

      protected static final int MAJOR_OBJECT_PROPERTY_FIRST
      See Also:

    • MAJOR_OBJECT_PROPERTY_NEXT

      protected static final int MAJOR_OBJECT_PROPERTY_NEXT
      See Also:

    • MAJOR_OBJECT_VALUE

      protected static final int MAJOR_OBJECT_VALUE
      See Also:

    • MAJOR_ARRAY_ELEMENT_FIRST

      protected static final int MAJOR_ARRAY_ELEMENT_FIRST
      See Also:

    • MAJOR_ARRAY_ELEMENT_NEXT

      protected static final int MAJOR_ARRAY_ELEMENT_NEXT
      See Also:

    • MAJOR_CLOSED

      protected static final int MAJOR_CLOSED
      State after non-blocking input source has indicated that no more input is forthcoming AND we have exhausted all the input
      See Also:

    • MINOR_ROOT_BOM

      protected static final int MINOR_ROOT_BOM
      State in which part of (UTF-8) BOM has been detected, but not yet completely.
      See Also:

    • MINOR_ROOT_NEED_SEPARATOR

      protected static final int MINOR_ROOT_NEED_SEPARATOR
      State between root-level value, waiting for at least one white-space character as separator
      See Also:

    • MINOR_ROOT_GOT_SEPARATOR

      protected static final int MINOR_ROOT_GOT_SEPARATOR
      State between root-level value, having processed at least one white-space character, and expecting either more, start of a value, or end of input stream.
      See Also:

    • MINOR_PROPERTY_LEADING_WS

      protected static final int MINOR_PROPERTY_LEADING_WS
      See Also:

    • MINOR_PROPERTY_LEADING_COMMA

      protected static final int MINOR_PROPERTY_LEADING_COMMA
      See Also:

    • MINOR_PROPERTY_NAME

      protected static final int MINOR_PROPERTY_NAME
      See Also:

    • MINOR_PROPERTY_NAME_ESCAPE

      protected static final int MINOR_PROPERTY_NAME_ESCAPE
      See Also:

    • MINOR_PROPERTY_APOS_NAME

      protected static final int MINOR_PROPERTY_APOS_NAME
      See Also:

    • MINOR_PROPERTY_UNQUOTED_NAME

      protected static final int MINOR_PROPERTY_UNQUOTED_NAME
      See Also:

    • MINOR_VALUE_LEADING_WS

      protected static final int MINOR_VALUE_LEADING_WS
      See Also:

    • MINOR_VALUE_EXPECTING_COMMA

      protected static final int MINOR_VALUE_EXPECTING_COMMA
      See Also:

    • MINOR_VALUE_EXPECTING_COLON

      protected static final int MINOR_VALUE_EXPECTING_COLON
      See Also:

    • MINOR_VALUE_WS_AFTER_COMMA

      protected static final int MINOR_VALUE_WS_AFTER_COMMA
      See Also:

    • MINOR_VALUE_TOKEN_NULL

      protected static final int MINOR_VALUE_TOKEN_NULL
      See Also:

    • MINOR_VALUE_TOKEN_TRUE

      protected static final int MINOR_VALUE_TOKEN_TRUE
      See Also:

    • MINOR_VALUE_TOKEN_FALSE

      protected static final int MINOR_VALUE_TOKEN_FALSE
      See Also:

    • MINOR_VALUE_TOKEN_NON_STD

      protected static final int MINOR_VALUE_TOKEN_NON_STD
      See Also:

    • MINOR_NUMBER_PLUS

      protected static final int MINOR_NUMBER_PLUS
      See Also:

    • MINOR_NUMBER_MINUS

      protected static final int MINOR_NUMBER_MINUS
      See Also:

    • MINOR_NUMBER_ZERO

      protected static final int MINOR_NUMBER_ZERO
      See Also:

    • MINOR_NUMBER_MINUSZERO

      protected static final int MINOR_NUMBER_MINUSZERO
      See Also:

    • MINOR_NUMBER_INTEGER_DIGITS

      protected static final int MINOR_NUMBER_INTEGER_DIGITS
      See Also:

    • MINOR_NUMBER_FRACTION_DIGITS

      protected static final int MINOR_NUMBER_FRACTION_DIGITS
      See Also:

    • MINOR_NUMBER_EXPONENT_MARKER

      protected static final int MINOR_NUMBER_EXPONENT_MARKER
      See Also:

    • MINOR_NUMBER_EXPONENT_DIGITS

      protected static final int MINOR_NUMBER_EXPONENT_DIGITS
      See Also:

    • MINOR_VALUE_STRING

      protected static final int MINOR_VALUE_STRING
      See Also:

    • MINOR_VALUE_STRING_ESCAPE

      protected static final int MINOR_VALUE_STRING_ESCAPE
      See Also:

    • MINOR_VALUE_STRING_UTF8_2

      protected static final int MINOR_VALUE_STRING_UTF8_2
      See Also:

    • MINOR_VALUE_STRING_UTF8_3

      protected static final int MINOR_VALUE_STRING_UTF8_3
      See Also:

    • MINOR_VALUE_STRING_UTF8_4

      protected static final int MINOR_VALUE_STRING_UTF8_4
      See Also:

    • MINOR_VALUE_APOS_STRING

      protected static final int MINOR_VALUE_APOS_STRING
      See Also:

    • MINOR_VALUE_TOKEN_ERROR

      protected static final int MINOR_VALUE_TOKEN_ERROR
      Special state at which point decoding of a non-quoted token has encountered a problem; that is, either not matching fully (like "truf" instead of "true", at "tru"), or not having trailing separator (or end of input), like "trueful". Attempt is made, then, to decode likely full input token to report suitable error.
      See Also:

    • MINOR_COMMENT_LEADING_SLASH

      protected static final int MINOR_COMMENT_LEADING_SLASH
      See Also:

    • MINOR_COMMENT_CLOSING_ASTERISK

      protected static final int MINOR_COMMENT_CLOSING_ASTERISK
      See Also:

    • MINOR_COMMENT_C

      protected static final int MINOR_COMMENT_C
      See Also:

    • MINOR_COMMENT_CPP

      protected static final int MINOR_COMMENT_CPP
      See Also:

    • MINOR_COMMENT_YAML

      protected static final int MINOR_COMMENT_YAML
      See Also:

    • _symbols

      protected final ByteQuadsCanonicalizer _symbols
      Symbol table that contains property names encountered so far

    • _quadBuffer

      protected int[] _quadBuffer
      Temporary buffer used for name parsing.

    • _quadLength

      protected int _quadLength

    • _quad1

      protected int _quad1

    • _pending32

      protected int _pending32

    • _pendingBytes

      protected int _pendingBytes

    • _quoted32

      protected int _quoted32

    • _quotedDigits

      protected int _quotedDigits

    • _majorState

      protected int _majorState
      Current main decoding state within logical tree

    • _majorStateAfterValue

      protected int _majorStateAfterValue
      Value of _majorState after completing a scalar value

    • _minorState

      protected int _minorState
      Additional indicator within state; contextually relevant for just that state

    • _minorStateAfterSplit

      protected int _minorStateAfterSplit
      Secondary minor state indicator used during decoding of escapes and/or multi-byte Unicode characters

    • _endOfInput

      protected boolean _endOfInput
      Flag that is sent when calling application indicates that there will be no more input to parse.

    • NON_STD_TOKEN_NAN

      protected static final int NON_STD_TOKEN_NAN
      See Also:

    • NON_STD_TOKEN_INFINITY

      protected static final int NON_STD_TOKEN_INFINITY
      See Also:

    • NON_STD_TOKEN_PLUS_INFINITY

      protected static final int NON_STD_TOKEN_PLUS_INFINITY
      See Also:

    • NON_STD_TOKEN_MINUS_INFINITY

      protected static final int NON_STD_TOKEN_MINUS_INFINITY
      See Also:

    • NON_STD_TOKENS

      protected static final String[] NON_STD_TOKENS

    • NON_STD_TOKEN_VALUES

      protected static final double[] NON_STD_TOKEN_VALUES

    • _nonStdTokenType

      protected int _nonStdTokenType
      When tokenizing non-standard ("odd") tokens, this is the type to consider; also works as index to actual textual representation.

    • _currBufferStart

      protected int _currBufferStart
      Since we are fed content that may or may not start at zero offset, we need to keep track of the first byte within that buffer, to be able to calculate logical offset within input "stream"

    • _currInputRowAlt

      protected int _currInputRowAlt
      Alternate row tracker, used to keep track of position by `\r` marker (whereas _currInputRow tracks `\n`). Used to simplify tracking of linefeeds, assuming that input typically uses various linefeed combinations (`\r`, `\n` or `\r\n`) consistently, in which case we can simply choose max of two row candidates.

  • Constructor Details

  • Method Details

    • canParseAsync

      public boolean canParseAsync()
      Description copied from class: JsonParser
      Method that can be called to determine if this parser instance uses non-blocking ("asynchronous") input access for decoding or not. Access mode is determined by earlier calls via JsonFactory; it may not be changed after construction.

      If non-blocking decoding is true, it is possible to call JsonParser.nonBlockingInputFeeder() to obtain object to use for feeding input; otherwise (false returned) input is read by blocking.

      Overrides:
      canParseAsync in class JsonParser
      Returns:
      True if this is a non-blocking ("asynchronous") parser

    • symbolTableForTests

      public ByteQuadsCanonicalizer symbolTableForTests()

    • releaseBuffered

      public abstract int releaseBuffered(OutputStream out) throws JacksonException
      Description copied from class: JsonParser
      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 cannot.
      Overrides:
      releaseBuffered in class JsonParser
      Parameters:
      out - OutputStream to which buffered, undecoded content is written to
      Returns:
      -1 if the underlying content source is not byte based (that is, input cannot be sent to OutputStream; otherwise number of bytes released (0 if there was nothing to release)
      Throws:
      JacksonException - if write to stream threw exception

    • _releaseBuffers

      protected void _releaseBuffers() throws JacksonException
      Description copied from class: ParserMinimalBase
      Method called to release internal buffers owned by the base reader. This is expected to be called after ParserMinimalBase._closeInput() since the buffers are expected not to be needed any longer.
      Overrides:
      _releaseBuffers in class ParserBase
      Throws:
      JacksonException

    • streamReadInputSource

      public Object streamReadInputSource()
      Description copied from class: JsonParser
      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.

      NOTE: was named getInputSource() in Jackson 2.x.

      Specified by:
      streamReadInputSource in class JsonParser
      Returns:
      Input source this parser was configured with

    • _closeInput

      protected void _closeInput()
      Description copied from class: ParserMinimalBase
      Abstract method for sub-classes to implement; to be called by ParserMinimalBase.close() implementation here.
      Specified by:
      _closeInput in class ParserMinimalBase

    • hasStringCharacters

      public boolean hasStringCharacters()
      Description copied from class: JsonParser
      Method that can be used to determine whether calling of JsonParser.getStringCharacters() would be the most efficient way to access String value for the event parser currently points to (compared to JsonParser.getString()).
      Overrides:
      hasStringCharacters in class JsonParserBase
      Returns:
      True if parser currently has character array that can be efficiently returned via JsonParser.getStringCharacters(); false means that it may or may not exist

    • currentLocation

      public TokenStreamLocation currentLocation()
      Description copied from class: JsonParser
      Method that returns location of the last processed character; usually for error reporting purposes.

      Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only report specific boundary locations (start or end locations of tokens) and others only return TokenStreamLocation.NA due to not having access to input location information (when delegating actual decoding work to other library).

      Specified by:
      currentLocation in class JsonParser
      Returns:
      Location of the last processed input unit (byte or character)

    • _currentLocationMinusOne

      protected TokenStreamLocation _currentLocationMinusOne()
      Description copied from class: ParserMinimalBase
      Factory method used to provide location for cases where we must read and consume a single "wrong" character (to possibly allow error recovery), but need to report accurate location for that character: if so, the current location is past location we want, and location we want will be "one location earlier".

      Default implementation simply returns JsonParser.currentLocation()

      Overrides:
      _currentLocationMinusOne in class ParserMinimalBase
      Returns:
      Same as JsonParser.currentLocation() except offset by -1

    • currentTokenLocation

      public TokenStreamLocation currentTokenLocation()
      Description copied from class: JsonParser
      Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.

      Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only return TokenStreamLocation.NA due to not having access to input location information (when delegating actual decoding work to other library).

      Specified by:
      currentTokenLocation in class JsonParser
      Returns:
      Starting location of the token parser currently points to

    • getString

      public String getString() throws JacksonException
      Method for accessing textual representation of the current event; if no current event (before first call to JsonParser.nextToken(), or after encountering end-of-input), returns null. Method can be called for any event.
      Specified by:
      getString in class JsonParser
      Returns:
      String value associated with the current token (one returned by JsonParser.nextToken() or other iteration methods)
      Throws:
      JacksonException - if there are general I/O or parse issues, including if the text is too large, see StreamReadConstraints.Builder.maxStringLength(int)

    • _getText2

      protected final String _getText2(JsonToken t) throws JacksonException
      Throws:
      JacksonException

    • getString

      public int getString(Writer writer) throws JacksonException
      Description copied from class: JsonParser
      Method to read the textual representation of the current token in chunks and pass it to the given Writer. Functionally same as calling: 
        writer.write(parser.getString());
      but should typically be more efficient as longer content does need to be combined into a single String to return, and write can occur directly from intermediate buffers Jackson uses.

      NOTE: String value will still be buffered (usually using TextBuffer) and will be accessible with other getString() calls (that is, it will not be consumed). So this accessor only avoids construction of String compared to plain JsonParser.getString() method.

      NOTE: In Jackson 2.x this method was called getString(Writer).

      Overrides:
      getString in class ParserMinimalBase
      Parameters:
      writer - Writer to write String value to
      Returns:
      The number of characters written to the Writer
      Throws:
      JacksonIOException - for low-level read issues, or failed write using Writer
      StreamReadException - for decoding problems
      JacksonException

    • getValueAsString

      public String getValueAsString() throws JacksonException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation cannot be converted to a String value (including structured types like Objects and Arrays and null token), default value of null will be returned; no exceptions are thrown.
      Overrides:
      getValueAsString in class ParserMinimalBase
      Returns:
      String value current token is converted to, if possible; null otherwise
      Throws:
      JacksonException

    • getValueAsString

      public String getValueAsString(String defValue) throws JacksonException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation cannot be converted to a String value (including structured types like Objects and Arrays and null token), specified default value will be returned; no exceptions are thrown.
      Overrides:
      getValueAsString in class ParserMinimalBase
      Parameters:
      defValue - Default value to return if conversion to String is not possible
      Returns:
      String value current token is converted to, if possible; def otherwise
      Throws:
      JacksonException

    • getStringCharacters

      public char[] getStringCharacters() throws JacksonException
      Description copied from class: JsonParser
      Method similar to JsonParser.getString(), 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:

      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 JsonParser.getString()) is to avoid construction of a String object (which will make a copy of contents).

      Specified by:
      getStringCharacters in class JsonParser
      Returns:
      Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • getStringLength

      public int getStringLength() throws JacksonException
      Description copied from class: JsonParser
      Accessor used with JsonParser.getStringCharacters(), to know length of String stored in returned buffer.
      Specified by:
      getStringLength in class JsonParser
      Returns:
      Number of characters within buffer returned by JsonParser.getStringCharacters() that are part of textual content of the current token.
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • getStringOffset

      public int getStringOffset() throws JacksonException
      Description copied from class: JsonParser
      Accessor used with JsonParser.getStringCharacters(), to know offset of the first text content character within buffer.
      Specified by:
      getStringOffset in class JsonParser
      Returns:
      Offset of the first character within buffer returned by JsonParser.getStringCharacters() that is part of textual content of the current token.
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • getBinaryValue

      public byte[] getBinaryValue(Base64Variant b64variant) throws JacksonException
      Description copied from class: JsonParser
      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 JsonParser.getString() 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.

      Overrides:
      getBinaryValue in class ParserBase
      Parameters:
      b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).
      Returns:
      Decoded binary data
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • readBinaryValue

      public int readBinaryValue(Base64Variant b64variant, OutputStream out) throws JacksonException
      Description copied from class: JsonParser
      Similar to JsonParser.readBinaryValue(OutputStream) but allows explicitly specifying base64 variant to use.
      Overrides:
      readBinaryValue in class JsonParser
      Parameters:
      b64variant - base64 variant to use
      out - Output stream to use for passing decoded binary data
      Returns:
      Number of bytes that were decoded and written via OutputStream
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • getEmbeddedObject

      public Object getEmbeddedObject() throws JacksonException
      Description copied from class: JsonParser
      Accessor that can be called if (and only if) the current token is JsonToken.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). One exception is access to binary content (whether via base64 encoding or not) which typically is accessible using this method, as well as JsonParser.getBinaryValue().

      Overrides:
      getEmbeddedObject in class ParserMinimalBase
      Returns:
      Embedded value (usually of "native" type supported by format) for the current token, if any; null otherwise
      Throws:
      JacksonException

    • _startArrayScope

      protected final JsonToken _startArrayScope() throws JacksonException
      Throws:
      JacksonException

    • _startObjectScope

      protected final JsonToken _startObjectScope() throws JacksonException
      Throws:
      JacksonException

    • _closeArrayScope

      protected final JsonToken _closeArrayScope() throws JacksonException
      Throws:
      JacksonException

    • _closeObjectScope

      protected final JsonToken _closeObjectScope() throws JacksonException
      Throws:
      JacksonException

    • _findName

      protected final String _findName(int q1, int lastQuadBytes) throws JacksonException
      Throws:
      JacksonException

    • _findName

      protected final String _findName(int q1, int q2, int lastQuadBytes) throws JacksonException
      Throws:
      JacksonException

    • _findName

      protected final String _findName(int q1, int q2, int q3, int lastQuadBytes) throws JacksonException
      Throws:
      JacksonException

    • _addName

      protected final String _addName(int[] quads, int qlen, int lastQuadBytes) throws JacksonException
      Throws:
      JacksonException

    • _padLastQuad

      protected static final int _padLastQuad(int q, int bytes)

    • _eofAsNextToken

      protected final JsonToken _eofAsNextToken() throws JacksonException
      Throws:
      JacksonException

    • _fieldComplete

      protected final JsonToken _fieldComplete(String name) throws JacksonException
      Throws:
      JacksonException

    • _valueComplete

      protected final JsonToken _valueComplete(JsonToken t) throws JacksonException
      Throws:
      JacksonException

    • _valueCompleteInt

      protected final JsonToken _valueCompleteInt(int value, String asText) throws JacksonException
      Throws:
      JacksonException

    • _nonStdToken

      protected final String _nonStdToken(int type)

    • _valueNonStdNumberComplete

      protected final JsonToken _valueNonStdNumberComplete(int type) throws JacksonException
      Throws:
      JacksonException

    • _updateTokenLocation

      protected final void _updateTokenLocation()

    • _reportInvalidChar

      protected void _reportInvalidChar(int c) throws JacksonException
      Throws:
      JacksonException

    • _reportInvalidInitial

      protected void _reportInvalidInitial(int mask) throws JacksonException
      Throws:
      JacksonException

    • _reportInvalidOther

      protected void _reportInvalidOther(int mask, int ptr) throws JacksonException
      Throws:
      JacksonException

    • _reportInvalidOther

      protected void _reportInvalidOther(int mask) throws JacksonException
      Throws:
      JacksonException