public class JsonParserDelegate extends JsonParser
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.JsonParser.Feature, JsonParser.NumberType| Constructor and Description | 
|---|
JsonParserDelegate(JsonParser d)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
assignCurrentValue(java.lang.Object v)
Helper method, usually equivalent to:
 
   getParsingContext().setCurrentValue(v);
 | 
boolean | 
canReadObjectId()
Introspection method that may be called to see if the underlying
 data format supports some kind of Object Ids natively (many do not;
 for example, JSON doesn't). 
 | 
boolean | 
canReadTypeId()
Introspection method that may be called to see if the underlying
 data format supports some kind of Type Ids natively (many do not;
 for example, JSON doesn't). 
 | 
boolean | 
canUseSchema(FormatSchema schema)
Method that can be used to verify that given schema can be used with
 this parser (using  
JsonParser.setSchema(com.fasterxml.jackson.core.FormatSchema)). | 
void | 
clearCurrentToken()
Method called to "consume" the current token by effectively
 removing it so that  
JsonParser.hasCurrentToken() returns false, and
 JsonParser.getCurrentToken() null). | 
void | 
close()
Closes the parser so that no further iteration or data access
 can be made; will also close the underlying input source
 if parser either owns the input source, or feature
  
JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled. | 
JsonLocation | 
currentLocation()
Method that returns location of the last processed input unit (character
 or byte) from the input;
 usually for error reporting purposes. 
 | 
java.lang.String | 
currentName()
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. | 
JsonToken | 
currentToken()
Accessor to find which token parser currently points to, if any;
 null will be returned if none. 
 | 
int | 
currentTokenId()
Method similar to  
JsonParser.getCurrentToken() but that returns an
 int instead of JsonToken (enum value). | 
JsonLocation | 
currentTokenLocation()
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. 
 | 
java.lang.Object | 
currentValue()
Helper method, usually equivalent to:
 
   getParsingContext().getCurrentValue();
 | 
JsonParser | 
delegate()
Accessor for getting the immediate  
JsonParser this parser delegates calls to. | 
JsonParser | 
disable(JsonParser.Feature f)
Method for disabling specified  feature
 (check  
JsonParser.Feature for list of features) | 
JsonParser | 
enable(JsonParser.Feature f)
Method for enabling specified parser feature
 (check  
JsonParser.Feature for list of features) | 
void | 
finishToken()
Method that may be used to force full handling of the current token
 so that even if lazy processing is enabled, the whole contents are
 read for possible retrieval. 
 | 
java.math.BigInteger | 
getBigIntegerValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_INT and
 it can not be used as a Java long primitive type due to its
 magnitude. | 
byte[] | 
getBinaryValue(Base64Variant b64variant)
Method that can be used to read (and consume -- results
 may not be accessible using other methods after the call)
 base64-encoded binary data
 included in the current textual JSON value. 
 | 
boolean | 
getBooleanValue()
Convenience accessor that can be called when the current
 token is  
JsonToken.VALUE_TRUE or
 JsonToken.VALUE_FALSE, to return matching boolean
 value. | 
byte | 
getByteValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_INT and
 it can be expressed as a value of Java byte primitive type. | 
ObjectCodec | 
getCodec()
Accessor for  
ObjectCodec associated with this
 parser, if any. | 
JsonLocation | 
getCurrentLocation()
Alias for  
JsonParser.currentLocation(), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0). | 
java.lang.String | 
getCurrentName()
Alias of  
JsonParser.currentName(). | 
JsonToken | 
getCurrentToken()
Alias for  
JsonParser.currentToken(), may be deprecated sometime after
 Jackson 2.13 (will be removed from 3.0). | 
int | 
getCurrentTokenId()
Deprecated.  
 | 
java.lang.Object | 
getCurrentValue()
Alias for  
JsonParser.currentValue(), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0). | 
java.math.BigDecimal | 
getDecimalValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_FLOAT or
 JsonToken.VALUE_NUMBER_INT. | 
double | 
getDoubleValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_FLOAT and
 it can be expressed as a Java double primitive type. | 
java.lang.Object | 
getEmbeddedObject()
Accessor that can be called if (and only if) the current token
 is  
