Module tools.jackson.core
Package tools.jackson.core.util

Class JsonParserDelegate

java.lang.Object
tools.jackson.core.JsonParser
tools.jackson.core.util.JsonParserDelegate
All Implemented Interfaces:
Closeable, AutoCloseable, Versioned
Direct Known Subclasses:
FilteringParserDelegate, JsonParserSequence
public class JsonParserDelegate extends JsonParser
Helper class that implements delegation pattern for JsonParser, to allow for simple overridability of basic parsing functionality. The idea is that any functionality to be modified can be simply overridden; and anything else will be delegated by default.

  • Field Details

    • delegate

      protected JsonParser delegate
      Delegate object that method calls are delegated to.

  • Constructor Details

    • JsonParserDelegate

      public JsonParserDelegate(JsonParser d)

  • Method Details

    • 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 interface Versioned
      Specified by:
      version in class JsonParser
      Returns:
      Version of the component

    • streamReadContext

      public TokenStreamContext streamReadContext()
      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.

      NOTE: method was called getParsingContext() in Jackson 2.x

      Specified by:
      streamReadContext in class JsonParser
      Returns:
      Stream output context (TokenStreamContext) associated with this parser

    • objectReadContext

      public ObjectReadContext objectReadContext()
      Description copied from class: JsonParser
      Accessor for context object provided by higher level data-binding functionality (or, in some cases, simple placeholder of the same) that allows some level of interaction including ability to trigger deserialization of Object values through generator instance.

      Context object is used by parser to implement some methods, like readValueAs(...)

      Specified by:
      objectReadContext in class JsonParser
      Returns:
      Object write context (ObjectReadContext) associated with this parser

    • currentTokenLocation

      public TokenStreamLocation currentTokenLocation()
      Description copied from class: JsonParser
      Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.

      Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only return TokenStreamLocation.NA due to not having access to input location information (when delegating actual decoding work to other library).

      Specified by:
      currentTokenLocation in class JsonParser
      Returns:
      Starting location of the token parser currently points to

    • currentLocation

      public TokenStreamLocation currentLocation()
      Description copied from class: JsonParser
      Method that returns location of the last processed character; usually for error reporting purposes.

      Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only report specific boundary locations (start or end locations of tokens) and others only return TokenStreamLocation.NA due to not having access to input location information (when delegating actual decoding work to other library).

      Specified by:
      currentLocation in class JsonParser
      Returns:
      Location of the last processed input unit (byte or character)

    • currentTokenCount

      public long currentTokenCount()
      Description copied from class: JsonParser
      Get an approximate count of the number of tokens that have been read. This count is likely to be only updated if StreamReadConstraints.Builder.maxTokenCount(long) has been used to set a limit on the number of tokens that can be read.
      Specified by:
      currentTokenCount in class JsonParser
      Returns:
      the number of tokens that have been read (-1 if the count is not available)

    • streamReadInputSource

      public Object streamReadInputSource()
      Description copied from class: JsonParser
      Method that can be used to get access to object that is used to access input being parsed; this is usually either InputStream or Reader, depending on what parser was constructed with. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object.

      In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.

      NOTE: was named getInputSource() in Jackson 2.x.

      Specified by:
      streamReadInputSource in class JsonParser
      Returns:
      Input source this parser was configured with

    • currentValue

      public Object currentValue()
      Description copied from class: JsonParser
      Helper method, usually equivalent to: getParsingContext().currentValue();

      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.

      Specified by:
      currentValue in class JsonParser
      Returns:
      "Current value" for the current input context this parser has

    • assignCurrentValue

      public void assignCurrentValue(Object v)
      Description copied from class: JsonParser
      Helper method, usually equivalent to: getParsingContext().assignCurrentValue(v);
      Specified by:
      assignCurrentValue in class JsonParser
      Parameters:
      v - "Current value" to assign to the current input context of this parser

    • isEnabled

      public boolean isEnabled(StreamReadFeature f)
      Description copied from class: JsonParser
      Method for checking whether specified StreamReadFeature is enabled.
      Specified by:
      isEnabled in class JsonParser
      Parameters:
      f - Feature to check
      Returns:
      True if feature is enabled; false otherwise

    • streamReadFeatures

      public int streamReadFeatures()
      Description copied from class: JsonParser
      Bulk access method for getting state of all standard StreamReadFeatures.
      Specified by:
      streamReadFeatures in class JsonParser
      Returns:
      Bit mask that defines current states of all standard StreamReadFeatures.

    • getSchema

      public FormatSchema getSchema()
      Description copied from class: JsonParser
      Method for accessing Schema that this parser uses, if any. Default implementation returns null.
      Overrides:
      getSchema in class JsonParser
      Returns:
      FormatSchema assigned to this parser, if any; null if none

    • canParseAsync

      public boolean canParseAsync()
      Description copied from class: JsonParser
      Method that can be called to determine if this parser instance uses non-blocking ("asynchronous") input access for decoding or not. Access mode is determined by earlier calls via JsonFactory; it may not be changed after construction.

      If non-blocking decoding is true, it is possible to call JsonParser.nonBlockingInputFeeder() to obtain object to use for feeding input; otherwise (false returned) input is read by blocking.

      Overrides:
      canParseAsync in class JsonParser
      Returns:
      True if this is a non-blocking ("asynchronous") parser

    • nonBlockingInputFeeder

      public NonBlockingInputFeeder nonBlockingInputFeeder()
      Description copied from class: JsonParser
      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.
      Overrides:
      nonBlockingInputFeeder in class JsonParser
      Returns:
      Input feeder to use with non-blocking (async) parsing

    • streamReadCapabilities

      public JacksonFeatureSet<StreamReadCapability> streamReadCapabilities()
      Description copied from class: JsonParser
      Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly).
      Specified by:
      streamReadCapabilities in class JsonParser
      Returns:
      Set of read capabilities for content to read via this parser

    • streamReadConstraints

      public StreamReadConstraints streamReadConstraints()
      Description copied from class: JsonParser
      Get the constraints to apply when performing streaming reads.
      Specified by:
      streamReadConstraints in class JsonParser
      Returns:
      Constraints applied to this parser

    • close

      public void close()
      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 feature StreamReadFeature.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.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class JsonParser

    • 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 calling JsonParser.nextToken() (and the underlying stream may be closed). Closing may be due to an explicit call to JsonParser.close() or because parser has encountered end of input.
      Specified by:
      isClosed in class JsonParser
      Returns:
      True if this parser instance has been closed

    • currentToken

      public JsonToken currentToken()
      Description copied from class: JsonParser
      Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.
      Specified by:
      currentToken in class JsonParser
      Returns:
      Type of the token this parser currently points to, if any: null before any tokens have been read, and after end-of-input has been encountered, as well as if the current token has been explicitly cleared.

    • currentTokenId

      public int currentTokenId()
      Description copied from class: JsonParser
      Method similar to JsonParser.currentToken() 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.

      Specified by:
      currentTokenId in class JsonParser
      Returns:
      int matching one of constants from JsonTokenId.

    • currentName

      public String currentName()
      Description copied from class: JsonParser
      Method that can be called to get the name associated with the current token: for JsonToken.PROPERTY_NAMEs it will be the same as what JsonParser.getString() returns; for Object property values it will be the preceding property name; and for others (array element, root-level values) null.
      Specified by:
      currentName in class JsonParser
      Returns:
      Name of the current property name, if any, in the parsing context (null if none)

    • hasCurrentToken

      public boolean hasCurrentToken()
      Description copied from class: JsonParser
      Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check for parser.getCurrentToken() != null.
      Specified by:
      hasCurrentToken in class JsonParser
      Returns:
      True if the parser just returned a valid token via JsonParser.nextToken(); false otherwise (parser was just constructed, encountered end-of-input and returned null from JsonParser.nextToken(), or the token has been consumed)

    • hasTokenId

      public boolean hasTokenId(int id)
      Description copied from class: JsonParser
      Method that is functionally equivalent to: return currentTokenId() == id but may be more efficiently implemented.

      Note that no traversal or conversion is performed; so in some cases calling method like JsonParser.isExpectedStartArrayToken() is necessary instead.

      Specified by:
      hasTokenId in class JsonParser
      Parameters:
      id - Token id to match (from (@link JsonTokenId})
      Returns:
      True if the parser current points to specified token

    • hasToken

      public boolean hasToken(JsonToken t)
      Description copied from class: JsonParser
      Method that is functionally equivalent to: return currentToken() == t but may be more efficiently implemented.

      Note that no traversal or conversion is performed; so in some cases calling method like JsonParser.isExpectedStartArrayToken() is necessary instead.

      Specified by:
      hasToken in class JsonParser
      Parameters:
      t - Token to match
      Returns:
      True if the parser current points to specified token

    • isExpectedStartArrayToken

      public boolean isExpectedStartArrayToken()
      Description copied from class: JsonParser
      Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token is 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_ARRAY
      but may be overridden by custom parser implementations.
      Specified by:
      isExpectedStartArrayToken in class JsonParser
      Returns:
      True if the current token can be considered as a start-array marker (such JsonToken.START_ARRAY); false if not

    • isExpectedStartObjectToken

      public boolean isExpectedStartObjectToken()
      Description copied from class: JsonParser
      Similar to JsonParser.isExpectedStartArrayToken(), but checks whether stream currently points to JsonToken.START_OBJECT.
      Specified by:
      isExpectedStartObjectToken in class JsonParser
      Returns:
      True if the current token can be considered as a start-array marker (such JsonToken.START_OBJECT); false if not

    • isExpectedNumberIntToken

      public boolean isExpectedNumberIntToken()
      Description copied from class: JsonParser
      Similar to JsonParser.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.

      Specified by:
      isExpectedNumberIntToken in class JsonParser
      Returns:
      True if the current token can be considered as a start-array marker (such JsonToken.VALUE_NUMBER_INT); false if not

    • isNaN

      public boolean isNaN()
      Description copied from class: JsonParser
      Accessor for checking whether current token is a special "not-a-number" (NaN) token (including both "NaN" AND positive/negative infinity!). These values are not supported by all formats: JSON, for example, only supports them if JsonReadFeature.ALLOW_NON_NUMERIC_NUMBERS is enabled.

      NOTE: in case where numeric value is outside range of requested type -- most notably Float or Double -- and decoding results effectively in a NaN value, this method DOES NOT return true: only explicit incoming markers do. This is because value could still be accessed as a valid BigDecimal.

      Specified by:
      isNaN in class JsonParser
      Returns:
      True if the current token is reported as JsonToken.VALUE_NUMBER_FLOAT and represents a "Not a Number" value; false for other tokens and regular floating-point numbers.

    • clearCurrentToken

      public void clearCurrentToken()
      Description copied from class: JsonParser
      Method called to "consume" the current token by effectively removing it so that JsonParser.hasCurrentToken() returns false, and JsonParser.currentToken() null). Cleared token value can still be accessed by calling JsonParser.getLastClearedToken() (if absolutely needed), but usually isn't.

      Method was added to be used by the optional data binder, since it has to be able to consume last token used for binding (so that it will not be used again).

      Specified by:
      clearCurrentToken in class JsonParser

    • getLastClearedToken

      public JsonToken getLastClearedToken()
      Description copied from class: JsonParser
      Method that can be called to get the last token that was cleared using JsonParser.clearCurrentToken(). This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed.
      Specified by:
      getLastClearedToken in class JsonParser
      Returns:
      Last cleared token, if any; null otherwise

    • nextToken

      public JsonToken nextToken() throws JacksonException
      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 class JsonParser
      Returns:
      Next token from the stream, if any found, or null to indicate end-of-input
      Throws:
      JacksonException - for low-level read issues
      StreamReadException - for decoding problems

    • nextValue

      public JsonToken nextValue() throws JacksonException
      Description copied from class: JsonParser
      Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers). Or put another way, nextToken() will be called once, and if JsonToken.PROPERTY_NAME is returned, another time to get the value of the property. Method is most useful for iterating over value entries of JSON objects; Object property name will still be available by calling JsonParser.currentName() when parser points to the value.
      Specified by:
      nextValue in class JsonParser
      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:
      JacksonException - for low-level read issues
      StreamReadException - for decoding problems

    • finishToken

      public void finishToken() throws JacksonException
      Description copied from class: JsonParser
      Method that may be used to force full handling of the current token so that even if lazy processing is enabled, the whole contents are read for possible retrieval. This is usually used to ensure that the token end location is available, as well as token contents (similar to what calling, say JsonParser.getStringCharacters(), would achieve).

      Note that for many dataformat implementations this method will not do anything; this is the default implementation unless overridden by sub-classes.

      Specified by:
      finishToken in class JsonParser
      Throws:
      JacksonException - for low-level read issues
      StreamReadException - for decoding problems

    • skipChildren

      public JsonParser skipChildren() throws JacksonException
      Description copied from class: JsonParser
      Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to 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 JsonParser.nextToken() to point to the next available token, if any.
      Specified by:
      skipChildren in class JsonParser
      Returns:
      This parser, to allow call chaining
      Throws:
      JacksonException - for low-level read issues
      StreamReadException - for decoding problems

    • nextName

      public String nextName() throws JacksonException
      Description copied from class: JsonParser
      Method that fetches next token (as if calling JsonParser.nextToken()) and verifies whether it is JsonToken.PROPERTY_NAME; if it is, returns same as JsonParser.currentName(), otherwise null.

      NOTE: in Jackson 2.x method was called nextFieldName()

      Specified by:
      nextName in class JsonParser
      Returns:
      Name of the the JsonToken.PROPERTY_NAME parser advanced to, if any; null if next token is of some other type
      Throws:
      JacksonException - for low-level read issues
      StreamReadException - for decoding problems

    • nextName

      public boolean nextName(SerializableString str) throws JacksonException
      Description copied from class: JsonParser
      Method that fetches next token (as if calling JsonParser.nextToken()) and verifies whether it is JsonToken.PROPERTY_NAME with specified name and returns result of that comparison. It is functionally equivalent to: 
        return (nextToken() == JsonToken.PROPERTY_NAME) && str.getValue().equals(currentName());
      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.

      NOTE: in Jackson 2.x method was called nextFieldName()

      Specified by:
      nextName in class JsonParser
      Parameters:
      str - Property name to compare next token to (if next token is JsonToken.PROPERTY_NAME)
      Returns:
      True if parser advanced to JsonToken.PROPERTY_NAME with specified name; false otherwise (different token or non-matching name)
      Throws:
      JacksonException - for low-level read issues
      StreamReadException - for decoding problems

    • nextNameMatch

      public int nextNameMatch(PropertyNameMatcher matcher) throws JacksonException
      Description copied from class: JsonParser
      Method that tries to match next token from stream as JsonToken.PROPERTY_NAME, and if so, further match it to one of pre-specified (field) names. If match succeeds, property index (non-negative `int`) is returned; otherwise one of marker constants from PropertyNameMatcher.
      Specified by:
      nextNameMatch in class JsonParser
      Parameters:
      matcher - Matcher that will handle actual matching
      Returns:
      Index of the matched property name, if non-negative, or a negative error code otherwise (see PropertyNameMatcher for details)
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • currentNameMatch

      public int currentNameMatch(PropertyNameMatcher matcher)
      Description copied from class: JsonParser
      Method that verifies that the current token (see JsonParser.currentToken()) is JsonToken.PROPERTY_NAME and if so, further match that associated name (see JsonParser.currentName()) to one of pre-specified (property) names. If there is a match succeeds, the property index (non-negative int) is returned; otherwise one of marker constants from PropertyNameMatcher is returned.
      Specified by:
      currentNameMatch in class JsonParser
      Parameters:
      matcher - Matcher that will handle actual matching
      Returns:
      Index of the matched property name, if non-negative, or a negative error code otherwise (see PropertyNameMatcher for details)

    • getString

      public String getString() throws JacksonException
      Description copied from class: JsonParser
      Method for accessing textual representation of the current token; if no current token (before first call to JsonParser.nextToken(), or after encountering end-of-input), returns null. Method can be called for any token type.
      Specified by:
      getString in class JsonParser
      Returns:
      String value associated with the current token (one returned by JsonParser.nextToken() or other iteration methods)
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • hasStringCharacters

      public boolean hasStringCharacters()
      Description copied from class: JsonParser
      Method that can be used to determine whether calling of JsonParser.getStringCharacters() would be the most efficient way to access String value for the event parser currently points to (compared to JsonParser.getString()).
      Specified by:
      hasStringCharacters in class JsonParser
      Returns:
      True if parser currently has character array that can be efficiently returned via JsonParser.getStringCharacters(); false means that it may or may not exist

    • getStringCharacters

      public char[] getStringCharacters() throws JacksonException
      Description copied from class: JsonParser
      Method similar to JsonParser.getString(), 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:

      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.getString()) is to avoid construction of a String object (which will make a copy of contents).

      Specified by:
      getStringCharacters in class JsonParser
      Returns:
      Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • getStringLength

      public int getStringLength() throws JacksonException
      Description copied from class: JsonParser
      Accessor used with JsonParser.getStringCharacters(), to know length of String stored in returned buffer.
      Specified by:
      getStringLength in class JsonParser
      Returns:
      Number of characters within buffer returned by JsonParser.getStringCharacters() that are part of textual content of the current token.
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • getStringOffset

      public int getStringOffset() throws JacksonException
      Description copied from class: JsonParser
      Accessor used with JsonParser.getStringCharacters(), to know offset of the first text content character within buffer.
      Specified by:
      getStringOffset in class JsonParser
      Returns:
      Offset of the first character within buffer returned by JsonParser.getStringCharacters() that is part of textual content of the current token.
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • getString

      public int getString(Writer writer) throws JacksonException
      Description copied from class: JsonParser
      Method to read the textual representation of the current token in chunks and pass it to the given Writer. Functionally same as calling: 
        writer.write(parser.getString());
      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.

      NOTE: String value will still be buffered (usually using TextBuffer) and will be accessible with other getString() calls (that is, it will not be consumed). So this accessor only avoids construction of String compared to plain JsonParser.getString() method.

      NOTE: In Jackson 2.x this method was called getString(Writer).

      Specified by:
      getString in class JsonParser
      Parameters:
      writer - Writer to write String value to
      Returns:
      The number of characters written to the Writer
      Throws:
      JacksonIOException - for low-level read issues, or failed write using Writer
      StreamReadException - for decoding problems
      JacksonException

    • getBigIntegerValue

      public BigInteger getBigIntegerValue()
      Description copied from class: JsonParser
      Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_INT and it cannot 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 JsonParser.getDecimalValue() and then constructing a BigInteger from that value.
      Specified by:
      getBigIntegerValue in class JsonParser
      Returns:
      Current number value as BigInteger (if numeric token); otherwise exception thrown

    • getBooleanValue

      public boolean getBooleanValue() throws InputCoercionException
      Description copied from class: JsonParser
      Convenience accessor that can be called when the current token is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE, to return matching boolean value. If the current token is of some other type, InputCoercionException will be thrown
      Specified by:
      getBooleanValue in class JsonParser
      Returns:
      True if current token is JsonToken.VALUE_TRUE, false if current token is JsonToken.VALUE_FALSE; otherwise throws InputCoercionException
      Throws:
      InputCoercionException - if the current token is not of boolean type

    • getByteValue

      public byte getByteValue() throws InputCoercionException
      Description copied from class: JsonParser
      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. 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 JsonParser.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.

      Specified by:
      getByteValue in class JsonParser
      Returns:
      Current number value as byte (if numeric token within range of [-128, 255]); otherwise exception thrown
      Throws:
      InputCoercionException - If either token type is not a number OR numeric value exceeds allowed range

    • getShortValue

      public short getShortValue() throws InputCoercionException
      Description copied from class: JsonParser
      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. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.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.

      Specified by:
      getShortValue in class JsonParser
      Returns:
      Current number value as short (if numeric token within Java 16-bit signed short range); otherwise exception thrown
      Throws:
      InputCoercionException - If either token type is not a number OR numeric value exceeds allowed range

    • getDecimalValue

      public BigDecimal getDecimalValue() throws InputCoercionException
      Description copied from class: JsonParser
      Numeric accessor that can be called when the current token is of type JsonToken.VALUE_NUMBER_FLOAT or JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions are ever thrown.
      Specified by:
      getDecimalValue in class JsonParser
      Returns:
      Current number value as BigDecimal (if numeric token); otherwise exception thrown
      Throws:
      InputCoercionException - If either token type is not a number

    • getDoubleValue

      public double getDoubleValue() throws InputCoercionException
      Description copied from class: JsonParser
      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. It can also be called for JsonToken.VALUE_NUMBER_INT; if so, it is equivalent to calling JsonParser.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 class JsonParser
      Returns:
      Current number value as double (if numeric token within Java double range); otherwise exception thrown
      Throws:
      InputCoercionException - If either token type is not a number OR numeric value exceeds allowed range

    • getFloatValue

      public float getFloatValue() throws InputCoercionException
      Description copied from class: JsonParser
      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. It can also be called for JsonToken.VALUE_NUMBER_INT; if so, it is equivalent to calling JsonParser.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 class JsonParser
      Returns:
      Current number value as float (if numeric token within Java float range); otherwise exception thrown
      Throws:
      InputCoercionException - If either token type is not a number OR numeric value exceeds allowed range

    • getIntValue

      public int getIntValue() throws InputCoercionException
      Description copied from class: JsonParser
      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. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.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.

      Specified by:
      getIntValue in class JsonParser
      Returns:
      Current number value as int (if numeric token within Java 32-bit signed int range); otherwise exception thrown
      Throws:
      InputCoercionException - If either token type is not a number OR numeric value exceeds allowed range

    • getLongValue

      public long getLongValue() throws InputCoercionException
      Description copied from class: JsonParser
      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. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling JsonParser.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 class JsonParser
      Returns:
      Current number value as long (if numeric token within Java 32-bit signed long range); otherwise exception thrown
      Throws:
      InputCoercionException - If either token type is not a number OR numeric value exceeds allowed range

    • getNumberType

      public JsonParser.NumberType getNumberType()
      Description copied from class: JsonParser
      If current token is of type JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.

      NOTE: in Jackson 2.x, an exception was wrong if called for non-numeric token.

      Specified by:
      getNumberType in class JsonParser
      Returns:
      Type of current number, if parser points to numeric token; null otherwise

    • getNumberTypeFP

      public JsonParser.NumberTypeFP getNumberTypeFP()
      Description copied from class: JsonParser
      If current token is of type JsonToken.VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberTypeFP constants; otherwise returns JsonParser.NumberTypeFP.UNKNOWN.
      Specified by:
      getNumberTypeFP in class JsonParser
      Returns:
      Type of current number, if parser points to numeric token; null otherwise

    • getNumberValue

      public Number getNumberValue() throws InputCoercionException
      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 class JsonParser
      Returns:
      Numeric value of the current token in its most optimal representation
      Throws:
      InputCoercionException - If the current token is not of numeric type

    • getNumberValueExact

      public Number getNumberValueExact() throws InputCoercionException
      Description copied from class: JsonParser
      Method similar to JsonParser.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 JsonParser.getNumberValue()

      Specified by:
      getNumberValueExact in class JsonParser
      Returns:
      Numeric value of the current token using most accurate representation
      Throws:
      InputCoercionException - If the current token is not of numeric type

    • getNumberValueDeferred

      public Object getNumberValueDeferred() throws InputCoercionException
      Description copied from class: JsonParser
      Method similar to JsonParser.getNumberValue() but that returns either same Number value as JsonParser.getNumberValue() (if already decoded), or String representation of as-of-yet undecoded number. Typically textual formats allow deferred decoding from String, whereas binary formats either decode numbers eagerly or have binary representation from which to decode value to return.

      Same constraints apply to calling this method as to JsonParser.getNumberValue(): current token must be either JsonToken.VALUE_NUMBER_INT or JsonToken.VALUE_NUMBER_FLOAT; otherwise an exception is thrown

      Default implementation simply returns JsonParser.getNumberValue()

      Specified by:
      getNumberValueDeferred in class JsonParser
      Returns:
      Either Number (for already decoded numbers) or String (for deferred decoding).
      Throws:
      InputCoercionException - If the current token is not of numeric type

    • getValueAsInt

      public int getValueAsInt() throws InputCoercionException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a Java 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 cannot be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.

      Overrides:
      getValueAsInt in class JsonParser
      Returns:
      int value current token is converted to, if possible; default value otherwise otherwise
      Throws:
      InputCoercionException - If numeric value exceeds int range

    • getValueAsInt

      public int getValueAsInt(int defaultValue) throws InputCoercionException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

      If representation cannot be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.

      Overrides:
      getValueAsInt in class JsonParser
      Parameters:
      defaultValue - Default value to return if conversion to int is not possible
      Returns:
      int value current token is converted to, if possible; def otherwise
      Throws:
      InputCoercionException - If numeric value exceeds int range

    • getValueAsLong

      public long getValueAsLong() throws InputCoercionException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

      If representation cannot be converted to a long (including structured type markers like start/end Object/Array) default value of 0L will be returned; no exceptions are thrown.

      Overrides:
      getValueAsLong in class JsonParser
      Returns:
      long value current token is converted to, if possible; default value otherwise
      Throws:
      InputCoercionException - If numeric value exceeds long range

    • getValueAsLong

      public long getValueAsLong(long defaultValue) throws InputCoercionException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

      If representation cannot be converted to a long (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.

      Overrides:
      getValueAsLong in class JsonParser
      Parameters:
      defaultValue - Default value to return if conversion to long is not possible
      Returns:
      long value current token is converted to, if possible; def otherwise
      Throws:
      InputCoercionException - If numeric value exceeds long range

    • getValueAsDouble

      public double getValueAsDouble() throws InputCoercionException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language floating point parsing rules.

      If representation cannot be converted to a double (including structured types like Objects and Arrays), default value of 0.0 will be returned; no exceptions are thrown.

      Overrides:
      getValueAsDouble in class JsonParser
      Returns:
      double value current token is converted to, if possible; default value otherwise
      Throws:
      InputCoercionException - If numeric value exceeds double range

    • getValueAsDouble

      public double getValueAsDouble(double defaultValue) throws InputCoercionException
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language floating point parsing rules.

      If representation cannot be converted to a double (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.

      Overrides:
      getValueAsDouble in class JsonParser
      Parameters:
      defaultValue - Default value to return if conversion to double is not possible
      Returns:
      double value current token is converted to, if possible; def otherwise
      Throws:
      InputCoercionException - If numeric value exceeds double range

    • getValueAsBoolean

      public boolean getValueAsBoolean()
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.

      If representation cannot be converted to a boolean value (including structured types like Objects and Arrays), default value of false will be returned; no exceptions are thrown.

      Overrides:
      getValueAsBoolean in class JsonParser
      Returns:
      boolean value current token is converted to, if possible; or false if not

    • getValueAsBoolean

      public boolean getValueAsBoolean(boolean defaultValue)
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.

      If representation cannot be converted to a boolean value (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.

      Specified by:
      getValueAsBoolean in class JsonParser
      Parameters:
      defaultValue - Default value to return if conversion to boolean is not possible
      Returns:
      boolean value current token is converted to, if possible; def otherwise

    • getValueAsString

      public String getValueAsString()
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation cannot be converted to a String value (including structured types like Objects and Arrays and null token), default value of null will be returned; no exceptions are thrown.
      Overrides:
      getValueAsString in class JsonParser
      Returns:
      String value current token is converted to, if possible; null otherwise

    • getValueAsString

      public String getValueAsString(String defaultValue)
      Description copied from class: JsonParser
      Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation cannot be converted to a String value (including structured types like Objects and Arrays and null token), specified default value will be returned; no exceptions are thrown.
      Specified by:
      getValueAsString in class JsonParser
      Parameters:
      defaultValue - Default value to return if conversion to String is not possible
      Returns:
      String value current token is converted to, if possible; def otherwise

    • getEmbeddedObject

      public Object getEmbeddedObject()
      Description copied from class: JsonParser
      Accessor that can be called if (and only if) the current token is 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 JsonParser.getBinaryValue().

      Specified by:
      getEmbeddedObject in class JsonParser
      Returns:
      Embedded value (usually of "native" type supported by format) for the current token, if any; null otherwise

    • getBinaryValue

      public byte[] getBinaryValue(Base64Variant b64variant) throws JacksonException
      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 via JsonParser.getString() 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 class JsonParser
      Parameters:
      b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).
      Returns:
      Decoded binary data
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • readBinaryValue

      public int readBinaryValue(Base64Variant b64variant, OutputStream out) throws JacksonException
      Description copied from class: JsonParser
      Similar to JsonParser.readBinaryValue(OutputStream) but allows explicitly specifying base64 variant to use.
      Overrides:
      readBinaryValue in class JsonParser
      Parameters:
      b64variant - base64 variant to use
      out - Output stream to use for passing decoded binary data
      Returns:
      Number of bytes that were decoded and written via OutputStream
      Throws:
      JacksonIOException - for low-level read issues
      StreamReadException - for decoding problems
      JacksonException

    • readValueAs

      public <T> T readValueAs(Class<T> valueType) throws JacksonException
      Description copied from class: JsonParser
      Method to deserialize stream content into a non-container type (it can be an array type, however): typically a bean, array or a wrapper type (like Boolean).
      Note: method can only be called if the parser has been constructed with a linkage to ObjectReadContext; this is true if constructed by databinding layer above, or by factory method that takes in context object.

      This method may advance the event stream, for structured values the current token will be the closing end marker (END_ARRAY, END_OBJECT) of the bound structure. For non-structured values (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 cannot be introspected when using this method.

      Specified by:
      readValueAs in class JsonParser
      Type Parameters:
      T - Nominal type parameter to specify expected node type to reduce need to cast result value
      Parameters:
      valueType - Type to bind content to
      Returns:
      Java value read from content
      Throws:
      JacksonException - if there is either an underlying I/O problem or decoding issue at format layer

    • readValueAs

      public <T> T readValueAs(TypeReference<T> valueTypeRef) throws JacksonException
      Description copied from class: JsonParser
      Method to deserialize stream 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 been constructed with a linkage to ObjectReadContext; this is true if constructed by databinding layer above, or by factory method that takes in context object.

      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 types (and for JsonToken.VALUE_EMBEDDED_OBJECT) stream is not advanced.

      Specified by:
      readValueAs in class JsonParser
      Type Parameters:
      T - Nominal type parameter to specify expected node type to reduce need to cast result value
      Parameters:
      valueTypeRef - Type to bind content to
      Returns:
      Java value read from content
      Throws:
      JacksonException - if there is either an underlying I/O problem or decoding issue at format layer

    • readValueAs

      public <T> T readValueAs(ResolvedType type) throws JacksonException
      Specified by:
      readValueAs in class JsonParser
      Throws:
      JacksonException

    • readValueAsTree

      public <T extends TreeNode> T readValueAsTree() throws JacksonException
      Description copied from class: JsonParser
      Method to deserialize stream content into equivalent "tree model", represented by root TreeNode of resulting model. For Array values it will an array node (with child nodes), for Object values object node (with child nodes), and for other types matching leaf node type. Empty or whitespace documents are null.
      Note: method can only be called if the parser has been constructed with a linkage to ObjectReadContext; this is true if constructed by databinding layer above, or by factory method that takes in context object.
      Specified by:
      readValueAsTree in class JsonParser
      Type Parameters:
      T - Nominal type parameter for result node type (to reduce need for casting)
      Returns:
      root of the document, or null if empty or whitespace.
      Throws:
      JacksonException - if there is either an underlying I/O problem or decoding issue at format layer

    • 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 cannot use native object ids.

      Overrides:
      canReadObjectId in class JsonParser
      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 cannot use native type ids.

      Overrides:
      canReadTypeId in class JsonParser
      Returns:
      True if the format being read supports native Type Ids; false if not

    • getObjectId

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

      Default implementation will simply return null.

      Overrides:
      getObjectId in class JsonParser
      Returns:
      Native Object id associated with the current token, if any; null if none

    • getTypeId

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

      Default implementation will simply return null.

      Overrides:
      getTypeId in class JsonParser
      Returns:
      Native Type Id associated with the current token, if any; null if none

    • delegate

      public JsonParser delegate()
      Accessor for getting the immediate JsonParser this parser delegates calls to.
      Returns:
      Underlying parser calls are delegated to