Class JsonParserDelegate
- java.lang.Object
-
- com.fasterxml.jackson.core.JsonParser
-
- com.fasterxml.jackson.core.util.JsonParserDelegate
-
- All Implemented Interfaces:
Versioned
,java.io.Closeable
,java.lang.AutoCloseable
- Direct Known Subclasses:
FilteringParserDelegate
,JsonParserSequence
public class JsonParserDelegate extends JsonParser
Helper class that implements delegation pattern forJsonParser
, to allow for simple overridability of basic parsing functionality. The idea is that any functionality to be modified can be simply overridden; and anything else will be delegated by default.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser
JsonParser.Feature, JsonParser.NumberType
-
-
Constructor Summary
Constructors Constructor Description JsonParserDelegate(JsonParser d)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
canReadObjectId()
Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).boolean
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).boolean
canUseSchema(FormatSchema schema)
Method that can be used to verify that given schema can be used with this parser (usingJsonParser.setSchema(com.fasterxml.jackson.core.FormatSchema)
).void
clearCurrentToken()
Method called to "consume" the current token by effectively removing it so thatJsonParser.hasCurrentToken()
returns false, andJsonParser.getCurrentToken()
null).void
close()
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 featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled.JsonToken
currentToken()
Accessor to find which token parser currently points to, if any; null will be returned if none.int
currentTokenId()
Method similar toJsonParser.getCurrentToken()
but that returns anint
instead ofJsonToken
(enum value).JsonParser
delegate()
Accessor for getting the immediateJsonParser
this parser delegates calls to.JsonParser
disable(JsonParser.Feature f)
Method for disabling specified feature (checkJsonParser.Feature
for list of features)JsonParser
enable(JsonParser.Feature f)
Method for enabling specified parser feature (checkJsonParser.Feature
for list of features)void
finishToken()
Method that may be used to force full handling of the current token so that even if lazy processing is enabled, the whole contents are read for possible retrieval.java.math.BigInteger
getBigIntegerValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can not be used as a Java long primitive type due to its magnitude.byte[]
getBinaryValue(Base64Variant b64variant)
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.boolean
getBooleanValue()
Convenience accessor that can be called when the current token isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
.byte
getByteValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java byte primitive type.ObjectCodec
getCodec()
Accessor forObjectCodec
associated with this parser, if any.JsonLocation
getCurrentLocation()
Method that returns location of the last processed character; usually for error reporting purposes.java.lang.String
getCurrentName()
Method that can be called to get the name associated with the current token: forJsonToken.FIELD_NAME
s it will be the same as whatJsonParser.getText()
returns; for field values it will be preceding field name; and for others (array values, root-level values) null.JsonToken
getCurrentToken()
Alias forJsonParser.currentToken()
, will be deprecated in Jackson 2.9int
getCurrentTokenId()
Alias forJsonParser.currentTokenId()
, will be deprecated in Jackson 2.9java.lang.Object
getCurrentValue()
Helper method, usually equivalent to:getParsingContext().getCurrentValue();
java.math.BigDecimal
getDecimalValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
orJsonToken.VALUE_NUMBER_INT
.double
getDoubleValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java double primitive type.java.lang.Object
getEmbeddedObject()
Accessor that can be called if (and only if) the current token isJsonToken.VALUE_EMBEDDED_OBJECT
.int
getFeatureMask()
Bulk access method for getting state of all standardJsonParser.Feature
s.float
getFloatValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java float primitive type.java.lang.Object
getInputSource()
Method that can be used to get access to object that is used to access input being parsed; this is usually eitherInputStream
orReader
, depending on what parser was constructed with.int
getIntValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java int primitive type.JsonToken
getLastClearedToken()
Method that can be called to get the last token that was cleared usingJsonParser.clearCurrentToken()
.long
getLongValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a Java long primitive type.JsonParser.NumberType
getNumberType()
If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.java.lang.Number
getNumberValue()
Generic number value accessor method that will work for all kinds of numeric values.java.lang.Object
getObjectId()
Method that can be called to check whether current token (one that was just read) has an associated Object id, and if so, return it.JsonStreamContext
getParsingContext()
Method that can be used to access current parsing context reader is in.FormatSchema
getSchema()
Method for accessing Schema that this parser uses, if any.short
getShortValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java short primitive type.java.lang.String
getText()
Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken()
, or after encountering end-of-input), returns null.int
getText(java.io.Writer writer)
Method to read the textual representation of the current token in chunks and pass it to the given Writer.char[]
getTextCharacters()
Method similar toJsonParser.getText()
, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.int
getTextLength()
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.int
getTextOffset()
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.JsonLocation
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.java.lang.Object
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.boolean
getValueAsBoolean()
Method that will try to convert value of current token to a boolean.boolean
getValueAsBoolean(boolean defaultValue)
Method that will try to convert value of current token to a boolean.double
getValueAsDouble()
Method that will try to convert value of current token to a Java double.double
getValueAsDouble(double defaultValue)
Method that will try to convert value of current token to a Java double.int
getValueAsInt()
Method that will try to convert value of current token to a int.int
getValueAsInt(int defaultValue)
Method that will try to convert value of current token to a int.long
getValueAsLong()
Method that will try to convert value of current token to a long.long
getValueAsLong(long defaultValue)
Method that will try to convert value of current token to a long.java.lang.String
getValueAsString()
Method that will try to convert value of current token to aString
.java.lang.String
getValueAsString(java.lang.String defaultValue)
Method that will try to convert value of current token to aString
.boolean
hasCurrentToken()
Method for checking whether parser currently points to a token (and data for that token is available).boolean
hasTextCharacters()
Method that can be used to determine whether calling ofJsonParser.getTextCharacters()
would be the most efficient way to access textual content for the event parser currently points to.boolean
hasToken(JsonToken t)
Method that is functionally equivalent to:return currentToken() == t
but may be more efficiently implemented.boolean
hasTokenId(int id)
Method that is functionally equivalent to:return currentTokenId() == id
but may be more efficiently implemented.boolean
isClosed()
Method that can be called to determine whether this parser is closed or not.boolean
isEnabled(JsonParser.Feature f)
Method for checking whether specifiedJsonParser.Feature
is enabled.boolean
isExpectedStartArrayToken()
Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token isJsonToken.START_ARRAY
) when start array is expected.boolean
isExpectedStartObjectToken()
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.START_OBJECT
.boolean
isNaN()
Access for checking whether current token is a numeric value token, but one that is of "not-a-number" (NaN) variety (including both "NaN" AND positive/negative infinity!): not supported by all formats, but often supported forJsonToken.VALUE_NUMBER_FLOAT
.JsonToken
nextToken()
Main iteration method, which will advance stream enough to determine type of the next token, if any.JsonToken
nextValue()
Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers).void
overrideCurrentName(java.lang.String name)
Method that can be used to change what is considered to be the current (field) name.JsonParser
overrideFormatFeatures(int values, int mask)
Bulk set method for (re)setting states ofFormatFeature
s, by specifying values (set / clear) along with a mask, to determine which features to change, if any.JsonParser
overrideStdFeatures(int values, int mask)
Bulk set method for (re)setting states of features specified bymask
.int
readBinaryValue(Base64Variant b64variant, java.io.OutputStream out)
Similar toJsonParser.readBinaryValue(OutputStream)
but allows explicitly specifying base64 variant to use.boolean
requiresCustomCodec()
Method that can be called to determine if a customObjectCodec
is needed for binding data parsed usingJsonParser
constructed by this factory (which typically also implies the same for serialization withJsonGenerator
).void
setCodec(ObjectCodec c)
Setter that allows definingObjectCodec
associated with this parser, if any.void
setCurrentValue(java.lang.Object v)
Helper method, usually equivalent to:getParsingContext().setCurrentValue(v);
JsonParser
setFeatureMask(int mask)
Deprecated.void
setSchema(FormatSchema schema)
Method to call to make this parser use specified schema.JsonParser
skipChildren()
Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points toJsonToken.START_OBJECT
orJsonToken.START_ARRAY
.Version
version()
Accessor for getting version of the core package, given a parser instance.-
Methods inherited from class com.fasterxml.jackson.core.JsonParser
canParseAsync, configure, currentName, getBinaryValue, getFormatFeatures, getNonBlockingInputFeeder, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError
-
-
-
-
Constructor Detail
-
JsonParserDelegate
public JsonParserDelegate(JsonParser d)
-
-
Method Detail
-
getCurrentValue
public java.lang.Object getCurrentValue()
Description copied from class:JsonParser
Helper method, usually equivalent to:getParsingContext().getCurrentValue();
Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.
- Overrides:
getCurrentValue
in classJsonParser
-
setCurrentValue
public void setCurrentValue(java.lang.Object v)
Description copied from class:JsonParser
Helper method, usually equivalent to:getParsingContext().setCurrentValue(v);
- Overrides:
setCurrentValue
in classJsonParser
-
setCodec
public void setCodec(ObjectCodec c)
Description copied from class:JsonParser
Setter that allows definingObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
setCodec
in classJsonParser
-
getCodec
public ObjectCodec getCodec()
Description copied from class:JsonParser
Accessor forObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
getCodec
in classJsonParser
-
enable
public JsonParser enable(JsonParser.Feature f)
Description copied from class:JsonParser
Method for enabling specified parser feature (checkJsonParser.Feature
for list of features)- Overrides:
enable
in classJsonParser
-
disable
public JsonParser disable(JsonParser.Feature f)
Description copied from class:JsonParser
Method for disabling specified feature (checkJsonParser.Feature
for list of features)- Overrides:
disable
in classJsonParser
-
isEnabled
public boolean isEnabled(JsonParser.Feature f)
Description copied from class:JsonParser
Method for checking whether specifiedJsonParser.Feature
is enabled.- Overrides:
isEnabled
in classJsonParser
-
getFeatureMask
public int getFeatureMask()
Description copied from class:JsonParser
Bulk access method for getting state of all standardJsonParser.Feature
s.- Overrides:
getFeatureMask
in classJsonParser
- Returns:
- Bit mask that defines current states of all standard
JsonParser.Feature
s.
-
setFeatureMask
@Deprecated public JsonParser setFeatureMask(int mask)
Deprecated.Description copied from class:JsonParser
Bulk set method for (re)setting states of all standardJsonParser.Feature
s- Overrides:
setFeatureMask
in classJsonParser
- Returns:
- This parser object, to allow chaining of calls
-
overrideStdFeatures
public JsonParser overrideStdFeatures(int values, int mask)
Description copied from class:JsonParser
Bulk set method for (re)setting states of features specified bymask
. Functionally equivalent toint oldState = getFeatureMask(); int newState = (oldState & ~mask) | (values & mask); setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.- Overrides:
overrideStdFeatures
in classJsonParser
- Parameters:
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to change
-
overrideFormatFeatures
public JsonParser overrideFormatFeatures(int values, int mask)
Description copied from class:JsonParser
Bulk set method for (re)setting states ofFormatFeature
s, 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 generator implementation does not support any
FormatFeature
s.- Overrides:
overrideFormatFeatures
in classJsonParser
- Parameters:
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to change
-
getSchema
public FormatSchema getSchema()
Description copied from class:JsonParser
Method for accessing Schema that this parser uses, if any. Default implementation returns null.- Overrides:
getSchema
in classJsonParser
-
setSchema
public void setSchema(FormatSchema schema)
Description copied from class:JsonParser
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.- Overrides:
setSchema
in classJsonParser
- Parameters:
schema
- Schema to use
-
canUseSchema
public boolean canUseSchema(FormatSchema schema)
Description copied from class:JsonParser
Method that can be used to verify that given schema can be used with this parser (usingJsonParser.setSchema(com.fasterxml.jackson.core.FormatSchema)
).- Overrides:
canUseSchema
in classJsonParser
- Parameters:
schema
- Schema to check- Returns:
- True if this parser can use given schema; false if not
-
version
public Version version()
Description copied from class:JsonParser
Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.- Specified by:
version
in interfaceVersioned
- Specified by:
version
in classJsonParser
-
getInputSource
public java.lang.Object getInputSource()
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 eitherInputStream
orReader
, 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.
- Overrides:
getInputSource
in classJsonParser
-
requiresCustomCodec
public boolean requiresCustomCodec()
Description copied from class:JsonParser
Method that can be called to determine if a customObjectCodec
is needed for binding data parsed usingJsonParser
constructed by this factory (which typically also implies the same for serialization withJsonGenerator
).- Overrides:
requiresCustomCodec
in classJsonParser
- Returns:
- True if custom codec is needed with parsers and
generators created by this factory; false if a general
ObjectCodec
is enough
-
close
public void close() throws java.io.IOException
Description copied from class:JsonParser
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 featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so checkJsonFactory
for details, but the general idea is that if caller passes in closable resource (such asInputStream
orReader
) parser does NOT own the source; but if it passes a reference (such asFile
orURL
and creates stream or reader it does own them.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classJsonParser
- Throws:
java.io.IOException
-
isClosed
public boolean isClosed()
Description copied from class:JsonParser
Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by callingJsonParser.nextToken()
(and the underlying stream may be closed). Closing may be due to an explicit call toJsonParser.close()
or because parser has encountered end of input.- Specified by:
isClosed
in classJsonParser
-
currentToken
public JsonToken currentToken()
Description copied from class:JsonParser
Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.- Overrides:
currentToken
in classJsonParser
- Returns:
- Type of the token this parser currently points to, if any: null before any tokens have been read, and after end-of-input has been encountered, as well as if the current token has been explicitly cleared.
-
currentTokenId
public int currentTokenId()
Description copied from class:JsonParser
Method similar toJsonParser.getCurrentToken()
but that returns anint
instead ofJsonToken
(enum value).Use of int directly is typically more efficient on switch statements, so this method may be useful when building low-overhead codecs. Note, however, that effect may not be big enough to matter: make sure to profile performance before deciding to use this method.
- Overrides:
currentTokenId
in classJsonParser
- Returns:
int
matching one of constants fromJsonTokenId
.
-
getCurrentToken
public JsonToken getCurrentToken()
Description copied from class:JsonParser
Alias forJsonParser.currentToken()
, will be deprecated in Jackson 2.9- Specified by:
getCurrentToken
in classJsonParser
-
getCurrentTokenId
public int getCurrentTokenId()
Description copied from class:JsonParser
Alias forJsonParser.currentTokenId()
, will be deprecated in Jackson 2.9- Specified by:
getCurrentTokenId
in classJsonParser
-
hasCurrentToken
public boolean hasCurrentToken()
Description copied from class:JsonParser
Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check forparser.getCurrentToken() != null
.- Specified by:
hasCurrentToken
in classJsonParser
- Returns:
- True if the parser just returned a valid
token via
JsonParser.nextToken()
; false otherwise (parser was just constructed, encountered end-of-input and returned null fromJsonParser.nextToken()
, or the token has been consumed)
-
hasTokenId
public boolean hasTokenId(int id)
Description copied from class:JsonParser
Method that is functionally equivalent to:return currentTokenId() == id
but may be more efficiently implemented.Note that no traversal or conversion is performed; so in some cases calling method like
JsonParser.isExpectedStartArrayToken()
is necessary instead.- Specified by:
hasTokenId
in classJsonParser
-
hasToken
public boolean hasToken(JsonToken t)
Description copied from class:JsonParser
Method that is functionally equivalent to:return currentToken() == t
but may be more efficiently implemented.Note that no traversal or conversion is performed; so in some cases calling method like
JsonParser.isExpectedStartArrayToken()
is necessary instead.- Specified by:
hasToken
in classJsonParser
-
getCurrentName
public java.lang.String getCurrentName() throws java.io.IOException
Description copied from class:JsonParser
Method that can be called to get the name associated with the current token: forJsonToken.FIELD_NAME
s it will be the same as whatJsonParser.getText()
returns; for field values it will be preceding field name; and for others (array values, root-level values) null.- Specified by:
getCurrentName
in classJsonParser
- Throws:
java.io.IOException
-
getCurrentLocation
public JsonLocation getCurrentLocation()
Description copied from class:JsonParser
Method that returns location of the last processed character; usually for error reporting purposes.- Specified by:
getCurrentLocation
in classJsonParser
-
getParsingContext
public JsonStreamContext getParsingContext()
Description copied from class:JsonParser
Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.- Specified by:
getParsingContext
in classJsonParser
-
isExpectedStartArrayToken
public boolean isExpectedStartArrayToken()
Description copied from class:JsonParser
Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token isJsonToken.START_ARRAY
) when start array is expected. For some specialized parsers this can return true for other cases as well; this is usually done to emulate arrays in cases underlying format is ambiguous (XML, for example, has no format-level difference between Objects and Arrays; it just has elements).Default implementation is equivalent to:
currentToken() == JsonToken.START_ARRAY
but may be overridden by custom parser implementations.- Overrides:
isExpectedStartArrayToken
in classJsonParser
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_ARRAY
); false if not.
-
isExpectedStartObjectToken
public boolean isExpectedStartObjectToken()
Description copied from class:JsonParser
Similar toJsonParser.isExpectedStartArrayToken()
, but checks whether stream currently points toJsonToken.START_OBJECT
.- Overrides:
isExpectedStartObjectToken
in classJsonParser
-
isNaN
public boolean isNaN() throws java.io.IOException
Description copied from class:JsonParser
Access for checking whether current token is a numeric value token, but one that is of "not-a-number" (NaN) variety (including both "NaN" AND positive/negative infinity!): not supported by all formats, but often supported forJsonToken.VALUE_NUMBER_FLOAT
. NOTE: roughly equivalent to calling!Double.isFinite()
on value you would get from callingJsonParser.getDoubleValue()
.- Overrides:
isNaN
in classJsonParser
- Throws:
java.io.IOException
-
clearCurrentToken
public void clearCurrentToken()
Description copied from class:JsonParser
Method called to "consume" the current token by effectively removing it so thatJsonParser.hasCurrentToken()
returns false, andJsonParser.getCurrentToken()
null). Cleared token value can still be accessed by callingJsonParser.getLastClearedToken()
(if absolutely needed), but usually isn't.Method was added to be used by the optional data binder, since it has to be able to consume last token used for binding (so that it will not be used again).
- Specified by:
clearCurrentToken
in classJsonParser
-
getLastClearedToken
public JsonToken getLastClearedToken()
Description copied from class:JsonParser
Method that can be called to get the last token that was cleared usingJsonParser.clearCurrentToken()
. This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed.- Specified by:
getLastClearedToken
in classJsonParser
-
overrideCurrentName
public void overrideCurrentName(java.lang.String name)
Description copied from class:JsonParser
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.
- Specified by:
overrideCurrentName
in classJsonParser
- Parameters:
name
- Name to use as the current name; may be null.
-
getText
public java.lang.String getText() throws java.io.IOException
Description copied from class:JsonParser
Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken()
, or after encountering end-of-input), returns null. Method can be called for any token type.- Specified by:
getText
in classJsonParser
- Throws:
java.io.IOException
-
hasTextCharacters
public boolean hasTextCharacters()
Description copied from class:JsonParser
Method that can be used to determine whether calling ofJsonParser.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.
- Specified by:
hasTextCharacters
in classJsonParser
- Returns:
- True if parser currently has character array that can
be efficiently returned via
JsonParser.getTextCharacters()
; false means that it may or may not exist
-
getTextCharacters
public char[] getTextCharacters() throws java.io.IOException
Description copied from class:JsonParser
Method similar toJsonParser.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
JsonParser.getTextOffset()
) to know the actual offset - Length of textual contents may be less than the
length of returned buffer: call
JsonParser.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
JsonParser.getText()
) is to avoid construction of a String object (which will make a copy of contents).- Specified by:
getTextCharacters
in classJsonParser
- Throws:
java.io.IOException
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
public int getTextLength() throws java.io.IOException
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.- Specified by:
getTextLength
in classJsonParser
- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()
that are part of textual content of the current token. - Throws:
java.io.IOException
-
getTextOffset
public int getTextOffset() throws java.io.IOException
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.- Specified by:
getTextOffset
in classJsonParser
- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()
that is part of textual content of the current token. - Throws:
java.io.IOException
-
getText
public int getText(java.io.Writer writer) throws java.io.IOException, java.lang.UnsupportedOperationException
Description copied from class:JsonParser
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());
but should typically be more efficient as longer content does need to be combined into a singleString
to return, and write can occur directly from intermediate buffers Jackson uses.- Overrides:
getText
in classJsonParser
- Returns:
- The number of characters written to the Writer
- Throws:
java.io.IOException
java.lang.UnsupportedOperationException
-
getBigIntegerValue
public java.math.BigInteger getBigIntegerValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can not be used as a Java long primitive type due to its magnitude. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDecimalValue()
and then constructing aBigInteger
from that value.- Specified by:
getBigIntegerValue
in classJsonParser
- Throws:
java.io.IOException
-
getBooleanValue
public boolean getBooleanValue() throws java.io.IOException
Description copied from class:JsonParser
Convenience accessor that can be called when the current token isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
.Note: if the token is not of above-mentioned boolean types, an integer, but its value falls outside of range of Java long, a
JsonParseException
may be thrown to indicate numeric overflow/underflow.- Overrides:
getBooleanValue
in classJsonParser
- Throws:
java.io.IOException
-
getByteValue
public byte getByteValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java byte primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow exception.Note: if the resulting integer value falls outside range of Java byte, a
JsonParseException
will be thrown to indicate numeric overflow/underflow.- Overrides:
getByteValue
in classJsonParser
- Throws:
java.io.IOException
-
getShortValue
public short getShortValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java short primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow exception.Note: if the resulting integer value falls outside range of Java short, a
JsonParseException
will be thrown to indicate numeric overflow/underflow.- Overrides:
getShortValue
in classJsonParser
- Throws:
java.io.IOException
-
getDecimalValue
public java.math.BigDecimal getDecimalValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
orJsonToken.VALUE_NUMBER_INT
. No under/overflow exceptions are ever thrown.- Specified by:
getDecimalValue
in classJsonParser
- Throws:
java.io.IOException
-
getDoubleValue
public double getDoubleValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java double primitive type. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callingJsonParser.getLongValue()
and then casting; except for possible overflow/underflow exception.Note: if the value falls outside of range of Java double, a
JsonParseException
will be thrown to indicate numeric overflow/underflow.- Specified by:
getDoubleValue
in classJsonParser
- Throws:
java.io.IOException
-
getFloatValue
public float getFloatValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java float primitive type. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callingJsonParser.getLongValue()
and then casting; except for possible overflow/underflow exception.Note: if the value falls outside of range of Java float, a
JsonParseException
will be thrown to indicate numeric overflow/underflow.- Specified by:
getFloatValue
in classJsonParser
- Throws:
java.io.IOException
-
getIntValue
public int getIntValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java int primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow exception.Note: if the resulting integer value falls outside range of Java int, a
JsonParseException
may be thrown to indicate numeric overflow/underflow.- Specified by:
getIntValue
in classJsonParser
- Throws:
java.io.IOException
-
getLongValue
public long getLongValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a Java long primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDoubleValue()
and then casting to int; except for possible overflow/underflow exception.Note: if the token is an integer, but its value falls outside of range of Java long, a
JsonParseException
may be thrown to indicate numeric overflow/underflow.- Specified by:
getLongValue
in classJsonParser
- Throws:
java.io.IOException
-
getNumberType
public JsonParser.NumberType getNumberType() throws java.io.IOException
Description copied from class:JsonParser
If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.- Specified by:
getNumberType
in classJsonParser
- Throws:
java.io.IOException
-
getNumberValue
public java.lang.Number getNumberValue() throws java.io.IOException
Description copied from class:JsonParser
Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed.- Specified by:
getNumberValue
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsInt
public int getValueAsInt() throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation can not be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
- Overrides:
getValueAsInt
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsInt
public int getValueAsInt(int defaultValue) throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation can not be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsInt
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsLong
public long getValueAsLong() throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation can not be converted to a long (including structured type markers like start/end Object/Array) default value of 0L will be returned; no exceptions are thrown.
- Overrides:
getValueAsLong
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsLong
public long getValueAsLong(long defaultValue) throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.If representation can not be converted to a long (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsLong
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsDouble
public double getValueAsDouble() throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language floating point parsing rules.If representation can not be converted to a double (including structured types like Objects and Arrays), default value of 0.0 will be returned; no exceptions are thrown.
- Overrides:
getValueAsDouble
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsDouble
public double getValueAsDouble(double defaultValue) throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language floating point parsing rules.If representation can not be converted to a double (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsDouble
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsBoolean
public boolean getValueAsBoolean() throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.If representation can not be converted to a boolean value (including structured types like Objects and Arrays), default value of false will be returned; no exceptions are thrown.
- Overrides:
getValueAsBoolean
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsBoolean
public boolean getValueAsBoolean(boolean defaultValue) throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.If representation can not be converted to a boolean value (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
- Overrides:
getValueAsBoolean
in classJsonParser
- Throws:
java.io.IOException
-
getValueAsString
public java.lang.String getValueAsString() throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to aString
. JSON Strings map naturally; scalar values get converted to their textual representation. If representation can not 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 classJsonParser
- Throws:
java.io.IOException
-
getValueAsString
public java.lang.String getValueAsString(java.lang.String defaultValue) throws java.io.IOException
Description copied from class:JsonParser
Method that will try to convert value of current token to aString
. JSON Strings map naturally; scalar values get converted to their textual representation. If representation can not 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.- Specified by:
getValueAsString
in classJsonParser
- Throws:
java.io.IOException
-
getEmbeddedObject
public java.lang.Object getEmbeddedObject() throws java.io.IOException
Description copied from class:JsonParser
Accessor that can be called if (and only if) the current token isJsonToken.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 classJsonParser
- Throws:
java.io.IOException
-
getBinaryValue
public byte[] getBinaryValue(Base64Variant b64variant) throws java.io.IOException
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 viaJsonParser.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.
- Specified by:
getBinaryValue
in classJsonParser
- Parameters:
b64variant
- Expected variant of base64 encoded content (seeBase64Variants
for definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
java.io.IOException
-
readBinaryValue
public int readBinaryValue(Base64Variant b64variant, java.io.OutputStream out) throws java.io.IOException
Description copied from class:JsonParser
Similar toJsonParser.readBinaryValue(OutputStream)
but allows explicitly specifying base64 variant to use.- Overrides:
readBinaryValue
in classJsonParser
- Parameters:
b64variant
- base64 variant to useout
- Output stream to use for passing decoded binary data- Returns:
- Number of bytes that were decoded and written via
OutputStream
- Throws:
java.io.IOException
-
getTokenLocation
public JsonLocation getTokenLocation()
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.- Specified by:
getTokenLocation
in classJsonParser
-
nextToken
public JsonToken nextToken() throws java.io.IOException
Description copied from class:JsonParser
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.- Specified by:
nextToken
in classJsonParser
- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
java.io.IOException
-
nextValue
public JsonToken nextValue() throws java.io.IOException
Description copied from class:JsonParser
Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers). Or put another way, nextToken() will be called once, and ifJsonToken.FIELD_NAME
is returned, another time to get the value for the field. Method is most useful for iterating over value entries of JSON objects; field name will still be available by callingJsonParser.getCurrentName()
when parser points to the value.- Specified by:
nextValue
in classJsonParser
- Returns:
- Next non-field-name token from the stream, if any found,
or null to indicate end-of-input (or, for non-blocking
parsers,
JsonToken.NOT_AVAILABLE
if no tokens were available yet) - Throws:
java.io.IOException
-
finishToken
public void finishToken() throws java.io.IOException
Description copied from class:JsonParser
Method that may be used to force full handling of the current token so that even if lazy processing is enabled, the whole contents are read for possible retrieval. This is usually used to ensure that the token end location is available, as well as token contents (similar to what calling, sayJsonParser.getTextCharacters()
, would achieve).Note that for many dataformat implementations this method will not do anything; this is the default implementation unless overridden by sub-classes.
- Overrides:
finishToken
in classJsonParser
- Throws:
java.io.IOException
-
skipChildren
public JsonParser skipChildren() throws java.io.IOException
Description copied from class:JsonParser
Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points toJsonToken.START_OBJECT
orJsonToken.START_ARRAY
. If not, it will do nothing. After skipping, stream will point to matchingJsonToken.END_OBJECT
orJsonToken.END_ARRAY
(possibly skipping nested pairs of START/END OBJECT/ARRAY tokens as well as value tokens). The idea is that after calling this method, application will callJsonParser.nextToken()
to point to the next available token, if any.- Specified by:
skipChildren
in classJsonParser
- Throws:
java.io.IOException
-
canReadObjectId
public boolean canReadObjectId()
Description copied from class:JsonParser
Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).Default implementation returns true; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.
- Overrides:
canReadObjectId
in classJsonParser
-
canReadTypeId
public boolean canReadTypeId()
Description copied from class:JsonParser
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.
- Overrides:
canReadTypeId
in classJsonParser
-
getObjectId
public java.lang.Object getObjectId() throws java.io.IOException
Description copied from class:JsonParser
Method that can be called to check whether current token (one that was just read) has an associated Object id, and if so, return it. Note that while typically caller should check withJsonParser.canReadObjectId()
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.
- Overrides:
getObjectId
in classJsonParser
- Throws:
java.io.IOException
-
getTypeId
public java.lang.Object getTypeId() throws java.io.IOException
Description copied from class:JsonParser
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 withJsonParser.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.
- Overrides:
getTypeId
in classJsonParser
- Throws:
java.io.IOException
-
delegate
public JsonParser delegate()
Accessor for getting the immediateJsonParser
this parser delegates calls to.- Since:
- 2.10
-
-