public abstract Class NonBlockingParserBase

Overrides com.fasterxml.jackson.core.JsonParser.canParseAsync.

Doc from com.fasterxml.jackson.core.JsonParser.canParseAsync.

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 (@code true}, it is possible to call getNonBlockingInputFeeder() to obtain object to use for feeding input; otherwise (false returned) input is read by blocking

Returns:boolean

True if this is a non-blocking ("asynchronous") parser

Annotations

@Override

Since

2.9

Implements abstract com.fasterxml.jackson.core.base.ParserMinimalBase.getBinaryValue.

Doc from com.fasterxml.jackson.core.JsonParser.getBinaryValue.

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.

Parameters

b64variant:Base64Variant

Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).

Returns:byte[]

Decoded binary data

Annotations

@Override

Exceptions

IOException:

for low-level read issues, or JsonParseException for decoding problems

Implements abstract com.fasterxml.jackson.core.JsonParser.getCodec.

Doc from com.fasterxml.jackson.core.JsonParser.getCodec.

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

Returns:ObjectCodec

Codec assigned to this parser, if any; null if none

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonParser.getEmbeddedObject.

Doc from com.fasterxml.jackson.core.JsonParser.getEmbeddedObject.

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

Returns:Object

Embedded value (usually of "native" type supported by format) for the current token, if any; null otherwise

Annotations

@Override

Exceptions

IOException:

for low-level read issues, or JsonParseException for decoding problems

Overrides com.fasterxml.jackson.core.JsonParser.getInputSource.

Doc from com.fasterxml.jackson.core.JsonParser.getInputSource.

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.

Returns:Object

Input source this parser was configured with

Annotations

@Override

Implements abstract com.fasterxml.jackson.core.base.ParserMinimalBase.getText.

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

Returns:String

Doc from com.fasterxml.jackson.core.JsonParser.getText.

Textual value associated with the current token (one returned by nextToken() or other iteration methods)

Annotations

@Override

Exceptions

IOException:

Doc from com.fasterxml.jackson.core.JsonParser.getText.

for low-level read issues, or JsonParseException for decoding problems, including if the text is too large, see com.fasterxml.jackson.core.StreamReadConstraints.Builder#maxStringLength(int)

Overrides com.fasterxml.jackson.core.JsonParser.getText.

Doc from com.fasterxml.jackson.core.JsonParser.getText.

Method to read the textual representation of the current token in chunks and pass it to the given Writer. Conceptually same as calling:

  writer.write(parser.getText());

Parameters

w:Writer

Writer to write textual content to

Returns:int

The number of characters written to the Writer

Annotations

@Override

Exceptions

IOException:

for low-level read issues or writes using passed writer, or JsonParseException for decoding problems

Implements abstract com.fasterxml.jackson.core.base.ParserMinimalBase.getTextCharacters.

Doc from com.fasterxml.jackson.core.JsonParser.getTextCharacters.

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).

Returns:char[]

Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)

Annotations

@Override

Exceptions

IOException:

for low-level read issues, or JsonParseException for decoding problems, including if the text is too large, see com.fasterxml.jackson.core.StreamReadConstraints.Builder#maxStringLength(int)

Implements abstract com.fasterxml.jackson.core.base.ParserMinimalBase.getTextLength.

Doc from com.fasterxml.jackson.core.JsonParser.getTextLength.

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

Returns:int

Number of characters within buffer returned by getTextCharacters that are part of textual content of the current token.

Annotations

@Override

Exceptions

IOException:

for low-level read issues, or JsonParseException for decoding problems

Implements abstract com.fasterxml.jackson.core.base.ParserMinimalBase.getTextOffset.

Doc from com.fasterxml.jackson.core.JsonParser.getTextOffset.

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

Returns:int

Offset of the first character within buffer returned by getTextCharacters that is part of textual content of the current token.

Annotations

@Override

Exceptions

IOException:

for low-level read issues, or JsonParseException for decoding problems

Implements abstract com.fasterxml.jackson.core.base.ParserMinimalBase.hasTextCharacters.

Doc from com.fasterxml.jackson.core.JsonParser.hasTextCharacters.

Method that can be used to determine whether calling of getTextCharacters would be the most efficient way to access textual content for the event parser currently points to.

Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.

Returns:boolean

True if parser currently has character array that can be efficiently returned via getTextCharacters; false means that it may or may not exist

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonParser.readBinaryValue.

Doc from com.fasterxml.jackson.core.JsonParser.readBinaryValue.

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

Parameters

b64variant:Base64Variant

base64 variant to use

out:OutputStream

Output stream to use for passing decoded binary data

Returns:int

Number of bytes that were decoded and written via OutputStream

Annotations

@Override

Exceptions

IOException:

for low-level read issues, or JsonParseException for decoding problems

Overrides com.fasterxml.jackson.core.JsonParser.releaseBuffered.

Doc from com.fasterxml.jackson.core.JsonParser.releaseBuffered.

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.

Parameters

out:OutputStream

OutputStream to which buffered, undecoded content is written to

Returns:int

-1 if the underlying content source is not byte based (that is, input can not be sent to OutputStream; otherwise number of bytes released (0 if there was nothing to release)

Annotations

@Override

Exceptions

IOException:

if write to stream threw exception

Implements abstract com.fasterxml.jackson.core.JsonParser.setCodec.

Doc from com.fasterxml.jackson.core.JsonParser.setCodec.

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

Parameters

c:ObjectCodec

Codec to assign, if any; null if none

Annotations

@Override