JsonToken.VALUE_EMBEDDED_OBJECT. | 
int | 
getFeatureMask()
Bulk access method for getting state of all standard  
JsonParser.Features. | 
float | 
getFloatValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_FLOAT and
 it can be expressed as a Java float primitive type. | 
java.lang.Object | 
getInputSource()
Method that can be used to get access to object that is used
 to access input being parsed; this is usually either
  
InputStream or Reader, depending on what
 parser was constructed with. | 
int | 
getIntValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_INT and
 it can be expressed as a value of Java int primitive type. | 
JsonToken | 
getLastClearedToken()
Method that can be called to get the last token that was
 cleared using  
JsonParser.clearCurrentToken(). | 
long | 
getLongValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_INT and
 it can be expressed as a Java long primitive type. | 
JsonParser.NumberType | 
getNumberType()
If current token is of type 
  
JsonToken.VALUE_NUMBER_INT or
 JsonToken.VALUE_NUMBER_FLOAT, returns
 one of JsonParser.NumberType constants; otherwise returns null. | 
java.lang.Number | 
getNumberValue()
Generic number value accessor method that will work for
 all kinds of numeric values. 
 | 
java.lang.Number | 
getNumberValueExact()
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. | 
java.lang.Object | 
getObjectId()
Method that can be called to check whether current token
 (one that was just read) has an associated Object id, and if
 so, return it. 
 | 
JsonStreamContext | 
getParsingContext()
Method that can be used to access current parsing context reader
 is in. 
 | 
JacksonFeatureSet<StreamReadCapability> | 
getReadCapabilities()
Accessor for getting metadata on capabilities of this parser, based on
 underlying data format being read (directly or indirectly). 
 | 
FormatSchema | 
getSchema()
Method for accessing Schema that this parser uses, if any. 
 | 
short | 
getShortValue()
Numeric accessor that can be called when the current
 token is of type  
JsonToken.VALUE_NUMBER_INT and
 it can be expressed as a value of Java short primitive type. | 
java.lang.String | 
getText()
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. | 
int | 
getText(java.io.Writer writer)
Method to read the textual representation of the current token in chunks and 
 pass it to the given Writer. 
 | 
char[] | 
getTextCharacters()
Method similar 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. | 
int | 
getTextLength()
Accessor used with  
JsonParser.getTextCharacters(), to know length
 of String stored in returned buffer. | 
int | 
getTextOffset()
Accessor used with  
JsonParser.getTextCharacters(), to know offset
 of the first text content character within buffer. | 
JsonLocation | 
getTokenLocation()
Alias for  
JsonParser.currentTokenLocation(), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0). | 
java.lang.Object | 
getTypeId()
Method that can be called to check whether current token
 (one that was just read) has an associated type id, and if
 so, return it. 
 | 
boolean | 
getValueAsBoolean()
Method that will try to convert value of current token to a
 boolean. 
 | 
boolean | 
getValueAsBoolean(boolean defaultValue)
Method that will try to convert value of current token to a
 boolean. 
 | 
double | 
getValueAsDouble()
Method that will try to convert value of current token to a Java
 double. 
 | 
double | 
getValueAsDouble(double defaultValue)
Method that will try to convert value of current token to a
 Java double. 
 | 
int | 
getValueAsInt()
Method that will try to convert value of current token to a
 Java  
int value. | 
int | 
getValueAsInt(int defaultValue)
Method that will try to convert value of current token to a
 int. 
 | 
long | 
getValueAsLong()
Method that will try to convert value of current token to a
 long. 
 | 
long | 
getValueAsLong(long defaultValue)
Method that will try to convert value of current token to a
 long. 
 | 
java.lang.String | 
getValueAsString()
Method that will try to convert value of current token to a
  
String. | 
java.lang.String | 
getValueAsString(java.lang.String defaultValue)
Method that will try to convert value of current token to a
  
String. | 
boolean | 
hasCurrentToken()
Method for checking whether parser currently points to
 a token (and data for that token is available). 
 | 
