public abstract class JsonParser extends Object implements Closeable, Versioned
JsonFactory
instance.Modifier and Type | Class and Description |
---|---|
static class |
JsonParser.Feature
Enumeration that defines all on/off features for parsers.
|
static class |
JsonParser.NumberType
Enumeration of possible "native" (optimal) types that can be
used for numbers.
|
Modifier and Type | Field and Description |
---|---|
protected int |
_features
Bit flag composed of bits that indicate which
JsonParser.Feature s
are enabled. |
protected RequestPayload |
_requestPayload
Optional container that holds the request payload which will be displayed on JSON parsing error.
|
protected static JacksonFeatureSet<StreamReadCapability> |
DEFAULT_READ_CAPABILITIES
Default set of
StreamReadCapability ies that may be used as
basis for format-specific readers (or as bogus instance if non-null
set needs to be passed). |
Modifier | Constructor and Description |
---|---|
protected |
JsonParser() |
protected |
JsonParser(int features) |
Modifier and Type | Method and Description |
---|---|
protected ObjectCodec |
_codec() |
protected JsonParseException |
_constructError(String msg)
Helper method for constructing
JsonParseException s
based on current state of the parser |
protected void |
_reportUnsupportedOperation()
Helper method to call for operations that are not supported by
parser implementation.
|
boolean |
canParseAsync()
Method that can be called to determine if this parser instance
uses non-blocking ("asynchronous") input access for decoding or not.
|
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 (using
setSchema(com.fasterxml.jackson.core.FormatSchema) ). |
abstract void |
clearCurrentToken()
Method called to "consume" the current token by effectively
removing it so that
hasCurrentToken() returns false, and
getCurrentToken() null). |
abstract 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 feature
JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled. |
JsonParser |
configure(JsonParser.Feature f,
boolean state)
Method for enabling or disabling specified feature
(check
JsonParser.Feature for list of features) |
String |
currentName()
Method that can be called to get the name associated with
the current token: for
JsonToken.FIELD_NAME s 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. |
JsonToken |
currentToken()
Accessor to find which token parser currently points to, if any;
null will be returned if none.
|
int |
currentTokenId()
|
JsonParser |
disable(JsonParser.Feature f)
Method for disabling specified feature
(check
JsonParser.Feature for list of features) |
JsonParser |
enable(JsonParser.Feature f)
Method for enabling specified parser feature
(check
JsonParser.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.
|
abstract BigInteger |
getBigIntegerValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_INT and
it can not be used as a Java long primitive type due to its
magnitude. |
byte[] |
getBinaryValue()
Convenience alternative to
getBinaryValue(Base64Variant)
that defaults to using
Base64Variants.getDefaultVariant() as the default encoding. |
abstract byte[] |
getBinaryValue(Base64Variant bv)
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 is
JsonToken.VALUE_TRUE or
JsonToken.VALUE_FALSE , to return matching boolean
value. |
byte |
getByteValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_INT and
it can be expressed as a value of Java byte primitive type. |
abstract ObjectCodec |
getCodec()
Accessor for
ObjectCodec associated with this
parser, if any. |
abstract JsonLocation |
getCurrentLocation()
Method that returns location of the last processed character;
usually for error reporting purposes.
|
abstract String |
getCurrentName()
See
currentName() . |
abstract JsonToken |
getCurrentToken()
Alias for
currentToken() , may be deprecated sometime after
Jackson 2.12 (will be removed from 3.0). |
abstract int |
getCurrentTokenId()
Deprecated.
Since 2.12 use
currentTokenId() instead |
Object |
getCurrentValue()
Helper method, usually equivalent to:
getParsingContext().getCurrentValue();
|
abstract BigDecimal |
getDecimalValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT . |
abstract double |
getDoubleValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_FLOAT and
it can be expressed as a Java double primitive type. |
Object |
getEmbeddedObject()
Accessor that can be called if (and only if) the current token
is
JsonToken.VALUE_EMBEDDED_OBJECT . |
int |
getFeatureMask()
Bulk access method for getting state of all standard
JsonParser.Feature s. |
abstract float |
getFloatValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_FLOAT and
it can be expressed as a Java float primitive type. |
int |
getFormatFeatures()
Bulk access method for getting state of all
FormatFeature s, format-specific
on/off configuration settings. |
Object |
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. |
abstract int |
getIntValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_INT and
it can be expressed as a value of Java int primitive type. |
abstract JsonToken |
getLastClearedToken()
Method that can be called to get the last token that was
cleared using
clearCurrentToken() . |
abstract long |
getLongValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_INT and
it can be expressed as a Java long primitive type. |
NonBlockingInputFeeder |
getNonBlockingInputFeeder()
Method that will either return a feeder instance (if parser uses
non-blocking, aka asynchronous access); or
null for
parsers that use blocking I/O. |
abstract JsonParser.NumberType |
getNumberType()
If current token is of type
JsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT , returns
one of JsonParser.NumberType constants; otherwise returns null. |
abstract Number |
getNumberValue()
Generic number value accessor method that will work for
all kinds of numeric values.
|
Number |
getNumberValueExact()
Method similar to
getNumberValue() with the difference that
for floating-point numbers value returned may be BigDecimal
if the underlying format does not store floating-point numbers using
native representation: for example, textual formats represent numbers
as Strings (which are 10-based), and conversion to Double
is potentially lossy operation. |
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.
|
abstract JsonStreamContext |
getParsingContext()
Method that can be used to access current parsing context reader
is in.
|
JacksonFeatureSet<StreamReadCapability> |
getReadCapabilities()
Accessor for getting metadata on capabilities of this parser, based on
underlying data format being read (directly or indirectly).
|
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 type
JsonToken.VALUE_NUMBER_INT and
it can be expressed as a value of Java short primitive type. |
abstract String |
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. |
int |
getText(Writer writer)
Method to read the textual representation of the current token in chunks and
pass it to the given Writer.
|
abstract char[] |
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. |
abstract int |
getTextLength()
Accessor used with
getTextCharacters() , to know length
of String stored in returned buffer. |
abstract int |
getTextOffset()
Accessor used with
getTextCharacters() , to know offset
of the first text content character within buffer. |
abstract 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.
|
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 def)
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 def)
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
Java
int value. |
int |
getValueAsInt(int def)
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 def)
Method that will try to convert value of current token to a
long.
|
String |
getValueAsString()
Method that will try to convert value of current token to a
String . |
abstract String |
getValueAsString(String def)
Method that will try to convert value of current token to a
String . |
abstract boolean |
hasCurrentToken()
Method for checking whether parser currently points to
a token (and data for that token is available).
|
abstract boolean |
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. |
abstract boolean |
hasToken(JsonToken t)
Method that is functionally equivalent to:
return currentToken() == t
but may be more efficiently implemented. |
abstract boolean |
hasTokenId(int id)
Method that is functionally equivalent to:
return currentTokenId() == id
but may be more efficiently implemented. |
abstract 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 specified
JsonParser.Feature is enabled. |
boolean |
isEnabled(StreamReadFeature f)
Method for checking whether specified
JsonParser.Feature is enabled. |
boolean |
isExpectedNumberIntToken()
Similar to
isExpectedStartArrayToken() , but checks whether stream
currently points to JsonToken.VALUE_NUMBER_INT . |
boolean |
isExpectedStartArrayToken()
Specialized accessor that can be used to verify that the current
token indicates start array (usually meaning that current token
is
JsonToken.START_ARRAY ) when start array is expected. |
boolean |
isExpectedStartObjectToken()
Similar to
isExpectedStartArrayToken() , but checks whether stream
currently points to JsonToken.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 for
JsonToken.VALUE_NUMBER_FLOAT . |
Boolean |
nextBooleanValue()
Method that fetches next token (as if calling
nextToken() ) and
if it is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null. |
String |
nextFieldName()
Method that fetches next token (as if calling
nextToken() ) and
verifies whether it is JsonToken.FIELD_NAME ; if it is,
returns same as getCurrentName() , otherwise null. |
boolean |
nextFieldName(SerializableString str)
Method that fetches next token (as if calling
nextToken() ) and
verifies whether it is JsonToken.FIELD_NAME with specified name
and returns result of that comparison. |
int |
nextIntValue(int defaultValue)
Method that fetches next token (as if calling
nextToken() ) and
if it is JsonToken.VALUE_NUMBER_INT returns 32-bit int value;
otherwise returns specified default value
It is functionally equivalent to: |
long |
nextLongValue(long defaultValue)
Method that fetches next token (as if calling
nextToken() ) and
if it is JsonToken.VALUE_NUMBER_INT returns 64-bit long value;
otherwise returns specified default value
It is functionally equivalent to: |
String |
nextTextValue()
Method that fetches next token (as if calling
nextToken() ) and
if it is JsonToken.VALUE_STRING returns contained String value;
otherwise returns null. |
abstract JsonToken |
nextToken()
Main iteration method, which will advance stream enough
to determine type of the next token, if any.
|
abstract 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).
|
abstract void |
overrideCurrentName(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 of
FormatFeature 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 by
mask . |
int |
readBinaryValue(Base64Variant bv,
OutputStream out)
Similar to
readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use. |
int |
readBinaryValue(OutputStream out)
Method that can be used as an alternative to
getBigIntegerValue() ,
especially when value can be large. |
<T> T |
readValueAs(Class<T> valueType)
Method to deserialize JSON content into a non-container
type (it can be an array type, however): typically a bean, array
or a wrapper type (like
Boolean ). |
<T> T |
readValueAs(TypeReference<?> valueTypeRef)
Method to deserialize JSON content into a Java type, reference
to which is passed as argument.
|
<T extends TreeNode> |
readValueAsTree()
Method to deserialize JSON content into equivalent "tree model",
represented by root
TreeNode of resulting model. |
<T> Iterator<T> |
readValuesAs(Class<T> valueType)
Method for reading sequence of Objects from parser stream,
all with same specified value type.
|
<T> Iterator<T> |
readValuesAs(TypeReference<T> valueTypeRef)
Method for reading sequence of Objects from parser stream,
all with same specified value type.
|
int |
releaseBuffered(OutputStream out)
Method that can be called to push back any content that
has been read but not consumed by the parser.
|
int |
releaseBuffered(Writer w)
Method that can be called to push back any content that
has been read but not consumed by the parser.
|
boolean |
requiresCustomCodec()
Method that can be called to determine if a custom
ObjectCodec is needed for binding data parsed
using JsonParser constructed by this factory
(which typically also implies the same for serialization
with JsonGenerator ). |
abstract void |
setCodec(ObjectCodec oc)
Setter that allows defining
ObjectCodec associated with this
parser, if any. |
void |
setCurrentValue(Object v)
Helper method, usually equivalent to:
getParsingContext().setCurrentValue(v);
|
JsonParser |
setFeatureMask(int mask)
Deprecated.
Since 2.7, use
overrideStdFeatures(int, int) instead |
void |
setRequestPayloadOnError(byte[] payload,
String charset)
Sets the byte[] request payload and the charset
|
void |
setRequestPayloadOnError(RequestPayload payload)
Sets the payload to be passed if
JsonParseException is thrown. |
void |
setRequestPayloadOnError(String payload)
Sets the String request payload
|
void |
setSchema(FormatSchema schema)
Method to call to make this parser use specified schema.
|
abstract JsonParser |
skipChildren()
Method that will skip all child tokens of an array or
object token that the parser currently points to,
iff stream points to
JsonToken.START_OBJECT or JsonToken.START_ARRAY . |
abstract Version |
version()
Accessor for getting version of the core package, given a parser instance.
|
protected static final JacksonFeatureSet<StreamReadCapability> DEFAULT_READ_CAPABILITIES
StreamReadCapability
ies that may be used as
basis for format-specific readers (or as bogus instance if non-null
set needs to be passed).protected int _features
JsonParser.Feature
s
are enabled.protected transient RequestPayload _requestPayload
public abstract ObjectCodec getCodec()
ObjectCodec
associated with this
parser, if any. Codec is used by readValueAs(Class)
method (and its variants).null
if nonepublic abstract void setCodec(ObjectCodec oc)
ObjectCodec
associated with this
parser, if any. Codec is used by readValueAs(Class)
method (and its variants).oc
- Codec to assign, if any; null
if nonepublic Object getInputSource()
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.
public Object getCurrentValue()
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.
public void setCurrentValue(Object v)
getParsingContext().setCurrentValue(v);
v
- Current value to assign for the current input context of this parserpublic void setRequestPayloadOnError(RequestPayload payload)
JsonParseException
is thrown.payload
- Payload to passpublic void setRequestPayloadOnError(byte[] payload, String charset)
payload
- Payload to passcharset
- Character encoding for (lazily) decoding payloadpublic void setRequestPayloadOnError(String payload)
payload
- Payload to passpublic void setSchema(FormatSchema schema)
If parser does not support specified schema, UnsupportedOperationException
is thrown.
schema
- Schema to useUnsupportedOperationException
- if parser does not support schemapublic FormatSchema getSchema()
null
if nonepublic boolean canUseSchema(FormatSchema schema)
setSchema(com.fasterxml.jackson.core.FormatSchema)
).schema
- Schema to checkpublic boolean requiresCustomCodec()
ObjectCodec
is needed for binding data parsed
using JsonParser
constructed by this factory
(which typically also implies the same for serialization
with JsonGenerator
).ObjectCodec
is enoughpublic boolean canParseAsync()
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
public NonBlockingInputFeeder getNonBlockingInputFeeder()
null
for
parsers that use blocking I/O.public JacksonFeatureSet<StreamReadCapability> getReadCapabilities()
public abstract Version version()
public abstract void close() throws IOException
JsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled.
Whether parser owns the input source depends on factory
method that was used to construct instance (so check
JsonFactory
for details,
but the general
idea is that if caller passes in closable resource (such
as InputStream
or Reader
) parser does NOT
own the source; but if it passes a reference (such as
File
or URL
and creates
stream or reader it does own them.close
in interface Closeable
close
in interface AutoCloseable
IOException
- if there is either an underlying I/O problempublic abstract boolean isClosed()
nextToken()
(and the underlying
stream may be closed). Closing may be due to an explicit
call to close()
or because parser has encountered
end of input.True
if this parser instance has been closedpublic abstract JsonStreamContext getParsingContext()
JsonStreamContext
) associated with this parserpublic abstract JsonLocation getTokenLocation()
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)
public abstract JsonLocation getCurrentLocation()
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)
public int releaseBuffered(OutputStream out) throws IOException
out
- OutputStream to which buffered, undecoded content is written toOutputStream
;
otherwise number of bytes released (0 if there was nothing to release)IOException
- if write to stream threw exceptionpublic int releaseBuffered(Writer w) throws IOException
w
- Writer to which buffered but unprocessed content is written toWriter
;
otherwise number of chars released (0 if there was nothing to release)IOException
- if write using Writer threw exceptionpublic JsonParser enable(JsonParser.Feature f)
JsonParser.Feature
for list of features)f
- Feature to enablepublic JsonParser disable(JsonParser.Feature f)
JsonParser.Feature
for list of features)f
- Feature to disablepublic JsonParser configure(JsonParser.Feature f, boolean state)
JsonParser.Feature
for list of features)f
- Feature to enable or disablestate
- Whether to enable feature (true
) or disable (false
)public boolean isEnabled(JsonParser.Feature f)
JsonParser.Feature
is enabled.f
- Feature to checkTrue
if feature is enabled; false
otherwisepublic boolean isEnabled(StreamReadFeature f)
JsonParser.Feature
is enabled.f
- Feature to checkTrue
if feature is enabled; false
otherwisepublic int getFeatureMask()
JsonParser.Feature
s.JsonParser.Feature
s.@Deprecated public JsonParser setFeatureMask(int mask)
overrideStdFeatures(int, int)
insteadJsonParser.Feature
smask
- Bit mask that defines set of features to enablepublic JsonParser overrideStdFeatures(int values, int mask)
mask
.
Functionally equivalent to
int oldState = getFeatureMask();
int newState = (oldState & ~mask) | (values & mask);
setFeatureMask(newState);
but preferred as this lets caller more efficiently specify actual changes made.values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic int getFormatFeatures()
FormatFeature
s, format-specific
on/off configuration settings.FormatFeature
s.public JsonParser overrideFormatFeatures(int values, int mask)
FormatFeature
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 parser implementation does not support any FormatFeature
s.
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to changepublic abstract JsonToken nextToken() throws IOException
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract JsonToken nextValue() throws IOException
JsonToken.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 calling getCurrentName()
when parser points to
the value.JsonToken.NOT_AVAILABLE
if no tokens were
available yet)IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean nextFieldName(SerializableString str) throws IOException
nextToken()
) and
verifies whether it is JsonToken.FIELD_NAME
with specified name
and returns result of that comparison.
It is functionally equivalent to:
return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(getCurrentName());but may be faster for parser to verify, and can therefore be used if caller expects to get such a property name from input next.
str
- Property name to compare next token to (if next token is
JsonToken.FIELD_NAME
)True
if parser advanced to JsonToken.FIELD_NAME
with
specified name; false
otherwise (different token or non-matching name)IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic String nextFieldName() throws IOException
nextToken()
) and
verifies whether it is JsonToken.FIELD_NAME
; if it is,
returns same as getCurrentName()
, otherwise null.JsonToken.FIELD_NAME
parser advanced to, if any;
null
if next token is of some other typeIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic String nextTextValue() throws IOException
nextToken()
) and
if it is JsonToken.VALUE_STRING
returns contained String value;
otherwise returns null.
It is functionally equivalent to:
return (nextToken() == JsonToken.VALUE_STRING) ? getText() : null;but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.
JsonToken.VALUE_STRING
token parser advanced
to; or null
if next token is of some other typeIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int nextIntValue(int defaultValue) throws IOException
nextToken()
) and
if it is JsonToken.VALUE_NUMBER_INT
returns 32-bit int value;
otherwise returns specified default value
It is functionally equivalent to:
return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getIntValue() : defaultValue;but may be faster for parser to process, and can therefore be used if caller expects to get an int value next from input.
NOTE: value checks are performed similar to getIntValue()
defaultValue
- Value to return if next token is NOT of type JsonToken.VALUE_NUMBER_INT
int
) value of the JsonToken.VALUE_NUMBER_INT
token parser advanced
to; or defaultValue
if next token is of some other typeIOException
- for low-level read issues, or
JsonParseException
for decoding problemsInputCoercionException
- if integer number does not fit in Java int
public long nextLongValue(long defaultValue) throws IOException
nextToken()
) and
if it is JsonToken.VALUE_NUMBER_INT
returns 64-bit long value;
otherwise returns specified default value
It is functionally equivalent to:
return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getLongValue() : defaultValue;but may be faster for parser to process, and can therefore be used if caller expects to get a long value next from input.
NOTE: value checks are performed similar to getLongValue()
defaultValue
- Value to return if next token is NOT of type JsonToken.VALUE_NUMBER_INT
long
value of the JsonToken.VALUE_NUMBER_INT
token parser advanced
to; or defaultValue
if next token is of some other typeIOException
- for low-level read issues, or
JsonParseException
for decoding problemsInputCoercionException
- if integer number does not fit in Java long
public Boolean nextBooleanValue() throws IOException
nextToken()
) and
if it is JsonToken.VALUE_TRUE
or JsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null.
It is functionally equivalent to:
JsonToken t = nextToken(); if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE; if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE; return null;but may be faster for parser to process, and can therefore be used if caller expects to get a Boolean value next from input.
Boolean
value of the JsonToken.VALUE_TRUE
or JsonToken.VALUE_FALSE
token parser advanced to; or null
if next token is of some other typeIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract JsonParser skipChildren() throws IOException
JsonToken.START_OBJECT
or JsonToken.START_ARRAY
.
If not, it will do nothing.
After skipping, stream will point to matching
JsonToken.END_OBJECT
or JsonToken.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 call nextToken()
to point to the next
available token, if any.IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic void finishToken() throws IOException
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.
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic JsonToken currentToken()
public int currentTokenId()
getCurrentToken()
but that returns an
int
instead of JsonToken
(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.
int
matching one of constants from JsonTokenId
.public abstract JsonToken getCurrentToken()
currentToken()
, may be deprecated sometime after
Jackson 2.12 (will be removed from 3.0).@Deprecated public abstract int getCurrentTokenId()
currentTokenId()
insteadcurrentTokenId()
.int
matching one of constants from JsonTokenId
.public abstract boolean hasCurrentToken()
parser.getCurrentToken() != null
.nextToken()
; false otherwise (parser
was just constructed, encountered end-of-input
and returned null from nextToken()
, or the token
has been consumed)public abstract boolean hasTokenId(int id)
return currentTokenId() == id
but may be more efficiently implemented.
Note that no traversal or conversion is performed; so in some
cases calling method like isExpectedStartArrayToken()
is necessary instead.
id
- Token id to match (from (@link JsonTokenId})True
if the parser current points to specified tokenpublic abstract boolean hasToken(JsonToken t)
return currentToken() == t
but may be more efficiently implemented.
Note that no traversal or conversion is performed; so in some
cases calling method like isExpectedStartArrayToken()
is necessary instead.
t
- Token to matchTrue
if the parser current points to specified tokenpublic boolean isExpectedStartArrayToken()
JsonToken.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_ARRAYbut may be overridden by custom parser implementations.
JsonToken.START_ARRAY
);
false
if notpublic boolean isExpectedStartObjectToken()
isExpectedStartArrayToken()
, but checks whether stream
currently points to JsonToken.START_OBJECT
.JsonToken.START_OBJECT
);
false
if notpublic boolean isExpectedNumberIntToken()
isExpectedStartArrayToken()
, but checks whether stream
currently points to JsonToken.VALUE_NUMBER_INT
.
The initial use case is for XML backend to efficiently (attempt to) coerce textual content into numbers.
JsonToken.VALUE_NUMBER_INT
);
false
if notpublic boolean isNaN() throws IOException
JsonToken.VALUE_NUMBER_FLOAT
.
NOTE: roughly equivalent to calling !Double.isFinite()
on value you would get from calling getDoubleValue()
.True
if the current token is of type JsonToken.VALUE_NUMBER_FLOAT
but represents a "Not a Number"; false
for other tokens and regular
floating-point numbersIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract void clearCurrentToken()
hasCurrentToken()
returns false, and
getCurrentToken()
null).
Cleared token value can still be accessed by calling
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).
public abstract JsonToken getLastClearedToken()
clearCurrentToken()
. This is not necessarily
the latest token read.
Will return null if no tokens have been cleared,
or if parser has been closed.null
otherwisepublic abstract void overrideCurrentName(String name)
Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
name
- Name to use as the current name; may be null.public abstract String getCurrentName() throws IOException
currentName()
.IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic String currentName() throws IOException
JsonToken.FIELD_NAME
s 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.IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract String getText() throws IOException
nextToken()
, or
after encountering end-of-input), returns null.
Method can be called for any token type.nextToken()
or other iteration methods)IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getText(Writer writer) throws IOException, UnsupportedOperationException
writer.write(parser.getText());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.writer
- Writer to write textual content toIOException
- for low-level read issues or writes using passed
writer
, or
JsonParseException
for decoding problemsUnsupportedOperationException
public abstract char[] getTextCharacters() throws IOException
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:
getTextOffset()
) to
know the actual offset
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).
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract int getTextLength() throws IOException
getTextCharacters()
, to know length
of String stored in returned buffer.getTextCharacters()
that are part of
textual content of the current token.IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract int getTextOffset() throws IOException
getTextCharacters()
, to know offset
of the first text content character within buffer.getTextCharacters()
that is part of
textual content of the current token.IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract boolean hasTextCharacters()
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.
getTextCharacters()
; false
means that it may or may not existpublic abstract Number getNumberValue() throws IOException
IOException
- Problem with access: JsonParseException
if
the current token is not numeric, or if decoding of the value fails
(invalid format for numbers); plain IOException
if underlying
content read fails (possible if values are extracted lazily)public Number getNumberValueExact() throws IOException
getNumberValue()
with the difference that
for floating-point numbers value returned may be BigDecimal
if the underlying format does not store floating-point numbers using
native representation: for example, textual formats represent numbers
as Strings (which are 10-based), and conversion to Double
is potentially lossy operation.
Default implementation simply returns getNumberValue()
IOException
- Problem with access: JsonParseException
if
the current token is not numeric, or if decoding of the value fails
(invalid format for numbers); plain IOException
if underlying
content read fails (possible if values are extracted lazily)public abstract JsonParser.NumberType getNumberType() throws IOException
JsonToken.VALUE_NUMBER_INT
or
JsonToken.VALUE_NUMBER_FLOAT
, returns
one of JsonParser.NumberType
constants; otherwise returns null.null
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic byte getByteValue() throws IOException
JsonToken.VALUE_NUMBER_INT
and
it can be expressed as a value of Java byte primitive type.
Note that in addition to "natural" input range of [-128, 127]
,
this also allows "unsigned 8-bit byte" values [128, 255]
:
but for this range value will be translated by truncation, leading
to sign change.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT
;
if so, it is equivalent to calling getDoubleValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the resulting integer value falls outside range of
[-128, 255]
,
a InputCoercionException
will be thrown to indicate numeric overflow/underflow.
byte
(if numeric token within
range of [-128, 255]
); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic short getShortValue() throws IOException
JsonToken.VALUE_NUMBER_INT
and
it can be expressed as a value of Java short primitive type.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT
;
if so, it is equivalent to calling getDoubleValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the resulting integer value falls outside range of
Java short, a InputCoercionException
will be thrown to indicate numeric overflow/underflow.
short
(if numeric token within
Java 16-bit signed short
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract int getIntValue() throws IOException
JsonToken.VALUE_NUMBER_INT
and
it can be expressed as a value of Java int primitive type.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT
;
if so, it is equivalent to calling getDoubleValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the resulting integer value falls outside range of
Java int
, a InputCoercionException
may be thrown to indicate numeric overflow/underflow.
int
(if numeric token within
Java 32-bit signed int
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract long getLongValue() throws IOException
JsonToken.VALUE_NUMBER_INT
and
it can be expressed as a Java long primitive type.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT
;
if so, it is equivalent to calling 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 InputCoercionException
may be thrown to indicate numeric overflow/underflow.
long
(if numeric token within
Java 32-bit signed long
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract BigInteger getBigIntegerValue() throws IOException
JsonToken.VALUE_NUMBER_INT
and
it can not be used as a Java long primitive type due to its
magnitude.
It can also be called for JsonToken.VALUE_NUMBER_FLOAT
;
if so, it is equivalent to calling getDecimalValue()
and then constructing a BigInteger
from that value.BigInteger
(if numeric token);
otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract float getFloatValue() throws IOException
JsonToken.VALUE_NUMBER_FLOAT
and
it can be expressed as a Java float primitive type.
It can also be called for JsonToken.VALUE_NUMBER_INT
;
if so, it is equivalent to calling getLongValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the value falls
outside of range of Java float, a InputCoercionException
will be thrown to indicate numeric overflow/underflow.
float
(if numeric token within
Java float
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract double getDoubleValue() throws IOException
JsonToken.VALUE_NUMBER_FLOAT
and
it can be expressed as a Java double primitive type.
It can also be called for JsonToken.VALUE_NUMBER_INT
;
if so, it is equivalent to calling getLongValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the value falls
outside of range of Java double, a InputCoercionException
will be thrown to indicate numeric overflow/underflow.
double
(if numeric token within
Java double
range); otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract BigDecimal getDecimalValue() throws IOException
JsonToken.VALUE_NUMBER_FLOAT
or
JsonToken.VALUE_NUMBER_INT
. No under/overflow exceptions
are ever thrown.BigDecimal
(if numeric token);
otherwise exception thrownIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean getBooleanValue() throws IOException
JsonToken.VALUE_TRUE
or
JsonToken.VALUE_FALSE
, to return matching boolean
value.
If the current token is of some other type, JsonParseException
will be thrownTrue
if current token is JsonToken.VALUE_TRUE
,
false
if current token is JsonToken.VALUE_FALSE
;
otherwise throws JsonParseException
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic Object getEmbeddedObject() throws IOException
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
getBinaryValue()
.
null otherwise
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract byte[] getBinaryValue(Base64Variant bv) throws IOException
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.
bv
- Expected variant of base64 encoded
content (see Base64Variants
for definitions
of "standard" variants).IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic byte[] getBinaryValue() throws IOException
getBinaryValue(Base64Variant)
that defaults to using
Base64Variants.getDefaultVariant()
as the default encoding.IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int readBinaryValue(OutputStream out) throws IOException
getBigIntegerValue()
,
especially when value can be large. The main difference (beyond method
of returning content using OutputStream
instead of as byte array)
is that content will NOT remain accessible after method returns: any content
processed will be consumed and is not buffered in any way. If caller needs
buffering, it has to implement it.out
- Output stream to use for passing decoded binary dataOutputStream
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int readBinaryValue(Base64Variant bv, OutputStream out) throws IOException
readBinaryValue(OutputStream)
but allows explicitly
specifying base64 variant to use.bv
- base64 variant to useout
- Output stream to use for passing decoded binary dataOutputStream
IOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getValueAsInt() throws IOException
int
value.
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.
int
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic int getValueAsInt(int def) throws IOException
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.
def
- Default value to return if conversion to int
is not possibleint
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic long getValueAsLong() throws IOException
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.
long
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic long getValueAsLong(long def) throws IOException
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.
def
- Default value to return if conversion to long
is not possiblelong
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic double getValueAsDouble() throws IOException
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.
double
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic double getValueAsDouble(double def) throws IOException
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.
def
- Default value to return if conversion to double
is not possibledouble
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean getValueAsBoolean() throws IOException
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.
boolean
value current token is converted to, if possible; exception thrown
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean getValueAsBoolean(boolean def) throws IOException
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.
def
- Default value to return if conversion to boolean
is not possibleboolean
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic String getValueAsString() throws IOException
String
.
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.String
value current token is converted to, if possible; null
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic abstract String getValueAsString(String def) throws IOException
String
.
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.def
- Default value to return if conversion to String
is not possibleString
value current token is converted to, if possible; def
otherwiseIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic boolean canReadObjectId()
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.
True
if the format being read supports native Object Ids;
false
if notpublic boolean canReadTypeId()
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.
True
if the format being read supports native Type Ids;
false
if notpublic Object getObjectId() throws IOException
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.
null
if noneIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic Object getTypeId() throws IOException
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.
null
if noneIOException
- for low-level read issues, or
JsonParseException
for decoding problemspublic <T> T readValueAs(Class<T> valueType) throws IOException
Boolean
).
Note: method can only be called if the parser has
an object codec assigned; this is true for parsers constructed
by MappingJsonFactory
(from "jackson-databind" jar)
but not for JsonFactory
(unless its setCodec
method has been explicitly called).
This method may advance the event stream, for structured types
the current token will be the closing end marker (END_ARRAY,
END_OBJECT) of the bound structure. For non-structured Json types
(and for JsonToken.VALUE_EMBEDDED_OBJECT
)
stream is not advanced.
Note: this method should NOT be used if the result type is a
container (Collection
or Map
.
The reason is that due to type erasure, key and value types
can not be introspected when using this method.
T
- Nominal type parameter for value typevalueType
- Java type to read content as (passed to ObjectCodec that
deserializes content)IOException
- if there is either an underlying I/O problem or decoding
issue at format layerpublic <T> T readValueAs(TypeReference<?> valueTypeRef) throws IOException
MappingJsonFactory
(defined in 'jackson-databind' bundle)
but not for JsonFactory
(unless its setCodec
method has been explicitly called).
This method may advance the event stream, for structured types
the current token will be the closing end marker (END_ARRAY,
END_OBJECT) of the bound structure. For non-structured Json types
(and for JsonToken.VALUE_EMBEDDED_OBJECT
)
stream is not advanced.
T
- Nominal type parameter for value typevalueTypeRef
- Java type to read content as (passed to ObjectCodec that
deserializes content)IOException
- if there is either an underlying I/O problem or decoding
issue at format layerpublic <T> Iterator<T> readValuesAs(Class<T> valueType) throws IOException
T
- Nominal type parameter for value typevalueType
- Java type to read content as (passed to ObjectCodec that
deserializes content)IOException
- if there is either an underlying I/O problem or decoding
issue at format layerpublic <T> Iterator<T> readValuesAs(TypeReference<T> valueTypeRef) throws IOException
T
- Nominal type parameter for value typevalueTypeRef
- Java type to read content as (passed to ObjectCodec that
deserializes content)IOException
- if there is either an underlying I/O problem or decoding
issue at format layerpublic <T extends TreeNode> T readValueAsTree() throws IOException
TreeNode
of resulting model.
For JSON Arrays it will an array node (with child nodes),
for objects object node (with child nodes), and for other types
matching leaf node type. Empty or whitespace documents are null.T
- Nominal type parameter for result node type (to reduce need for casting)IOException
- if there is either an underlying I/O problem or decoding
issue at format layerprotected ObjectCodec _codec()
protected JsonParseException _constructError(String msg)
JsonParseException
s
based on current state of the parsermsg
- Base exception message to construct exception withJsonParseException
constructedprotected void _reportUnsupportedOperation()
Copyright © 2021 JBoss by Red Hat. All rights reserved.