JsonParser

Bit flag composed of bits that indicate which JsonParser.Features are enabled.

Method that can be used to verify that given schema can be used with this parser (using setSchema(FormatSchema)).

Method called to "consume" the current token by effectively removing it so that hasCurrentToken() returns false, and getCurrentToken() null). Cleared token value can still be accessed by calling 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).

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 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 java.io.File or java.net.URL and creates stream or reader it does own them.

Method for enabling or disabling specified feature (check JsonParser.Feature for list of features)

Method for disabling specified feature (check JsonParser.Feature for list of features)

Method for enabling specified parser feature (check JsonParser.Feature for list of features)

Numeric accessor that can be called when the current token is of type 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 VALUE_NUMBER_FLOAT; if so, it is equivalent to calling getDecimalValue() and then constructing a BigInteger from that value.

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

Convenience alternative to getBinaryValue(Base64Variant) that defaults to using getDefaultVariant() as the default encoding.

Convenience accessor that can be called when the current token is VALUE_TRUE or VALUE_FALSE.

Note: if the token is not of above-mentioned boolean types, an integer, but its value falls outside of range of Java long, a JsonParseException may be thrown to indicate numeric overflow/underflow.

Numeric accessor that can be called when the current token is of type VALUE_NUMBER_INT and it can be expressed as a value of Java byte primitive type. It can also be called for VALUE_NUMBER_FLOAT; if so, it is equivalent to calling getDoubleValue() and then casting; except for possible overflow/underflow exception.

Note: if the resulting integer value falls outside range of Java byte, a JsonParseException will be thrown to indicate numeric overflow/underflow.

Accessor for ObjectCodec associated with this parser, if any. Codec is used by readValueAs(Class) method (and its variants).

Method that returns location of the last processed character; usually for error reporting purposes.

Method that can be called to get the name associated with the current token: for FIELD_NAMEs it will be the same as what getText() returns; for field values it will be preceding field name; and for others (array values, root-level values) null.

Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.

Numeric accessor that can be called when the current token is of type VALUE_NUMBER_FLOAT or VALUE_NUMBER_INT. No under/overflow exceptions are ever thrown.

Numeric accessor that can be called when the current token is of type VALUE_NUMBER_FLOAT and it can be expressed as a Java double primitive type. It can also be called for VALUE_NUMBER_INT; if so, it is equivalent to calling getLongValue() and then casting; except for possible overflow/underflow exception.

Note: if the value falls outside of range of Java double, a JsonParseException will be thrown to indicate numeric overflow/underflow.

Accessor that can be called if (and only if) the current token is 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).

Numeric accessor that can be called when the current token is of type VALUE_NUMBER_FLOAT and it can be expressed as a Java float primitive type. It can also be called for VALUE_NUMBER_INT; if so, it is equivalent to calling getLongValue() and then casting; except for possible overflow/underflow exception.

Note: if the value falls outside of range of Java float, a JsonParseException will be thrown to indicate numeric overflow/underflow.

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.

Numeric accessor that can be called when the current token is of type VALUE_NUMBER_INT and it can be expressed as a value of Java int primitive type. It can also be called for VALUE_NUMBER_FLOAT; if so, it is equivalent to calling getDoubleValue() and then casting; except for possible overflow/underflow exception.

Note: if the resulting integer value falls outside range of Java int, a JsonParseException may be thrown to indicate numeric overflow/underflow.

Method that can be called to get the last token that was cleared using clearCurrentToken(). This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed.

Numeric accessor that can be called when the current token is of type VALUE_NUMBER_INT and it can be expressed as a Java long primitive type. It can also be called for VALUE_NUMBER_FLOAT; if so, it is equivalent to calling 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 JsonParseException may be thrown to indicate numeric overflow/underflow.

If current token is of type VALUE_NUMBER_INT or VALUE_NUMBER_FLOAT, returns one of JsonParser.NumberType constants; otherwise returns null.

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.

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.

Method for accessing Schema that this parser uses, if any. Default implementation returns null.

Numeric accessor that can be called when the current token is of type VALUE_NUMBER_INT and it can be expressed as a value of Java short primitive type. It can also be called for VALUE_NUMBER_FLOAT; if so, it is equivalent to calling getDoubleValue() and then casting; except for possible overflow/underflow exception.

Note: if the resulting integer value falls outside range of Java short, a JsonParseException will be thrown to indicate numeric overflow/underflow.

Method for accessing textual representation of the current token; if no current token (before first call to nextToken(), or after encountering end-of-input), returns null. Method can be called for any token type.

Method similar to 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 getTextOffset()) to know the actual offset
• Length of textual contents may be less than the length of returned buffer: call getTextLength() for actual length of returned content.

Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.