boolean | 
hasTextCharacters()
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. | 
boolean | 
hasToken(JsonToken t)
Method that is functionally equivalent to:
 
  return currentToken() == t
 but may be more efficiently implemented. | 
boolean | 
hasTokenId(int id)
Method that is functionally equivalent to:
 
  return currentTokenId() == id
 but may be more efficiently implemented. | 
boolean | 
isClosed()
Method that can be called to determine whether this parser
 is closed or not. 
 | 
boolean | 
isEnabled(JsonParser.Feature f)
Method for checking whether specified  
JsonParser.Feature is enabled. | 
boolean | 
isExpectedNumberIntToken()
Similar to  
JsonParser.isExpectedStartArrayToken(), but checks whether stream
 currently points to JsonToken.VALUE_NUMBER_INT. | 
boolean | 
isExpectedStartArrayToken()
Specialized accessor that can be used to verify that the current
 token indicates start array (usually meaning that current token
 is  
JsonToken.START_ARRAY) when start array is expected. | 
boolean | 
isExpectedStartObjectToken()
Similar to  
JsonParser.isExpectedStartArrayToken(), but checks whether stream
 currently points to JsonToken.START_OBJECT. | 
boolean | 
isNaN()
Access for checking whether current token is a numeric value token, but
 one that is of "not-a-number" (NaN) variety (including both "NaN" AND
 positive/negative infinity!): not supported by all formats,
 but often supported for  
JsonToken.VALUE_NUMBER_FLOAT. | 
JsonToken | 
nextToken()
Main iteration method, which will advance stream enough
 to determine type of the next token, if any. 
 | 
JsonToken | 
nextValue()
Iteration method that will advance stream enough
 to determine type of the next token that is a value type
 (including JSON Array and Object start/end markers). 
 | 
void | 
overrideCurrentName(java.lang.String name)
Method that can be used to change what is considered to be
 the current (field) name. 
 | 
JsonParser | 
overrideFormatFeatures(int values,
                      int mask)
Bulk set method for (re)setting states of  
FormatFeatures,
 by specifying values (set / clear) along with a mask, to determine
 which features to change, if any. | 
JsonParser | 
overrideStdFeatures(int values,
                   int mask)
Bulk set method for (re)setting states of features specified by  
mask. | 
int | 
readBinaryValue(Base64Variant b64variant,
               java.io.OutputStream out)
Similar to  
JsonParser.readBinaryValue(OutputStream) but allows explicitly
 specifying base64 variant to use. | 
boolean | 
requiresCustomCodec()
Method that can be called to determine if a custom
  
ObjectCodec is needed for binding data parsed
 using JsonParser constructed by this factory
 (which typically also implies the same for serialization
 with JsonGenerator). | 
void | 
setCodec(ObjectCodec c)
Setter that allows defining  
ObjectCodec associated with this
 parser, if any. | 
void | 
setCurrentValue(java.lang.Object v)
Alias for  
JsonParser.assignCurrentValue(java.lang.Object), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0). | 
JsonParser | 
setFeatureMask(int mask)
Deprecated.  
 | 
void | 
setSchema(FormatSchema schema)
Method to call to make this parser use specified schema. 
 | 
JsonParser | 
skipChildren()
Method that will skip all child tokens of an array or
 object token that the parser currently points to,
 iff stream points to 
  
JsonToken.START_OBJECT or JsonToken.START_ARRAY. | 
Version | 
version()
Accessor for getting version of the core package, given a parser instance. 
 | 
canParseAsync, configure, getBinaryValue, getFormatFeatures, getNonBlockingInputFeeder, isEnabled, nextBooleanValue, nextFieldName, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnErrorpublic JsonParserDelegate(JsonParser d)
public void setCodec(ObjectCodec c)
JsonParserObjectCodec associated with this
 parser, if any. Codec is used by JsonParser.readValueAs(Class)
 method (and its variants).setCodec in class JsonParserc - Codec to assign, if any; null if nonepublic ObjectCodec getCodec()
JsonParserObjectCodec associated with this
 parser, if any. Codec is used by JsonParser.readValueAs(Class)
 method (and its variants).getCodec in class JsonParsernull if nonepublic JsonParser enable(JsonParser.Feature f)
