Overrides com.fasterxml.jackson.core.JsonParser.canReadTypeId.

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

Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't).

Default implementation returns true; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.

Returns:boolean

True if the format being read supports native Type Ids; false if not

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonParser.canUseSchema.

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

Method that can be used to verify that given schema can be used with this parser (using setSchema).

Parameters

schema:FormatSchema

Schema to check

Returns:boolean

True if this parser can use given schema; false if not

Annotations

@Override

Method for enabling or disabling specified Avro feature (check Feature for list of features)

Overrides com.fasterxml.jackson.core.JsonParser.currentLocation.

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

Method that returns location of the last processed input unit (character or byte) from the input; 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 JsonLocation#NA due to not having access to input location information (when delegating actual decoding work to other library)

Returns:JsonLocation

Location of the last processed input unit (byte or character)

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonParser.currentName.

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

Method that can be called to get the name associated with the current token: for JsonToken#FIELD_NAMEs it will be the same as what getText returns; for field values it will be preceding field name; and for others (array values, root-level values) null.

Returns:String

Name of the current field in the parsing context

Annotations

@Override

Exceptions

IOException:

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

Overrides com.fasterxml.jackson.core.JsonParser.currentTokenLocation.

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

Method that return the starting location of the current (most recently returned) token; that is, the position of the first input unit (character or byte) 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 JsonLocation#NA due to not having access to input location information (when delegating actual decoding work to other library)

Returns:JsonLocation

Starting location of the token parser currently points to

Annotations

@Override

Method for disabling specified Avro feature (check Feature for list of features)

Method for enabling specified Avro feature (check Feature for list of features)

Overrides com.fasterxml.jackson.core.base.ParserBase.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

variant: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.base.ParserBase.getCurrentLocation.

Doc from com.fasterxml.jackson.core.base.ParserBase.getCurrentLocation.

Method that returns location of the last processed character; usually for error reporting purposes

Returns:JsonLocation

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

Location of the last processed input unit (byte or character)

Annotations

@Deprecated

@Override

Overrides com.fasterxml.jackson.core.base.ParserBase.getCurrentName.

Doc from com.fasterxml.jackson.core.base.ParserBase.getCurrentName.

Method that can be called to get the name associated with the current event.

Returns:String

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

Name of the current field in the parsing context

Annotations

@Deprecated

@Override

Exceptions

IOException:

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

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

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

Overrides com.fasterxml.jackson.core.JsonParser.getReadCapabilities.

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

Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly).

Returns:JacksonFeatureSet<StreamReadCapability>

Set of read capabilities for content to read via this parser

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonParser.getSchema.

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

Method for accessing Schema that this parser uses, if any. Default implementation returns null.

Returns:AvroSchema

Schema in use by this parser, if any; null if none

Annotations

@Override

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

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

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.

Returns:String

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

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)

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

writer: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

Overrides com.fasterxml.jackson.core.base.ParserBase.getTokenLocation.

Doc from com.fasterxml.jackson.core.base.ParserBase.getTokenLocation.

Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.

Returns:JsonLocation

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

Starting location of the token parser currently points to

Annotations

@Deprecated

@Override

Overrides com.fasterxml.jackson.core.JsonParser.getTypeId.

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

Method that can be called to check whether current token (one that was just read) has an associated type id, and if so, return it. Note that while typically caller should check with canReadTypeId first, it is not illegal to call this method even if that method returns true; but if so, it will return null. This may be used to simplify calling code.

Default implementation will simply return null.

Returns:Object

Native Type Id associated with the current token, if any; null if none

Annotations

@Override

Exceptions

IOException:

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

Overrides com.fasterxml.jackson.core.base.ParserBase.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

Method for checking whether specified Avro Feature is enabled.

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

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

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.

Returns:JsonToken

Next token from the stream, if any found, or null to indicate end-of-input

Annotations

@Override

Exceptions

IOException:

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

Overrides com.fasterxml.jackson.core.base.ParserBase.overrideCurrentName.

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

Method that can be used to change what is considered to be the current (field) name. May be needed to support non-JSON data formats or unusual binding conventions; not needed for typical processing.

Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.

Parameters

name:String

Name to use as the current name; may be null.

Annotations

@Override

Overrides com.fasterxml.jackson.core.JsonParser.overrideFormatFeatures.

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

Bulk set method for (re)setting states of FormatFeatures, by specifying values (set / clear) along with a mask, to determine which features to change, if any.

Default implementation will simply throw an exception to indicate that the parser implementation does not support any FormatFeatures.

Parameters

values:int

Bit mask of set/clear state for features to change

mask:int

Bit mask of features to change

Returns:JsonParser

This parser, to allow call chaining

Annotations

@Override

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

Overrides com.fasterxml.jackson.core.JsonParser.setSchema.

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

Method to call to make this parser use specified schema. Method must be called before trying to parse any content, right after parser instance has been created. Note that not all parsers support schemas; and those that do usually only accept specific types of schemas: ones defined for data format parser can read.

If parser does not support specified schema, UnsupportedOperationException is thrown.

Parameters

schema:FormatSchema

Schema to use

Annotations

@Override

Overrides com.fasterxml.jackson.core.base.ParserBase.version.

Implements com.fasterxml.jackson.core.Versioned.version.

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

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

Returns:Version

Version of this generator (derived from version declared for jackson-core jar that contains the class

Annotations

@Override