The only reason to call this method (over getText()) is to avoid construction of a String object (which will make a copy of contents).

Accessor used with getTextCharacters(), to know length of String stored in returned buffer.

Accessor used with getTextCharacters(), to know offset of the first text content character within buffer.

Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.

Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.

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

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.

Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language integer parsing rules.

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

Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language integer parsing rules.

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

Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

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

Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

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

Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

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

Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

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

Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check for parser.getCurrentToken() != null.

Method that can be used to determine whether calling of 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.

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 nextToken() (and the underlying stream may be closed). Closing may be due to an explicit call to close() or because parser has encountered end of input.

Method for checking whether specified JsonParser.Feature is enabled.

Specialized accessor that can be used to verify that the current token indicates start array (usually meaning that current token is START_ARRAY) when start array is expected. For some specialized parsers this can return true for other cases as well; this is usually done to emulate arrays.

Default implementation is equivalent to:

   getCurrentToken() == JsonToken.START_ARRAY

Method that fetches next token (as if calling nextToken()) and if it is VALUE_TRUE or VALUE_FALSE returns matching Boolean value; otherwise return null. It is functionally equivalent to:

  JsonToken t = nextToken();
  if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE;
  if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE;
  return null;

Method that fetches next token (as if calling nextToken()) and verifies whether it is FIELD_NAME with specified name and returns result of that comparison. It is functionally equivalent to:

  return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(getCurrentName());

Method that fetches next token (as if calling nextToken()) and if it is VALUE_NUMBER_INT returns 32-bit int value; otherwise returns specified default value It is functionally equivalent to:

  return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getIntValue() : defaultValue;

Method that fetches next token (as if calling nextToken()) and if it is VALUE_NUMBER_INT returns 64-bit long value; otherwise returns specified default value It is functionally equivalent to:

  return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getLongValue() : defaultValue;

Method that fetches next token (as if calling nextToken()) and if it is VALUE_STRING returns contained String value; otherwise returns null. It is functionally equivalent to:

  return (nextToken() == JsonToken.VALUE_STRING) ? getText() : null;

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.

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 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 getCurrentName() when parser points to the value.

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.

Similar to readBinaryValue(OutputStream) but allows explicitly specifying base64 variant to use.

Method that can be used as an alternative to getBigIntegerValue(), especially when value can be large. The main difference (beyond method of returning content using OutputStream instead of as byte array) is that content will NOT remain accessible after method returns: any content processed will be consumed and is not buffered in any way. If caller needs buffering, it has to implement it.

Method to deserialize JSON content into a Java type, reference to which is passed as argument. Type is passed using so-called "super type token" and specifically needs to be used if the root type is a parameterized (generic) container type. Note: method can only be called if the parser has an object codec assigned; this is true for parsers constructed by MappingJsonFactory (defined in 'jackson-databind' bundle) but not for JsonFactory (unless its setCodec method has been explicitly called).

This method may advance the event stream, for structured types the current token will be the closing end marker (END_ARRAY, END_OBJECT) of the bound structure. For non-structured Json types (and for VALUE_EMBEDDED_OBJECT) stream is not advanced.

Method to deserialize JSON content into a non-container type (it can be an array type, however): typically a bean, array or a wrapper type (like Boolean). Note: method can only be called if the parser has an object codec assigned; this is true for parsers constructed by MappingJsonFactory (from "jackson-databind" jar) but not for JsonFactory (unless its setCodec method has been explicitly called).

This method may advance the event stream, for structured types the current token will be the closing end marker (END_ARRAY, END_OBJECT) of the bound structure. For non-structured Json types (and for VALUE_EMBEDDED_OBJECT) stream is not advanced.

Note: this method should NOT be used if the result type is a container (java.util.Collection or java.util.Map. The reason is that due to type erasure, key and value types can not be introspected when using this method.

Method to deserialize JSON content into equivalent "tree model", represented by root TreeNode of resulting model. For JSON Arrays it will an array node (with child nodes), for objects object node (with child nodes), and for other types matching leaf node type

Method for reading sequence of Objects from parser stream, all with same specified value type.

Method for reading sequence of Objects from parser stream, all with same specified value type.

Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given writer if possible; if underlying input is char-based it can released, if not (byte-based) it can not.

Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given stream if possible; if underlying input is byte-based it can released, if not (char-based) it can not.

Setter that allows defining ObjectCodec associated with this parser, if any. Codec is used by readValueAs(Class) method (and its variants).

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.

Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to START_OBJECT or START_ARRAY. If not, it will do nothing. After skipping, stream will point to matching END_OBJECT or 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 nextToken() to point to the next available token, if any.

Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.

Helper method for constructing JsonParseExceptions based on current state of the parser

Helper method to call for operations that are not supported by parser implementation.