JsonParserJsonParser.Feature for list of features)enable in class JsonParserf - Feature to enablepublic JsonParser disable(JsonParser.Feature f)
JsonParserJsonParser.Feature for list of features)disable in class JsonParserf - Feature to disablepublic boolean isEnabled(JsonParser.Feature f)
JsonParserJsonParser.Feature is enabled.isEnabled in class JsonParserf - Feature to checkTrue if feature is enabled; false otherwisepublic int getFeatureMask()
JsonParserJsonParser.Features.getFeatureMask in class JsonParserJsonParser.Features.@Deprecated public JsonParser setFeatureMask(int mask)
JsonParserJsonParser.FeaturessetFeatureMask in class JsonParsermask - Bit mask that defines set of features to enablepublic JsonParser overrideStdFeatures(int values, int mask)
JsonParsermask.
 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.overrideStdFeatures in class JsonParservalues - Bit mask of set/clear state for features to changemask - Bit mask of features to changepublic JsonParser overrideFormatFeatures(int values, int mask)
JsonParserFormatFeatures,
 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.
overrideFormatFeatures in class JsonParservalues - Bit mask of set/clear state for features to changemask - Bit mask of features to changepublic FormatSchema getSchema()
JsonParsergetSchema in class JsonParsernull if nonepublic void setSchema(FormatSchema schema)
JsonParser
 If parser does not support specified schema, UnsupportedOperationException
 is thrown.
setSchema in class JsonParserschema - Schema to usepublic boolean canUseSchema(FormatSchema schema)
JsonParserJsonParser.setSchema(com.fasterxml.jackson.core.FormatSchema)).canUseSchema in class JsonParserschema - Schema to checkpublic Version version()
JsonParserversion in interface Versionedversion in class JsonParserjackson-core jar that contains the classpublic java.lang.Object getInputSource()
JsonParserInputStream 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.
getInputSource in class JsonParserpublic boolean requiresCustomCodec()
JsonParserObjectCodec is needed for binding data parsed
 using JsonParser constructed by this factory
 (which typically also implies the same for serialization
 with JsonGenerator).requiresCustomCodec in class JsonParserObjectCodec is enoughpublic JacksonFeatureSet<StreamReadCapability> getReadCapabilities()
JsonParsergetReadCapabilities in class JsonParserpublic void close()
           throws java.io.IOException
JsonParserJsonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
 Whether parser owns the input source depends on factory
 method that was used to construct instance (so check
 JsonFactory for details,
 but the general
 idea is that if caller passes in closable resource (such
 as InputStream or Reader) parser does NOT
 own the source; but if it passes a reference (such as
 File or URL and creates
 stream or reader it does own them.close in interface java.io.Closeableclose in interface java.lang.AutoCloseableclose in class JsonParserjava.io.IOException - if there is either an underlying I/O problempublic boolean isClosed()
JsonParserJsonParser.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.isClosed in class JsonParserTrue if this parser instance has been closedpublic void clearCurrentToken()
JsonParserJsonParser.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).
clearCurrentToken in class JsonParserpublic JsonToken getLastClearedToken()
JsonParserJsonParser.clearCurrentToken(). This is not necessarily
 the latest token read.
 Will return null if no tokens have been cleared,
 or if parser has been closed.getLastClearedToken in class JsonParsernull otherwisepublic void overrideCurrentName(java.lang.String name)
JsonParserNote that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
overrideCurrentName in class JsonParsername - Name to use as the current name; may be null.public void assignCurrentValue(java.lang.Object v)
JsonParser
   getParsingContext().setCurrentValue(v);
assignCurrentValue in class JsonParserv - Current value to assign for the current input context of this parserpublic void setCurrentValue(java.lang.Object v)
JsonParserJsonParser.assignCurrentValue(java.lang.Object), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0).setCurrentValue in class JsonParserv - Current value to assign for the current input context of this parserpublic JsonStreamContext getParsingContext()
JsonParsergetParsingContext in class JsonParserJsonStreamContext) associated with this parserpublic JsonToken currentToken()
JsonParsercurrentToken in class JsonParserpublic int currentTokenId()
JsonParserJsonParser.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.
currentTokenId in class JsonParserint matching one of constants from JsonTokenId.public java.lang.String currentName()
                             throws java.io.IOException
