Class JsonParser
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Versioned
- Direct Known Subclasses:
JsonParserDelegate
,JsonParserMinimalBase
JsonFactory
instance.- Author:
- Tatu Saloranta
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Enumeration that defines all togglable features for parsers.static enum
Enumeration of possible "native" (optimal) types that can be used for numbers. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected JsonToken
Last token retrieved vianextToken()
, if any.protected int
Bit flag composed of bits that indicate whichJsonParser.Feature
s are enabled.protected JsonToken
Last cleared token, if any: that is, value that was in effect whenclearCurrentToken()
was called. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected JsonParseException
_constructError
(String msg) Helper method for constructingJsonParseException
s based on current state of the parserboolean
canUseSchema
(FormatSchema schema) Method that can be used to verify that given schema can be used with this parser (usingsetSchema(org.codehaus.jackson.FormatSchema)
).void
Method called to "consume" the current token by effectively removing it so thathasCurrentToken()
returns false, andgetCurrentToken()
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 featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled.configure
(JsonParser.Feature f, boolean state) Method for enabling or disabling specified feature (checkJsonParser.Feature
for list of features)Method for disabling specified feature (checkJsonParser.Feature
for list of features)void
Deprecated.Method for enabling specified parser feature (checkJsonParser.Feature
for list of features)void
Deprecated.Useenable(Feature)
insteadabstract BigInteger
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[]
Convenience alternative togetBinaryValue(Base64Variant)
that defaults to usingBase64Variants.getDefaultVariant()
as the default encoding.abstract 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
Convenience accessor that can be called when the current token isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
.byte
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.abstract ObjectCodec
getCodec()
Accessor forObjectCodec
associated with this parser, if any.abstract JsonLocation
Method that returns location of the last processed character; usually for error reporting purposes.abstract String
Method that can be called to get the name associated with the current token: forJsonToken.FIELD_NAME
s it will be the same as whatgetText()
returns; for field values it will be preceding field name; and for others (array values, root-level values) null.Accessor to find which token parser currently points to, if any; null will be returned if none.abstract BigDecimal
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
orJsonToken.VALUE_NUMBER_INT
.abstract double
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.Accessor that can be called if (and only if) the current token isJsonToken.VALUE_EMBEDDED_OBJECT
.abstract float
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.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.abstract int
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.Method that can be called to get the last token that was cleared usingclearCurrentToken()
.abstract long
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.abstract JsonParser.NumberType
If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.abstract Number
Generic number value accessor method that will work for all kinds of numeric values.abstract JsonStreamContext
Method that can be used to access current parsing context reader is in.short
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.abstract String
getText()
Method for accessing textual representation of the current token; if no current token (before first call tonextToken()
, or after encountering end-of-input), returns null.abstract char[]
Method similar togetText()
, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.abstract int
Accessor used withgetTextCharacters()
, to know length of String stored in returned buffer.abstract int
Accessor used withgetTextCharacters()
, to know offset of the first text content character within buffer.abstract JsonLocation
Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.boolean
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
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
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
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.boolean
Method for checking whether parser currently points to a token (and data for that token is available).boolean
Method that can be used to determine whether calling ofgetTextCharacters()
would be the most efficient way to access textual content for the event parser currently points to.abstract boolean
isClosed()
Method that can be called to determine whether this parser is closed or not.boolean
Method for checking whether specifiedJsonParser.Feature
is enabled.boolean
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.final boolean
Deprecated.UseisEnabled(Feature)
insteadMethod that fetches next token (as if callingnextToken()
) and if it isJsonToken.VALUE_TRUE
orJsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null.boolean
Method that fetches next token (as if callingnextToken()
) and verifies whether it isJsonToken.FIELD_NAME
with specified name and returns result of that comparison.int
nextIntValue
(int defaultValue) Method that fetches next token (as if callingnextToken()
) and if it isJsonToken.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 callingnextToken()
) and if it isJsonToken.VALUE_NUMBER_INT
returns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:Method that fetches next token (as if callingnextToken()
) and if it isJsonToken.VALUE_STRING
returns contained String value; otherwise returns null.abstract JsonToken
Main iteration method, which will advance stream enough to determine type of the next token, if any.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).<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 (likeBoolean
).<T> T
readValueAs
(TypeReference<?> valueTypeRef) Method to deserialize JSON content into a Java type, reference to which is passed as argument.Method to deserialize JSON content into equivalent "tree model", represented by rootJsonNode
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<?> valueTypeRef) Method for reading sequence of Objects from parser stream, all with same specified value type.int
Method that can be called to push back any content that has been read but not consumed by the parser.int
Method that can be called to push back any content that has been read but not consumed by the parser.abstract void
Setter that allows definingObjectCodec
associated with this parser, if any.void
setFeature
(JsonParser.Feature f, boolean state) Deprecated.void
setSchema
(FormatSchema schema) Method to call to make this parser use specified schema.abstract 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
.version()
Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (seeVersion
for details).
-
Field Details
-
_features
protected int _featuresBit flag composed of bits that indicate whichJsonParser.Feature
s are enabled. -
_currToken
Last token retrieved vianextToken()
, if any. Null before the first call tonextToken()
, as well as if token has been explicitly cleared (by call toclearCurrentToken()
) -
_lastClearedToken
Last cleared token, if any: that is, value that was in effect whenclearCurrentToken()
was called.
-
-
Constructor Details
-
JsonParser
protected JsonParser() -
JsonParser
protected JsonParser(int features)
-
-
Method Details
-
getCodec
Accessor forObjectCodec
associated with this parser, if any. Codec is used byreadValueAs(Class)
method (and its variants).- Since:
- 1.3
-
setCodec
Setter that allows definingObjectCodec
associated with this parser, if any. Codec is used byreadValueAs(Class)
method (and its variants).- Since:
- 1.3
-
setSchema
Method to call to make this parser use specified schema. Method must be called before trying to parse any content, right after parser instance has been created. Note that not all parsers support schemas; and those that do usually only accept specific types of schemas: ones defined for data format parser can read.If parser does not support specified schema,
UnsupportedOperationException
is thrown.- Parameters:
schema
- Schema to use- Throws:
UnsupportedOperationException
- if parser does not support schema- Since:
- 1.8
-
canUseSchema
Method that can be used to verify that given schema can be used with this parser (usingsetSchema(org.codehaus.jackson.FormatSchema)
).- Parameters:
schema
- Schema to check- Returns:
- True if this parser can use given schema; false if not
- Since:
- 1.8
-
version
Description copied from interface:Versioned
Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (seeVersion
for details). -
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. 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.
- Since:
- 1.8
-
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. 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 interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
releaseBuffered
Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given stream if possible; if underlying input is byte-based it can released, if not (char-based) it can not.- Returns:
- -1 if the underlying content source is not byte based
(that is, input can not be sent to
OutputStream
; otherwise number of bytes released (0 if there was nothing to release) - Throws:
IOException
- if write to stream threw exception- Since:
- 1.6
-
releaseBuffered
Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given writer if possible; if underlying input is char-based it can released, if not (byte-based) it can not.- Returns:
- -1 if the underlying content source is not char-based
(that is, input can not be sent to
Writer
; otherwise number of chars released (0 if there was nothing to release) - Throws:
IOException
- if write using Writer threw exception- Since:
- 1.6
-
enable
Method for enabling specified parser feature (checkJsonParser.Feature
for list of features)- Since:
- 1.2
-
disable
Method for disabling specified feature (checkJsonParser.Feature
for list of features)- Since:
- 1.2
-
configure
Method for enabling or disabling specified feature (checkJsonParser.Feature
for list of features)- Since:
- 1.2
-
isEnabled
Method for checking whether specifiedJsonParser.Feature
is enabled.- Since:
- 1.2
-
setFeature
Deprecated. -
enableFeature
Deprecated.Useenable(Feature)
instead -
disableFeature
Deprecated.Usedisable(Feature)
instead -
isFeatureEnabled
Deprecated.UseisEnabled(Feature)
instead -
nextToken
Main iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
IOException
JsonParseException
-
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). 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 callinggetCurrentName()
when parser points to the value.- 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:
IOException
JsonParseException
-
nextFieldName
Method that fetches next token (as if callingnextToken()
) and verifies whether it isJsonToken.FIELD_NAME
with specified name and returns result of that comparison. It is functionally equivalent to:return (nextToken() == JsonToken.FIELD_NAME) invalid input: '&'invalid input: '&' 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.- Parameters:
str
- Property name to compare next token to (if next token isJsonToken.FIELD_NAME
)
- Throws:
IOException
JsonParseException
- Since:
- 1.9
-
nextTextValue
Method that fetches next token (as if callingnextToken()
) and if it isJsonToken.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.- Throws:
IOException
JsonParseException
- Since:
- 1.9
-
nextIntValue
Method that fetches next token (as if callingnextToken()
) and if it isJsonToken.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 a String value next from input.- Throws:
IOException
JsonParseException
- Since:
- 1.9
-
nextLongValue
Method that fetches next token (as if callingnextToken()
) and if it isJsonToken.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 String value next from input.- Throws:
IOException
JsonParseException
- Since:
- 1.9
-
nextBooleanValue
Method that fetches next token (as if callingnextToken()
) and if it isJsonToken.VALUE_TRUE
orJsonToken.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 String value next from input.- Throws:
IOException
JsonParseException
- Since:
- 1.9
-
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
. 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 callnextToken()
to point to the next available token, if any.- Throws:
IOException
JsonParseException
-
isClosed
public abstract boolean isClosed()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 callingnextToken()
(and the underlying stream may be closed). Closing may be due to an explicit call toclose()
or because parser has encountered end of input. -
getCurrentToken
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.- 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.
-
hasCurrentToken
public boolean hasCurrentToken()Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check forparser.getCurrentToken() != null
.- Returns:
- True if the parser just returned a valid
token via
nextToken()
; false otherwise (parser was just constructed, encountered end-of-input and returned null fromnextToken()
, or the token has been consumed)
-
clearCurrentToken
public void clearCurrentToken()Method called to "consume" the current token by effectively removing it so thathasCurrentToken()
returns false, andgetCurrentToken()
null). Cleared token value can still be accessed by callinggetLastClearedToken()
(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).
-
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 whatgetText()
returns; for field values it will be preceding field name; and for others (array values, root-level values) null.- Throws:
IOException
JsonParseException
-
getParsingContext
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. -
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. -
getCurrentLocation
Method that returns location of the last processed character; usually for error reporting purposes. -
getLastClearedToken
Method that can be called to get the last token that was cleared usingclearCurrentToken()
. This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed. -
isExpectedStartArrayToken
public 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. For some specialized parsers this can return true for other cases as well; this is usually done to emulate arrays.Default implementation is equivalent to:
getCurrentToken() == JsonToken.START_ARRAY
but may be overridden by custom parser implementations.- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_ARRAY
); false if not. - Since:
- 1.7
-
getText
Method for accessing textual representation of the current token; if no current token (before first call tonextToken()
, or after encountering end-of-input), returns null. Method can be called for any token type.- Throws:
IOException
JsonParseException
-
getTextCharacters
Method similar togetText()
, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:- Textual contents are not guaranteed to start at
index 0 (rather, call
getTextOffset()
) to know the actual offset - Length of textual contents may be less than the
length of returned buffer: call
getTextLength()
for actual length of returned content.
Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.
The only reason to call this method (over
getText()
) is to avoid construction of a String object (which will make a copy of contents).- Throws:
IOException
JsonParseException
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
Accessor used withgetTextCharacters()
, to know length of String stored in returned buffer.- Returns:
- Number of characters within buffer returned
by
getTextCharacters()
that are part of textual content of the current token. - Throws:
IOException
JsonParseException
-
getTextOffset
Accessor used withgetTextCharacters()
, to know offset of the first text content character within buffer.- Returns:
- Offset of the first character within buffer returned
by
getTextCharacters()
that is part of textual content of the current token. - Throws:
IOException
JsonParseException
-
hasTextCharacters
public boolean hasTextCharacters()Method that can be used to determine whether calling ofgetTextCharacters()
would be the most efficient way to access textual content for the event parser currently points to.Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.
- Returns:
- True if parser currently has character array that can
be efficiently returned via
getTextCharacters()
; false means that it may or may not exist - Since:
- 1.6
-
getNumberValue
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.- Throws:
IOException
JsonParseException
-
getNumberType
If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.- Throws:
IOException
JsonParseException
-
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. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callinggetDoubleValue()
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.- Throws:
IOException
JsonParseException
-
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. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callinggetDoubleValue()
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.- Throws:
IOException
JsonParseException
-
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. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callinggetDoubleValue()
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.- Throws:
IOException
JsonParseException
-
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. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callinggetDoubleValue()
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.- Throws:
IOException
JsonParseException
-
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. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callinggetDecimalValue()
and then constructing aBigInteger
from that value.- Throws:
IOException
JsonParseException
-
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. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callinggetLongValue()
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.- Throws:
IOException
JsonParseException
-
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. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callinggetLongValue()
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.- Throws:
IOException
JsonParseException
-
getDecimalValue
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.- Throws:
IOException
JsonParseException
-
getBooleanValue
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.- Throws:
IOException
JsonParseException
- Since:
- 1.3
-
getEmbeddedObject
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).
- Throws:
IOException
JsonParseException
- Since:
- 1.3
-
getBinaryValue
public abstract byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException 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 viagetText()
and decoding result (except for decoding part), but should be significantly more performant.Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.
- Parameters:
b64variant
- Expected variant of base64 encoded content (seeBase64Variants
for definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
IOException
JsonParseException
-
getBinaryValue
Convenience alternative togetBinaryValue(Base64Variant)
that defaults to usingBase64Variants.getDefaultVariant()
as the default encoding.- Throws:
IOException
JsonParseException
-
getValueAsInt
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.
- Throws:
IOException
JsonParseException
- Since:
- 1.6
-
getValueAsInt
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 defaultValue will be returned; no exceptions are thrown.
- Throws:
IOException
JsonParseException
- Since:
- 1.6
-
getValueAsLong
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 an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
- Throws:
IOException
JsonParseException
- Since:
- 1.6
-
getValueAsLong
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 an int (including structured type markers like start/end Object/Array) specified defaultValue will be returned; no exceptions are thrown.
- Throws:
IOException
JsonParseException
- Since:
- 1.6
-
getValueAsDouble
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 integer parsing rules.If representation can not be converted to an int (including structured types like Objects and Arrays), default value of 0.0 will be returned; no exceptions are thrown.
- Throws:
IOException
JsonParseException
- Since:
- 1.6
-
getValueAsDouble
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 integer parsing rules.If representation can not be converted to an int (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.
- Throws:
IOException
JsonParseException
- Since:
- 1.6
-
getValueAsBoolean
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.
- Throws:
IOException
JsonParseException
- Since:
- 1.7
-
getValueAsBoolean
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 defaultValue will be returned; no exceptions are thrown.
- Throws:
IOException
JsonParseException
- Since:
- 1.7
-
readValueAs
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 (likeBoolean
). Note: method can only be called if the parser has an object codec assigned; this is true for parsers constructed byMappingJsonFactory
but not forJsonFactory
(unless itssetCodec
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
orMap
. The reason is that due to type erasure, key and value types can not be introspected when using this method.- Throws:
IOException
JsonProcessingException
-
readValueAs
Method to deserialize JSON content into a Java type, reference to which is passed as argument. Type is passed using so-called "super type token" and specifically needs to be used if the root type is a parameterized (generic) container type. Note: method can only be called if the parser has an object codec assigned; this is true for parsers constructed byMappingJsonFactory
but not forJsonFactory
(unless itssetCodec
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.- Throws:
IOException
JsonProcessingException
-
readValuesAs
Method for reading sequence of Objects from parser stream, all with same specified value type.- Throws:
IOException
JsonProcessingException
- Since:
- 1.9
-
readValuesAs
public <T> Iterator<T> readValuesAs(TypeReference<?> valueTypeRef) throws IOException, JsonProcessingException Method for reading sequence of Objects from parser stream, all with same specified value type.- Throws:
IOException
JsonProcessingException
- Since:
- 1.9
-
readValueAsTree
Method to deserialize JSON content into equivalent "tree model", represented by rootJsonNode
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- Throws:
IOException
JsonProcessingException
-
_constructError
Helper method for constructingJsonParseException
s based on current state of the parser
-
disable(Feature)
instead