Class FromXmlParser
- java.lang.Object
-
- com.fasterxml.jackson.core.JsonParser
-
- com.fasterxml.jackson.core.base.ParserMinimalBase
-
- com.fasterxml.jackson.dataformat.xml.deser.FromXmlParser
-
- All Implemented Interfaces:
Versioned
,ElementWrappable
,java.io.Closeable
,java.lang.AutoCloseable
public class FromXmlParser extends ParserMinimalBase implements ElementWrappable
JsonParser
implementation that exposes XML structure as set of JSON events that can be used for data binding.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FromXmlParser.Feature
Enumeration that defines all togglable features for XML parsers.-
Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser
JsonParser.NumberType
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_UNNAMED_TEXT_PROPERTY
The default name placeholder for XML text segments is empty String ("").
-
Constructor Summary
Constructors Constructor Description FromXmlParser(IOContext ctxt, int genericParserFeatures, int xmlFeatures, ObjectCodec codec, javax.xml.stream.XMLStreamReader xmlReader, XmlNameProcessor tagProcessor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addVirtualWrapping(java.util.Set<java.lang.String> namesToWrap0, boolean caseInsensitive)
Method that may be called to indicate that specified names (only local parts retained currently: this may be changed in future) should be considered "auto-wrapping", meaning that they will be doubled to contain two opening elements, two matching closing elements.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).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.FromXmlParser
configure(FromXmlParser.Feature f, boolean state)
FromXmlParser
disable(FromXmlParser.Feature f)
FromXmlParser
enable(FromXmlParser.Feature f)
java.math.BigInteger
getBigIntegerValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can not be used as a Java long primitive type due to its magnitude.byte[]
getBinaryValue(Base64Variant b64variant)
Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value.ObjectCodec
getCodec()
Accessor forObjectCodec
associated with this parser, if any.JsonLocation
getCurrentLocation()
Method that returns location of the last processed character; usually for error reporting purposesjava.lang.String
getCurrentName()
Method that can be called to get the name associated with the current event.java.math.BigDecimal
getDecimalValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
orJsonToken.VALUE_NUMBER_INT
.double
getDoubleValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java double primitive type.java.lang.Object
getEmbeddedObject()
Accessor that can be called if (and only if) the current token isJsonToken.VALUE_EMBEDDED_OBJECT
.float
getFloatValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java float primitive type.int
getFormatFeatures()
Bulk access method for getting state of allFormatFeature
s, format-specific on/off configuration settings.int
getIntValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java int primitive type.long
getLongValue()
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a Java long primitive type.JsonParser.NumberType
getNumberType()
If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.java.lang.Number
getNumberValue()
Generic number value accessor method that will work for all kinds of numeric values.XmlReadContext
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).javax.xml.stream.XMLStreamReader
getStaxReader()
Method that allows application direct access to underlying StaxXMLStreamWriter
.java.lang.String
getText()
Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken()
, or after encountering end-of-input), returns null.int
getText(java.io.Writer writer)
Method to read the textual representation of the current token in chunks and pass it to the given Writer.char[]
getTextCharacters()
Method similar toJsonParser.getText()
, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.int
getTextLength()
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.int
getTextOffset()
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.JsonLocation
getTokenLocation()
Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.boolean
hasTextCharacters()
XML input actually would offer access to character arrays; but since we must coalesce things it cannot really be exposed.boolean
isClosed()
Method that can be called to determine whether this parser is closed or not.boolean
isEnabled(FromXmlParser.Feature f)
boolean
isExpectedNumberIntToken()
Since xml representation can not really distinguish between different scalar types (numbers, booleans) -- they are all just Character Data, without schema -- we can try to infer type from intent here.boolean
isExpectedStartArrayToken()
Since xml representation can not really distinguish between array and object starts (both are represented with elements), this method is overridden and taken to mean that expecation is that the current start element is to mean 'start array', instead of default of 'start object'.boolean
isNaN()
Access for checking whether current token is a numeric value token, but one that is of "not-a-number" (NaN) variety (including both "NaN" AND positive/negative infinity!): not supported by all formats, but often supported forJsonToken.VALUE_NUMBER_FLOAT
.java.lang.String
nextTextValue()
Method overridden to support more reliable deserialization of String collections.JsonToken
nextToken()
Main iteration method, which will advance stream enough to determine type of the next token, if any.void
overrideCurrentName(java.lang.String name)
Method that can be used to change what is considered to be the current (field) name.JsonParser
overrideFormatFeatures(int values, int mask)
Bulk set method for (re)setting states ofFormatFeature
s, by specifying values (set / clear) along with a mask, to determine which features to change, if any.boolean
requiresCustomCodec()
XML format does require support from customObjectCodec
(that is,XmlMapper
), so need to return true here.void
setCodec(ObjectCodec c)
Setter that allows definingObjectCodec
associated with this parser, if any.void
setXMLTextElementName(java.lang.String name)
StreamReadConstraints
streamReadConstraints()
Get the constraints to apply when performing streaming reads.Version
version()
Accessor for getting version of the core package, given a parser instance.-
Methods inherited from class com.fasterxml.jackson.core.base.ParserMinimalBase
clearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsString, getValueAsString, hasCurrentToken, hasToken, hasTokenId, isExpectedStartObjectToken, nextValue, skipChildren
-
Methods inherited from class com.fasterxml.jackson.core.JsonParser
assignCurrentValue, canParseAsync, canUseSchema, configure, currentLocation, currentName, currentTokenLocation, currentValue, disable, enable, finishToken, getBinaryValue, getBooleanValue, getByteValue, getCurrentValue, getFeatureMask, getInputSource, getNonBlockingInputFeeder, getNumberValueDeferred, getNumberValueExact, getObjectId, getSchema, getShortValue, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, overrideStdFeatures, readBinaryValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setCurrentValue, setFeatureMask, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchema
-
-
-
-
Field Detail
-
DEFAULT_UNNAMED_TEXT_PROPERTY
public static final java.lang.String DEFAULT_UNNAMED_TEXT_PROPERTY
The default name placeholder for XML text segments is empty String ("").- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FromXmlParser
public FromXmlParser(IOContext ctxt, int genericParserFeatures, int xmlFeatures, ObjectCodec codec, javax.xml.stream.XMLStreamReader xmlReader, XmlNameProcessor tagProcessor) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
version
public Version version()
Description copied from class:JsonParser
Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.- Specified by:
version
in interfaceVersioned
- Specified by:
version
in classJsonParser
- Returns:
- Version of this generator (derived from version declared for
jackson-core
jar that contains the class
-
getCodec
public ObjectCodec getCodec()
Description copied from class:JsonParser
Accessor forObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
getCodec
in classJsonParser
- Returns:
- Codec assigned to this parser, if any;
null
if none
-
setCodec
public void setCodec(ObjectCodec c)
Description copied from class:JsonParser
Setter that allows definingObjectCodec
associated with this parser, if any. Codec is used byJsonParser.readValueAs(Class)
method (and its variants).- Specified by:
setCodec
in classJsonParser
- Parameters:
c
- Codec to assign, if any;null
if none
-
setXMLTextElementName
public void setXMLTextElementName(java.lang.String name)
- Since:
- 2.1
-
requiresCustomCodec
public boolean requiresCustomCodec()
XML format does require support from customObjectCodec
(that is,XmlMapper
), so need to return true here.- Overrides:
requiresCustomCodec
in classJsonParser
- Returns:
- True since XML format does require support from codec
-
canReadObjectId
public boolean canReadObjectId()
Description copied from class:JsonParser
Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).Default implementation returns true; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native object ids.
- Overrides:
canReadObjectId
in classJsonParser
- Returns:
True
if the format being read supports native Object Ids;false
if not
-
canReadTypeId
public boolean canReadTypeId()
Description copied from class:JsonParser
Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't).Default implementation returns true; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it can not use native type ids.
- Overrides:
canReadTypeId
in classJsonParser
- Returns:
True
if the format being read supports native Type Ids;false
if not
-
getReadCapabilities
public JacksonFeatureSet<StreamReadCapability> getReadCapabilities()
Description copied from class:JsonParser
Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly).- Overrides:
getReadCapabilities
in classJsonParser
- Returns:
- Set of read capabilities for content to read via this parser
-
enable
public FromXmlParser enable(FromXmlParser.Feature f)
-
disable
public FromXmlParser disable(FromXmlParser.Feature f)
-
isEnabled
public final boolean isEnabled(FromXmlParser.Feature f)
-
configure
public FromXmlParser configure(FromXmlParser.Feature f, boolean state)
-
streamReadConstraints
public StreamReadConstraints streamReadConstraints()
Description copied from class:JsonParser
Get the constraints to apply when performing streaming reads.- Overrides:
streamReadConstraints
in classJsonParser
-
getFormatFeatures
public int getFormatFeatures()
Description copied from class:JsonParser
Bulk access method for getting state of allFormatFeature
s, format-specific on/off configuration settings.- Overrides:
getFormatFeatures
in classJsonParser
- Returns:
- Bit mask that defines current states of all standard
FormatFeature
s.
-
overrideFormatFeatures
public JsonParser overrideFormatFeatures(int values, int mask)
Description copied from class:JsonParser
Bulk set method for (re)setting states ofFormatFeature
s, by specifying values (set / clear) along with a mask, to determine which features to change, if any.Default implementation will simply throw an exception to indicate that the parser implementation does not support any
FormatFeature
s.- Overrides:
overrideFormatFeatures
in classJsonParser
- Parameters:
values
- Bit mask of set/clear state for features to changemask
- Bit mask of features to change- Returns:
- This parser, to allow call chaining
-
getStaxReader
public javax.xml.stream.XMLStreamReader getStaxReader()
Method that allows application direct access to underlying StaxXMLStreamWriter
. Note that use of writer is discouraged, and may interfere with processing of this writer; however, occasionally it may be necessary.Note: writer instance will always be of type
XMLStreamWriter2
(including Typed Access API) so upcasts are safe.
-
addVirtualWrapping
public void addVirtualWrapping(java.util.Set<java.lang.String> namesToWrap0, boolean caseInsensitive)
Description copied from interface:ElementWrappable
Method that may be called to indicate that specified names (only local parts retained currently: this may be changed in future) should be considered "auto-wrapping", meaning that they will be doubled to contain two opening elements, two matching closing elements. This is needed for supporting handling of so-called "unwrapped" array types, something XML mappings like JAXB often use.- Specified by:
addVirtualWrapping
in interfaceElementWrappable
-
getCurrentName
public java.lang.String getCurrentName() throws java.io.IOException
Method that can be called to get the name associated with the current event.- Specified by:
getCurrentName
in classParserMinimalBase
- Returns:
- Name of the current field in the parsing context
- Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
overrideCurrentName
public void overrideCurrentName(java.lang.String name)
Description copied from class:JsonParser
Method that can be used to change what is considered to be the current (field) name. May be needed to support non-JSON data formats or unusual binding conventions; not needed for typical processing.Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
- Specified by:
overrideCurrentName
in classParserMinimalBase
- Parameters:
name
- Name to use as the current name; may be null.
-
close
public void close() throws java.io.IOException
Description copied from class:JsonParser
Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or featureJsonParser.Feature.AUTO_CLOSE_SOURCE
is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so checkJsonFactory
for details, but the general idea is that if caller passes in closable resource (such asInputStream
orReader
) parser does NOT own the source; but if it passes a reference (such asFile
orURL
and creates stream or reader it does own them.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classParserMinimalBase
- Throws:
java.io.IOException
- if there is either an underlying I/O problem
-
isClosed
public boolean isClosed()
Description copied from class:JsonParser
Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by callingJsonParser.nextToken()
(and the underlying stream may be closed). Closing may be due to an explicit call toJsonParser.close()
or because parser has encountered end of input.- Specified by:
isClosed
in classParserMinimalBase
- Returns:
True
if this parser instance has been closed
-
getParsingContext
public XmlReadContext getParsingContext()
Description copied from class:JsonParser
Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.- Specified by:
getParsingContext
in classParserMinimalBase
- Returns:
- Stream input context (
JsonStreamContext
) associated with this parser
-
getTokenLocation
public 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.- Specified by:
getTokenLocation
in classJsonParser
- Returns:
- Starting location of the token parser currently points to
-
getCurrentLocation
public JsonLocation getCurrentLocation()
Method that returns location of the last processed character; usually for error reporting purposes- Specified by:
getCurrentLocation
in classJsonParser
- Returns:
- Location of the last processed input unit (byte or character)
-
isExpectedStartArrayToken
public boolean isExpectedStartArrayToken()
Since xml representation can not really distinguish between array and object starts (both are represented with elements), this method is overridden and taken to mean that expecation is that the current start element is to mean 'start array', instead of default of 'start object'.- Overrides:
isExpectedStartArrayToken
in classParserMinimalBase
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.START_ARRAY
);false
if not
-
isExpectedNumberIntToken
public boolean isExpectedNumberIntToken()
Since xml representation can not really distinguish between different scalar types (numbers, booleans) -- they are all just Character Data, without schema -- we can try to infer type from intent here. The main benefit is avoiding checks for coercion.- Overrides:
isExpectedNumberIntToken
in classParserMinimalBase
- Returns:
- True if the current token can be considered as a
start-array marker (such
JsonToken.VALUE_NUMBER_INT
);false
if not
-
nextToken
public JsonToken nextToken() throws java.io.IOException
Description copied from class:JsonParser
Main iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.- Specified by:
nextToken
in classParserMinimalBase
- Returns:
- Next token from the stream, if any found, or null to indicate end-of-input
- Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
nextTextValue
public java.lang.String nextTextValue() throws java.io.IOException
Method overridden to support more reliable deserialization of String collections.- Overrides:
nextTextValue
in classJsonParser
- Returns:
- Text value of the
JsonToken.VALUE_STRING
token parser advanced to; ornull
if next token is of some other type - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getText
public java.lang.String getText() throws java.io.IOException
Description copied from class:JsonParser
Method for accessing textual representation of the current token; if no current token (before first call toJsonParser.nextToken()
, or after encountering end-of-input), returns null. Method can be called for any token type.- Specified by:
getText
in classParserMinimalBase
- Returns:
- Textual value associated with the current token (one returned
by
JsonParser.nextToken()
or other iteration methods) - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems, including if the text is too large, seeStreamReadConstraints.Builder.maxStringLength(int)
-
getTextCharacters
public char[] getTextCharacters() throws java.io.IOException
Description copied from class:JsonParser
Method similar toJsonParser.getText()
, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:- Textual contents are not guaranteed to start at
index 0 (rather, call
JsonParser.getTextOffset()
) to know the actual offset - Length of textual contents may be less than the
length of returned buffer: call
JsonParser.getTextLength()
for actual length of returned content.
Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.
The only reason to call this method (over
JsonParser.getText()
) is to avoid construction of a String object (which will make a copy of contents).- Specified by:
getTextCharacters
in classParserMinimalBase
- Returns:
- Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)
- Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems, including if the text is too large, seeStreamReadConstraints.Builder.maxStringLength(int)
- Textual contents are not guaranteed to start at
index 0 (rather, call
-
getTextLength
public int getTextLength() throws java.io.IOException
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know length of String stored in returned buffer.- Specified by:
getTextLength
in classParserMinimalBase
- Returns:
- Number of characters within buffer returned
by
JsonParser.getTextCharacters()
that are part of textual content of the current token. - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getTextOffset
public int getTextOffset() throws java.io.IOException
Description copied from class:JsonParser
Accessor used withJsonParser.getTextCharacters()
, to know offset of the first text content character within buffer.- Specified by:
getTextOffset
in classParserMinimalBase
- Returns:
- Offset of the first character within buffer returned
by
JsonParser.getTextCharacters()
that is part of textual content of the current token. - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
hasTextCharacters
public boolean hasTextCharacters()
XML input actually would offer access to character arrays; but since we must coalesce things it cannot really be exposed.- Specified by:
hasTextCharacters
in classParserMinimalBase
- Returns:
- True if parser currently has character array that can
be efficiently returned via
JsonParser.getTextCharacters()
; false means that it may or may not exist
-
getText
public int getText(java.io.Writer writer) throws java.io.IOException
Description copied from class:JsonParser
Method to read the textual representation of the current token in chunks and pass it to the given Writer. Conceptually same as calling:writer.write(parser.getText());
but should typically be more efficient as longer content does need to be combined into a singleString
to return, and write can occur directly from intermediate buffers Jackson uses.- Overrides:
getText
in classJsonParser
- Parameters:
writer
- Writer to write textual content to- Returns:
- The number of characters written to the Writer
- Throws:
java.io.IOException
- for low-level read issues or writes using passedwriter
, orJsonParseException
for decoding problems
-
getEmbeddedObject
public java.lang.Object getEmbeddedObject() throws java.io.IOException
Description copied from class:JsonParser
Accessor that can be called if (and only if) the current token isJsonToken.VALUE_EMBEDDED_OBJECT
. For other token types, null is returned.Note: only some specialized parser implementations support embedding of objects (usually ones that are facades on top of non-streaming sources, such as object trees). One exception is access to binary content (whether via base64 encoding or not) which typically is accessible using this method, as well as
JsonParser.getBinaryValue()
.- Overrides:
getEmbeddedObject
in classJsonParser
- Returns:
- Embedded value (usually of "native" type supported by format)
for the current token, if any;
null otherwise
- Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getBinaryValue
public byte[] getBinaryValue(Base64Variant b64variant) throws java.io.IOException
Description copied from class:JsonParser
Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value. It works similar to getting String value viaJsonParser.getText()
and decoding result (except for decoding part), but should be significantly more performant.Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.
- Specified by:
getBinaryValue
in classParserMinimalBase
- Parameters:
b64variant
- Expected variant of base64 encoded content (seeBase64Variants
for definitions of "standard" variants).- Returns:
- Decoded binary data
- Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
isNaN
public boolean isNaN()
Description copied from class:JsonParser
Access for checking whether current token is a numeric value token, but one that is of "not-a-number" (NaN) variety (including both "NaN" AND positive/negative infinity!): not supported by all formats, but often supported forJsonToken.VALUE_NUMBER_FLOAT
. NOTE: roughly equivalent to calling!Double.isFinite()
on value you would get from callingJsonParser.getDoubleValue()
.- Overrides:
isNaN
in classJsonParser
- Returns:
True
if the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
but represents a "Not a Number";false
for other tokens and regular floating-point numbers
-
getNumberType
public JsonParser.NumberType getNumberType() throws java.io.IOException
Description copied from class:JsonParser
If current token is of typeJsonToken.VALUE_NUMBER_INT
orJsonToken.VALUE_NUMBER_FLOAT
, returns one ofJsonParser.NumberType
constants; otherwise returns null.- Specified by:
getNumberType
in classJsonParser
- Returns:
- Type of current number, if parser points to numeric token;
null
otherwise - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getNumberValue
public java.lang.Number getNumberValue() throws java.io.IOException
Description copied from class:JsonParser
Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed.- Specified by:
getNumberValue
in classJsonParser
- Returns:
- Numeric value of the current token in its most optimal representation
- Throws:
java.io.IOException
- Problem with access:JsonParseException
if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plainIOException
if underlying content read fails (possible if values are extracted lazily)
-
getIntValue
public int getIntValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a value of Java int primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow exception.Note: if the resulting integer value falls outside range of Java
int
, aInputCoercionException
may be thrown to indicate numeric overflow/underflow.- Specified by:
getIntValue
in classJsonParser
- Returns:
- Current number value as
int
(if numeric token within Java 32-bit signedint
range); otherwise exception thrown - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getLongValue
public long getLongValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can be expressed as a Java long primitive type. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDoubleValue()
and then casting to int; except for possible overflow/underflow exception.Note: if the token is an integer, but its value falls outside of range of Java long, a
InputCoercionException
may be thrown to indicate numeric overflow/underflow.- Specified by:
getLongValue
in classJsonParser
- Returns:
- Current number value as
long
(if numeric token within Java 32-bit signedlong
range); otherwise exception thrown - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getBigIntegerValue
public java.math.BigInteger getBigIntegerValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_INT
and it can not be used as a Java long primitive type due to its magnitude. It can also be called forJsonToken.VALUE_NUMBER_FLOAT
; if so, it is equivalent to callingJsonParser.getDecimalValue()
and then constructing aBigInteger
from that value.- Specified by:
getBigIntegerValue
in classJsonParser
- Returns:
- Current number value as
BigInteger
(if numeric token); otherwise exception thrown - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getFloatValue
public float getFloatValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java float primitive type. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callingJsonParser.getLongValue()
and then casting; except for possible overflow/underflow exception.Note: if the value falls outside of range of Java float, a
InputCoercionException
will be thrown to indicate numeric overflow/underflow.- Specified by:
getFloatValue
in classJsonParser
- Returns:
- Current number value as
float
(if numeric token within Javafloat
range); otherwise exception thrown - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getDoubleValue
public double getDoubleValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
and it can be expressed as a Java double primitive type. It can also be called forJsonToken.VALUE_NUMBER_INT
; if so, it is equivalent to callingJsonParser.getLongValue()
and then casting; except for possible overflow/underflow exception.Note: if the value falls outside of range of Java double, a
InputCoercionException
will be thrown to indicate numeric overflow/underflow.- Specified by:
getDoubleValue
in classJsonParser
- Returns:
- Current number value as
double
(if numeric token within Javadouble
range); otherwise exception thrown - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
getDecimalValue
public java.math.BigDecimal getDecimalValue() throws java.io.IOException
Description copied from class:JsonParser
Numeric accessor that can be called when the current token is of typeJsonToken.VALUE_NUMBER_FLOAT
orJsonToken.VALUE_NUMBER_INT
. No under/overflow exceptions are ever thrown.- Specified by:
getDecimalValue
in classJsonParser
- Returns:
- Current number value as
BigDecimal
(if numeric token); otherwise exception thrown - Throws:
java.io.IOException
- for low-level read issues, orJsonParseException
for decoding problems
-
-