JsonParserJsonToken.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.currentName in class JsonParserjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.Object currentValue()
JsonParser
   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.
currentValue in class JsonParserpublic JsonLocation currentLocation()
JsonParser
 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)
currentLocation in class JsonParserpublic JsonLocation currentTokenLocation()
JsonParser
 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)
currentTokenLocation in class JsonParserpublic JsonToken getCurrentToken()
JsonParserJsonParser.currentToken(), may be deprecated sometime after
 Jackson 2.13 (will be removed from 3.0).getCurrentToken in class JsonParser@Deprecated public int getCurrentTokenId()
JsonParserJsonParser.currentTokenId().getCurrentTokenId in class JsonParserint matching one of constants from JsonTokenId.public java.lang.String getCurrentName()
                                throws java.io.IOException
JsonParserJsonParser.currentName().getCurrentName in class JsonParserjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.Object getCurrentValue()
JsonParserJsonParser.currentValue(), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0).getCurrentValue in class JsonParserpublic JsonLocation getCurrentLocation()
JsonParserJsonParser.currentLocation(), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0).getCurrentLocation in class JsonParserpublic JsonLocation getTokenLocation()
JsonParserJsonParser.currentTokenLocation(), to be deprecated in later
 Jackson 2.x versions (and removed from Jackson 3.0).getTokenLocation in class JsonParserpublic boolean hasCurrentToken()
JsonParserparser.getCurrentToken() != null.hasCurrentToken in class JsonParserJsonParser.nextToken(); false otherwise (parser
   was just constructed, encountered end-of-input
   and returned null from JsonParser.nextToken(), or the token
   has been consumed)public boolean hasTokenId(int id)
JsonParser
  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.
hasTokenId in class JsonParserid - Token id to match (from (@link JsonTokenId})True if the parser current points to specified tokenpublic boolean hasToken(JsonToken t)
JsonParser
  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.
hasToken in class JsonParsert - Token to matchTrue if the parser current points to specified tokenpublic boolean isExpectedStartArrayToken()
JsonParserJsonToken.START_ARRAY) when start array is expected.
 For some specialized parsers this can return true for other cases
 as well; this is usually done to emulate arrays in cases underlying
 format is ambiguous (XML, for example, has no format-level difference
 between Objects and Arrays; it just has elements).
Default implementation is equivalent to:
currentToken() == JsonToken.START_ARRAYbut may be overridden by custom parser implementations.
isExpectedStartArrayToken in class JsonParserJsonToken.START_ARRAY);
   false if notpublic boolean isExpectedStartObjectToken()
JsonParserJsonParser.isExpectedStartArrayToken(), but checks whether stream
 currently points to JsonToken.START_OBJECT.isExpectedStartObjectToken in class JsonParserJsonToken.START_OBJECT);
   false if notpublic boolean isExpectedNumberIntToken()
JsonParserJsonParser.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.
isExpectedNumberIntToken in class JsonParserJsonToken.VALUE_NUMBER_INT);
   false if notpublic boolean isNaN()
              throws java.io.IOException
JsonParserJsonToken.VALUE_NUMBER_FLOAT.
 NOTE: roughly equivalent to calling !Double.isFinite()
 on value you would get from calling JsonParser.getDoubleValue().isNaN in class JsonParserTrue 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 numbersjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.String getText()
                         throws java.io.IOException
JsonParserJsonParser.nextToken(), or
 after encountering end-of-input), returns null.
 Method can be called for any token type.getText in class JsonParserJsonParser.nextToken() or other iteration methods)java.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic boolean hasTextCharacters()
JsonParserJsonParser.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.
hasTextCharacters in class JsonParserJsonParser.getTextCharacters(); false
   means that it may or may not existpublic char[] getTextCharacters()
                         throws java.io.IOException
JsonParserJsonParser.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:
JsonParser.getTextOffset()) to
   know the actual offset
  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).
getTextCharacters in class JsonParserjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic int getTextLength()
                  throws java.io.IOException
