Package com.fasterxml.jackson.core.util

Class JsonParserDelegate

java.lang.Object
com.fasterxml.jackson.core.JsonParser
com.fasterxml.jackson.core.util.JsonParserDelegate
All Implemented Interfaces:
Versioned, Closeable, AutoCloseable
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

    • setCodec

      public void setCodec(ObjectCodec c)
      Description copied from class: JsonParser
      Setter that allows defining ObjectCodec associated with this parser, if any. Codec is used by JsonParser.readValueAs(Class) method (and its variants).
      Specified by:
      setCodec in class JsonParser
      Parameters:
      c - Codec to assign, if any; null if none

    • getCodec

      public ObjectCodec getCodec()
      Description copied from class: JsonParser
      Accessor for ObjectCodec associated with this parser, if any. Codec is used by JsonParser.readValueAs(Class) method (and its variants).
      Specified by:
      getCodec in class JsonParser
      Returns:
      Codec assigned to this parser, if any; null if none

    • enable

      public JsonParser enable(JsonParser.Feature f)
      Description copied from class: JsonParser
      Method for enabling specified parser feature (check JsonParser.Feature for list of features)
      Overrides:
      enable in class JsonParser
      Parameters:
      f - Feature to enable
      Returns:
      This parser, to allow call chaining

    • disable

      public JsonParser disable(JsonParser.Feature f)
      Description copied from class: JsonParser
      Method for disabling specified feature (check JsonParser.Feature for list of features)
      Overrides:
      disable in class JsonParser
      Parameters:
      f - Feature to disable
      Returns:
      This parser, to allow call chaining

    • isEnabled

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

    • getFeatureMask

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

    • setFeatureMask

      @Deprecated public JsonParser setFeatureMask(int mask)
      Deprecated.
      Description copied from class: JsonParser
      Bulk set method for (re)setting states of all standard JsonParser.Features
      Overrides:
      setFeatureMask in class JsonParser
      Parameters:
      mask - Bit mask that defines set of features to enable
      Returns:
      This parser, to allow call chaining

    • overrideStdFeatures

      public JsonParser overrideStdFeatures(int values, int mask)
      Description copied from class: JsonParser
      Bulk set method for (re)setting states of features specified by mask. Functionally equivalent to int oldState = getFeatureMask(); int newState = (oldState & ~mask) | (values & mask); setFeatureMask(newState); but preferred as this lets caller more efficiently specify actual changes made.
      Overrides:
      overrideStdFeatures in class JsonParser
      Parameters:
      values - Bit mask of set/clear state for features to change
      mask - Bit mask of features to change
      Returns:
      This parser, to allow call chaining

    • overrideFormatFeatures

      public JsonParser overrideFormatFeatures(int values, int mask)
      Description copied from class: JsonParser
      Bulk set method for (re)setting states of FormatFeatures, 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 FormatFeatures.

      Overrides:
      overrideFormatFeatures in class JsonParser
      Parameters:
      values - Bit mask of set/clear state for features to change
      mask - Bit mask of features to change
      Returns:
      This parser, to allow call chaining

    • 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:
      Schema in use by this parser, if any; null if none

    • setSchema

      public void setSchema(FormatSchema schema)
      Description copied from class: JsonParser
      Method to call to make this parser use specified schema. Method must be called before trying to parse any content, right after parser instance has been created. Note that not all parsers support schemas; and those that do usually only accept specific types of schemas: ones defined for data format parser can read.

      If parser does not support specified schema, UnsupportedOperationException is thrown.

      Overrides:
      setSchema in class JsonParser
      Parameters:
      schema - Schema to use

    • canUseSchema

      public boolean canUseSchema(FormatSchema schema)
      Description copied from class: JsonParser
      Method that can be used to verify that given schema can be used with this parser (using JsonParser.setSchema(com.fasterxml.jackson.core.FormatSchema)).
      Overrides:
      canUseSchema in class JsonParser
      Parameters:
      schema - Schema to check
      Returns:
      True if this parser can use given schema; false if not

    • version

      public Version version()
      Description copied from class: JsonParser
      Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.
      Specified by:
      version in interface Versioned
      Specified by:
      version in class JsonParser
      Returns:
      Version of this generator (derived from version declared for jackson-core jar that contains the class

    • getInputSource

      public Object getInputSource()
      Description copied from class: JsonParser
      Method that can be used to get access to object that is used to access input being parsed; this is usually 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.

      Overrides:
      getInputSource in class JsonParser
      Returns:
      Input source this parser was configured with

    • streamReadConstraints

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

    • 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 (@code true}, it is possible to call JsonParser.getNonBlockingInputFeeder() 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

    • getNonBlockingInputFeeder

      public NonBlockingInputFeeder getNonBlockingInputFeeder()
      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:
      getNonBlockingInputFeeder in class JsonParser
      Returns:
      Input feeder to use with non-blocking (async) parsing

    • 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 class JsonParser
      Returns:
      Set of read capabilities for content to read via this parser

    • requiresCustomCodec

      public boolean requiresCustomCodec()
      Description copied from class: JsonParser
      Method that can be called to determine if a custom ObjectCodec is needed for binding data parsed using JsonParser constructed by this factory (which typically also implies the same for serialization with JsonGenerator).
      Overrides:
      requiresCustomCodec in class JsonParser
      Returns:
      True if format-specific codec is needed with this parser; false if a general ObjectCodec is enough

    • close

      public void close() throws 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 feature JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so check JsonFactory for details, but the general idea is that if caller passes in closable resource (such as InputStream or Reader) parser does NOT own the source; but if it passes a reference (such as File or URL and creates stream or reader it does own them.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class JsonParser
      Throws:
      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 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

    • 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.getCurrentToken() 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

    • overrideCurrentName

      public void overrideCurrentName(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 class JsonParser
      Parameters:
      name - Name to use as the current name; may be null.

    • assignCurrentValue

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

    • setCurrentValue

      public void setCurrentValue(Object v)
      Description copied from class: JsonParser
      Alias for JsonParser.assignCurrentValue(java.lang.Object), to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).
      Overrides:
      setCurrentValue in class JsonParser
      Parameters:
      v - Current value to assign for the current input context of this parser

    • getParsingContext

      public JsonStreamContext getParsingContext()
      Description copied from class: JsonParser
      Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.
      Specified by:
      getParsingContext in class JsonParser
      Returns:
      Stream input context (JsonStreamContext) associated with this parser

    • currentToken

      public JsonToken currentToken()
      Description copied from class: JsonParser
      Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.
      Overrides:
      currentToken in 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.getCurrentToken() but that returns an int instead of JsonToken (enum value).

      Use of int directly is typically more efficient on switch statements, so this method may be useful when building low-overhead codecs. Note, however, that effect may not be big enough to matter: make sure to profile performance before deciding to use this method.

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

    • currentName

      public String currentName() throws IOException
      Description copied from class: JsonParser
      Method that can be called to get the name associated with the current token: for JsonToken.FIELD_NAMEs it will be the same as what JsonParser.getText() returns; for field values it will be preceding field name; and for others (array values, root-level values) null.
      Overrides:
      currentName in class JsonParser
      Returns:
      Name of the current field in the parsing context
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • currentValue

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

      Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.

      Overrides:
      currentValue in class JsonParser
      Returns:
      "Current value" associated with the current input context (state) of this parser

    • currentLocation

      public JsonLocation currentLocation()
      Description copied from class: JsonParser
      Method that returns location of the last processed input unit (character or byte) from the input; 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 JsonLocation.NA due to not having access to input location information (when delegating actual decoding work to other library)

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

    • currentTokenLocation

      public JsonLocation currentTokenLocation()
      Description copied from class: JsonParser
      Method that return the starting location of the current (most recently returned) token; that is, the position of the first input unit (character or byte) 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 JsonLocation.NA due to not having access to input location information (when delegating actual decoding work to other library)

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

    • getCurrentToken

      public JsonToken getCurrentToken()
      Description copied from class: JsonParser
      Alias for JsonParser.currentToken(), may be deprecated sometime after Jackson 2.13 (will be removed from 3.0).
      Specified by:
      getCurrentToken in class JsonParser
      Returns:
      Type of the token this parser currently points to, if any: null before any tokens have been read, and

    • getCurrentTokenId

      @Deprecated public int getCurrentTokenId()
      Deprecated.
      Description copied from class: JsonParser
      Deprecated alias for JsonParser.currentTokenId().
      Specified by:
      getCurrentTokenId in class JsonParser
      Returns:
      int matching one of constants from JsonTokenId.

    • getCurrentName

      public String getCurrentName() throws IOException
      Description copied from class: JsonParser
      Alias of JsonParser.currentName().
      Specified by:
      getCurrentName in class JsonParser
      Returns:
      Name of the current field in the parsing context
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getCurrentValue

      public Object getCurrentValue()
      Description copied from class: JsonParser
      Alias for JsonParser.currentValue(), to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).
      Overrides:
      getCurrentValue in class JsonParser
      Returns:
      Location of the last processed input unit (byte or character)

    • getCurrentLocation

      public JsonLocation getCurrentLocation()
      Description copied from class: JsonParser
      Alias for JsonParser.currentLocation(), to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).
      Specified by:
      getCurrentLocation in class JsonParser
      Returns:
      Location of the last processed input unit (byte or character)

    • getTokenLocation

      public JsonLocation getTokenLocation()
      Description copied from class: JsonParser
      Alias for JsonParser.currentTokenLocation(), to be deprecated in later Jackson 2.x versions (and removed from Jackson 3.0).
      Specified by:
      getTokenLocation in class JsonParser
      Returns:
      Starting location of the token parser currently points to

    • 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.

      Overrides:
      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.
      Overrides:
      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.

      Overrides:
      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() throws IOException
      Description copied from class: JsonParser
      Access for checking whether current token is a numeric value token, but one that is of "not-a-number" (NaN) variety (including both "NaN" AND positive/negative infinity!): not supported by all formats, but often supported for JsonToken.VALUE_NUMBER_FLOAT. NOTE: roughly equivalent to calling !Double.isFinite() on value you would get from calling JsonParser.getDoubleValue().
      Overrides:
      isNaN in class JsonParser
      Returns:
      True if the current token is of type JsonToken.VALUE_NUMBER_FLOAT but represents a "Not a Number"; false for other tokens and regular floating-point numbers
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getText

      public String getText() throws IOException
      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:
      getText in class JsonParser
      Returns:
      Textual value associated with the current token (one returned by JsonParser.nextToken() or other iteration methods)
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems, including if the text is too large, see StreamReadConstraints.Builder.maxStringLength(int)

    • hasTextCharacters

      public boolean hasTextCharacters()
      Description copied from class: JsonParser
      Method that can be used to determine whether calling of JsonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.

      Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.

      Specified by:
      hasTextCharacters in class JsonParser
      Returns:
      True if parser currently has character array that can be efficiently returned via JsonParser.getTextCharacters(); false means that it may or may not exist

    • getTextCharacters

      public char[] getTextCharacters() throws IOException
      Description copied from class: JsonParser
      Method similar to JsonParser.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 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:
      IOException - for low-level read issues, or JsonParseException for decoding problems, including if the text is too large, see StreamReadConstraints.Builder.maxStringLength(int)

    • getTextLength

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

    • getTextOffset

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

    • getText

      public int getText(Writer writer) throws IOException, UnsupportedOperationException
      Description copied from class: JsonParser
      Method to read the textual representation of the current token in chunks and pass it to the given Writer. Conceptually same as calling: 
        writer.write(parser.getText());
      but should typically be more efficient as longer content does need to be combined into a single String to return, and write can occur directly from intermediate buffers Jackson uses.
      Overrides:
      getText in class JsonParser
      Parameters:
      writer - Writer to write textual content to
      Returns:
      The number of characters written to the Writer
      Throws:
      IOException - for low-level read issues or writes using passed writer, or JsonParseException for decoding problems
      UnsupportedOperationException

    • getBigIntegerValue

      public BigInteger getBigIntegerValue() throws IOException
      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 not be used as a Java long primitive type due to its magnitude. It can also be called for JsonToken.VALUE_NUMBER_FLOAT; if so, it is equivalent to calling 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
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getBooleanValue

      public boolean getBooleanValue() throws IOException
      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, JsonParseException will be thrown
      Overrides:
      getBooleanValue in class JsonParser
      Returns:
      True if current token is JsonToken.VALUE_TRUE, false if current token is JsonToken.VALUE_FALSE; otherwise throws JsonParseException
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getByteValue

      public byte getByteValue() throws IOException
      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.

      Overrides:
      getByteValue in class JsonParser
      Returns:
      Current number value as byte (if numeric token within range of [-128, 255]); otherwise exception thrown
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getShortValue

      public short getShortValue() throws IOException
      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.

      Overrides:
      getShortValue in class JsonParser
      Returns:
      Current number value as short (if numeric token within Java 16-bit signed short range); otherwise exception thrown
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getDecimalValue

      public BigDecimal getDecimalValue() throws IOException
      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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getDoubleValue

      public double getDoubleValue() throws IOException
      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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getFloatValue

      public float getFloatValue() throws IOException
      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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getIntValue

      public int getIntValue() throws IOException
      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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getLongValue

      public long getLongValue() throws IOException
      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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getNumberType

      public JsonParser.NumberType getNumberType() throws IOException
      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.
      Specified by:
      getNumberType in class JsonParser
      Returns:
      Type of current number, if parser points to numeric token; null otherwise
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getNumberValue

      public Number getNumberValue() throws 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 class JsonParser
      Returns:
      Numeric value of the current token in its most optimal representation
      Throws:
      IOException - Problem with access: JsonParseException if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plain IOException if underlying content read fails (possible if values are extracted lazily)

    • getNumberValueExact

      public Number getNumberValueExact() throws IOException
      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()

      Overrides:
      getNumberValueExact in class JsonParser
      Returns:
      Numeric value of the current token using most accurate representation
      Throws:
      IOException - Problem with access: JsonParseException if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plain IOException if underlying content read fails (possible if values are extracted lazily)

    • getNumberValueDeferred

      public Object getNumberValueDeferred() throws IOException
      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()

      Overrides:
      getNumberValueDeferred in class JsonParser
      Returns:
      Either Number (for already decoded numbers) or String (for deferred decoding).
      Throws:
      IOException - Problem with access: JsonParseException if the current token is not numeric, or if decoding of the value fails (invalid format for numbers); plain IOException if underlying content read fails (possible if values are extracted lazily)

    • getValueAsInt

      public int getValueAsInt() throws IOException
      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 can not be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.

      Overrides:
      getValueAsInt in class JsonParser
      Returns:
      int value current token is converted to, if possible; exception thrown otherwise
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsInt

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

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

      Overrides:
      getValueAsInt in 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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsLong

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

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

      Overrides:
      getValueAsLong in class JsonParser
      Returns:
      long value current token is converted to, if possible; exception thrown otherwise
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsLong

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

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

      Overrides:
      getValueAsLong in 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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsDouble

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

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

      Overrides:
      getValueAsDouble in class JsonParser
      Returns:
      double value current token is converted to, if possible; exception thrown otherwise
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsDouble

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

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

      Overrides:
      getValueAsDouble in 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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsBoolean

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

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

      Overrides:
      getValueAsBoolean in class JsonParser
      Returns:
      boolean value current token is converted to, if possible; exception thrown otherwise
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsBoolean

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

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

      Overrides:
      getValueAsBoolean in 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
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsString

      public String getValueAsString() throws IOException
      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 can not be converted to a String value (including structured types like Objects and Arrays and null token), default value of null will be returned; no exceptions are thrown.
      Overrides:
      getValueAsString in class JsonParser
      Returns:
      String value current token is converted to, if possible; null otherwise
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getValueAsString

      public String getValueAsString(String defaultValue) throws IOException
      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 can not be converted to a String value (including structured types like Objects and Arrays and null token), specified default value will be returned; no exceptions are thrown.
      Specified by:
      getValueAsString in 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
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getEmbeddedObject

      public Object getEmbeddedObject() throws IOException
      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().

      Overrides:
      getEmbeddedObject in class JsonParser
      Returns:
      Embedded value (usually of "native" type supported by format) for the current token, if any; null otherwise
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getBinaryValue

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

    • readBinaryValue

      public int readBinaryValue(Base64Variant b64variant, OutputStream out) throws IOException
      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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • nextToken

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

    • nextValue

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

    • finishToken

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

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

      Overrides:
      finishToken in class JsonParser
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • skipChildren

      public JsonParser skipChildren() throws IOException
      Description copied from class: JsonParser
      Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points 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:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • 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 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 can not 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() throws IOException
      Description copied from class: JsonParser
      Method that can be called to check whether current token (one that was just read) has an associated Object id, and if so, return it. Note that while typically caller should check 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
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • getTypeId

      public Object getTypeId() throws IOException
      Description copied from class: JsonParser
      Method that can be called to check whether current token (one that was just read) has an associated type id, and if so, return it. Note that while typically caller should check 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
      Throws:
      IOException - for low-level read issues, or JsonParseException for decoding problems

    • delegate

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