JsonParserJsonParser.getTextCharacters(), to know length
 of String stored in returned buffer.getTextLength in class JsonParserJsonParser.getTextCharacters() that are part of
   textual content of the current token.java.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic int getTextOffset()
                  throws java.io.IOException
JsonParserJsonParser.getTextCharacters(), to know offset
 of the first text content character within buffer.getTextOffset in class JsonParserJsonParser.getTextCharacters() that is part of
   textual content of the current token.java.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic int getText(java.io.Writer writer)
            throws java.io.IOException,
                   java.lang.UnsupportedOperationException
JsonParserwriter.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.getText in class JsonParserwriter - Writer to write textual content tojava.io.IOException - for low-level read issues or writes using passed
   writer, or
   JsonParseException for decoding problemsjava.lang.UnsupportedOperationExceptionpublic java.math.BigInteger getBigIntegerValue()
                                        throws java.io.IOException
JsonParserJsonToken.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.getBigIntegerValue in class JsonParserBigInteger (if numeric token);
     otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic boolean getBooleanValue()
                        throws java.io.IOException
JsonParserJsonToken.VALUE_TRUE or
 JsonToken.VALUE_FALSE, to return matching boolean
 value.
 If the current token is of some other type, JsonParseException
 will be throwngetBooleanValue in class JsonParserTrue if current token is JsonToken.VALUE_TRUE,
   false if current token is JsonToken.VALUE_FALSE;
   otherwise throws JsonParseExceptionjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic byte getByteValue()
                  throws java.io.IOException
JsonParserJsonToken.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.
getByteValue in class JsonParserbyte (if numeric token within
   range of [-128, 255]); otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic short getShortValue()
                    throws java.io.IOException
JsonParserJsonToken.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.
getShortValue in class JsonParsershort (if numeric token within
   Java 16-bit signed short range); otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.math.BigDecimal getDecimalValue()
                                     throws java.io.IOException
JsonParserJsonToken.VALUE_NUMBER_FLOAT or
 JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions
 are ever thrown.getDecimalValue in class JsonParserBigDecimal (if numeric token);
   otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic double getDoubleValue()
                      throws java.io.IOException
JsonParserJsonToken.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.
getDoubleValue in class JsonParserdouble (if numeric token within
   Java double range); otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic float getFloatValue()
                    throws java.io.IOException
JsonParserJsonToken.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.
getFloatValue in class JsonParserfloat (if numeric token within
   Java float range); otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic int getIntValue()
                throws java.io.IOException
JsonParserJsonToken.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.
getIntValue in class JsonParserint (if numeric token within
   Java 32-bit signed int range); otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic long getLongValue()
                  throws java.io.IOException
JsonParserJsonToken.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.
getLongValue in class JsonParserlong (if numeric token within
   Java 32-bit signed long range); otherwise exception thrownjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic JsonParser.NumberType getNumberType() throws java.io.IOException
JsonParserJsonToken.VALUE_NUMBER_INT or
 JsonToken.VALUE_NUMBER_FLOAT, returns
 one of JsonParser.NumberType constants; otherwise returns null.getNumberType in class JsonParsernull otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.Number getNumberValue()
                                throws java.io.IOException
JsonParsergetNumberValue in class JsonParserjava.io.IOException - Problem with access: JsonParseException if
    the current token is not numeric, or if decoding of the value fails
    (invalid format for numbers); plain IOException if underlying
    content read fails (possible if values are extracted lazily)public java.lang.Number getNumberValueExact()
                                     throws java.io.IOException
JsonParserJsonParser.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()
getNumberValueExact in class JsonParserjava.io.IOException - Problem with access: JsonParseException if
    the current token is not numeric, or if decoding of the value fails
    (invalid format for numbers); plain IOException if underlying
    content read fails (possible if values are extracted lazily)public int getValueAsInt()
                  throws java.io.IOException
JsonParserint 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.
getValueAsInt in class JsonParserint value current token is converted to, if possible; exception thrown
    otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic int getValueAsInt(int defaultValue)
                  throws java.io.IOException
JsonParserIf 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.
getValueAsInt in class JsonParserdefaultValue - Default value to return if conversion to int is not possibleint value current token is converted to, if possible; def otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic long getValueAsLong()
                    throws java.io.IOException
JsonParserIf 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.
getValueAsLong in class JsonParserlong value current token is converted to, if possible; exception thrown
    otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic long getValueAsLong(long defaultValue)
                    throws java.io.IOException
JsonParserIf 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.
getValueAsLong in class JsonParserdefaultValue - Default value to return if conversion to long is not possiblelong value current token is converted to, if possible; def otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic double getValueAsDouble()
                        throws java.io.IOException
JsonParserIf 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.
getValueAsDouble in class JsonParserdouble value current token is converted to, if possible; exception thrown
    otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic double getValueAsDouble(double defaultValue)
                        throws java.io.IOException
JsonParserIf representation can not be converted to a double (including structured types like Objects and Arrays), specified def will be returned; no exceptions are thrown.
getValueAsDouble in class JsonParserdefaultValue - Default value to return if conversion to double is not possibledouble value current token is converted to, if possible; def otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic boolean getValueAsBoolean()
                          throws java.io.IOException
JsonParserIf 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.
getValueAsBoolean in class JsonParserboolean value current token is converted to, if possible; exception thrown
    otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic boolean getValueAsBoolean(boolean defaultValue)
                          throws java.io.IOException
JsonParserIf 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.
getValueAsBoolean in class JsonParserdefaultValue - Default value to return if conversion to boolean is not possibleboolean value current token is converted to, if possible; def otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.String getValueAsString()
                                  throws java.io.IOException
JsonParserString.
 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.getValueAsString in class JsonParserString value current token is converted to, if possible; null otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.String getValueAsString(java.lang.String defaultValue)
                                  throws java.io.IOException
JsonParserString.
 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.getValueAsString in class JsonParserdefaultValue - Default value to return if conversion to String is not possibleString value current token is converted to, if possible; def otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.Object getEmbeddedObject()
                                   throws java.io.IOException
JsonParserJsonToken.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().
getEmbeddedObject in class JsonParsernull otherwisejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic byte[] getBinaryValue(Base64Variant b64variant) throws java.io.IOException
JsonParserJsonParser.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.
getBinaryValue in class JsonParserb64variant - Expected variant of base64 encoded
   content (see Base64Variants for definitions
   of "standard" variants).java.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic int readBinaryValue(Base64Variant b64variant, java.io.OutputStream out) throws java.io.IOException
JsonParserJsonParser.readBinaryValue(OutputStream) but allows explicitly
 specifying base64 variant to use.readBinaryValue in class JsonParserb64variant - base64 variant to useout - Output stream to use for passing decoded binary dataOutputStreamjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic JsonToken nextToken() throws java.io.IOException
JsonParsernextToken in class JsonParserjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic JsonToken nextValue() throws java.io.IOException
JsonParserJsonToken.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.nextValue in class JsonParserJsonToken.NOT_AVAILABLE if no tokens were
   available yet)java.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic void finishToken()
                 throws java.io.IOException
JsonParserJsonParser.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.
finishToken in class JsonParserjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic JsonParser skipChildren() throws java.io.IOException
JsonParserJsonToken.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.skipChildren in class JsonParserjava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic boolean canReadObjectId()
JsonParserDefault 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.
canReadObjectId in class JsonParserTrue if the format being read supports native Object Ids;
    false if notpublic boolean canReadTypeId()
JsonParserDefault 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.
canReadTypeId in class JsonParserTrue if the format being read supports native Type Ids;
    false if notpublic java.lang.Object getObjectId()
                             throws java.io.IOException
JsonParserJsonParser.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.
getObjectId in class JsonParsernull if nonejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic java.lang.Object getTypeId()
                           throws java.io.IOException
JsonParserJsonParser.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.
getTypeId in class JsonParsernull if nonejava.io.IOException - for low-level read issues, or
   JsonParseException for decoding problemspublic JsonParser delegate()
JsonParser this parser delegates calls to.Copyright © 2010 - 2023 Adobe. All Rights Reserved