Jackson-core 2.16.0 · com.fasterxml.jackson.core.JsonToken

Field Summary

Modifier and Type	Field and Description
pack-priv final int	_id
pack-priv final boolean	_isBoolean
pack-priv final boolean	_isNumber
pack-priv final boolean	_isScalar
pack-priv final boolean	_isStructEnd
pack-priv final boolean	_isStructStart
pack-priv final String	_serialized
pack-priv final byte[]	_serializedBytes
pack-priv final char[]	_serializedChars
public static final JsonToken	END_ARRAY END_ARRAY is returned when encountering ']' which signals ending of an Array value
public static final JsonToken	END_OBJECT END_OBJECT is returned when encountering '}' which signals ending of an Object value
public static final JsonToken	FIELD_NAME FIELD_NAME is returned when a String token is encountered as a field name (same lexical value, different function)
public static final JsonToken	NOT_AVAILABLE NOT_AVAILABLE can be returned if `JsonParser` implementation can not currently return the requested token (usually next one), or even if any will be available, but that may be able to determine this in future.
public static final JsonToken	START_ARRAY START_ARRAY is returned when encountering '[' which signals starting of an Array value
public static final JsonToken	START_OBJECT START_OBJECT is returned when encountering '{' which signals starting of an Object value.
public static final JsonToken	VALUE_EMBEDDED_OBJECT Placeholder token returned when the input source has a concept of embedded Object that are not accessible as usual structure (of starting with `START_OBJECT`, having values, ending with `END_OBJECT`), but as "raw" objects.
public static final JsonToken	VALUE_FALSE VALUE_FALSE is returned when encountering literal "false" in value context
public static final JsonToken	VALUE_NULL VALUE_NULL is returned when encountering literal "null" in value context
public static final JsonToken	VALUE_NUMBER_FLOAT VALUE_NUMBER_FLOAT is returned when a numeric token other than integer is encountered: that is, a number that does have floating point or exponent marker in it, in addition to one or more digits (or, for non-textual formats, has internal floating-point representation).
public static final JsonToken	VALUE_NUMBER_INT VALUE_NUMBER_INT is returned when an integer numeric token is encountered in value context: that is, a number that does not have floating point or exponent marker in it (consists only of an optional sign, followed by one or more digits; or, for binary formats, is indicated as integral number by internal representation).
public static final JsonToken	VALUE_STRING VALUE_STRING is returned when a String token is encountered in value context (array element, field value, or root-level stand-alone value)
public static final JsonToken	VALUE_TRUE VALUE_TRUE is returned when encountering literal "true" in value context

Access	Constructor and Description
private	JsonToken(String representation for this token, if there is a single static representation; null otherwise token, int Numeric id from `JsonTokenId` id)

Method Summary

Modifier and Type	Method and Description
public final byte[]	asByteArray()
public final char[]	asCharArray()
public final String	asString()
public final int	id()
public final boolean	Returns: `True` if this token is `VALUE_TRUE` or `VALUE_FALSE`, `false` otherwise isBoolean()
public final boolean	Returns: `True` if this token is `VALUE_NUMBER_INT` or `VALUE_NUMBER_FLOAT`, `false` otherwise isNumeric()
public final boolean	Returns: `True` if this token is a scalar value token (one of `VALUE_xxx` tokens), `false` otherwise isScalarValue() Method that can be used to check whether this token represents a valid non-structured value.
public final boolean	Returns: `True` if this token is `END_OBJECT` or `END_ARRAY`, `false` otherwise isStructEnd() Accessor that is functionally equivalent to: `this == JsonToken.END_OBJECT \|\| this == JsonToken.END_ARRAY`
public final boolean	Returns: `True` if this token is `START_OBJECT` or `START_ARRAY`, `false` otherwise isStructStart() Accessor that is functionally equivalent to: `this == JsonToken.START_OBJECT \|\| this == JsonToken.START_ARRAY`
public static String	Returns: String description of given token valueDescFor(JsonToken Token to get description for t) Helper method for constructing description like "Object value" given `JsonToken` encountered.
public static JsonToken	valueOf(String name)
public static JsonToken[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

_id	back to summary
pack-priv final int _id

_isBoolean	back to summary
pack-priv final boolean _isBoolean

_isNumber	back to summary
pack-priv final boolean _isNumber

_isScalar	back to summary
pack-priv final boolean _isScalar

_isStructEnd	back to summary
pack-priv final boolean _isStructEnd

_isStructStart	back to summary
pack-priv final boolean _isStructStart

_serialized	back to summary
pack-priv final String _serialized

_serializedBytes	back to summary
pack-priv final byte[] _serializedBytes

_serializedChars	back to summary
pack-priv final char[] _serializedChars

END_ARRAY	back to summary
public static final JsonToken END_ARRAY END_ARRAY is returned when encountering ']' which signals ending of an Array value

END_OBJECT	back to summary
public static final JsonToken END_OBJECT END_OBJECT is returned when encountering '}' which signals ending of an Object value

FIELD_NAME	back to summary
public static final JsonToken FIELD_NAME FIELD_NAME is returned when a String token is encountered as a field name (same lexical value, different function)

NOT_AVAILABLE	back to summary
public static final JsonToken NOT_AVAILABLE NOT_AVAILABLE can be returned if `JsonParser` implementation can not currently return the requested token (usually next one), or even if any will be available, but that may be able to determine this in future. This is the case with non-blocking parsers -- they can not block to wait for more data to parse and must return something.

START_ARRAY	back to summary
public static final JsonToken START_ARRAY START_ARRAY is returned when encountering '[' which signals starting of an Array value

START_OBJECT	back to summary
public static final JsonToken START_OBJECT START_OBJECT is returned when encountering '{' which signals starting of an Object value.

VALUE_EMBEDDED_OBJECT back to summary

VALUE_EMBEDDED_OBJECT	back to summary
public static final JsonToken VALUE_EMBEDDED_OBJECT Placeholder token returned when the input source has a concept of embedded Object that are not accessible as usual structure (of starting with `START_OBJECT`, having values, ending with `END_OBJECT`), but as "raw" objects. Note this token is never returned by regular JSON readers, but only by readers that expose other kinds of source (like `JsonNode`-based JSON trees, Maps, Lists and such).

public static final JsonToken VALUE_EMBEDDED_OBJECT

Placeholder token returned when the input source has a concept of embedded Object that are not accessible as usual structure (of starting with START_OBJECT, having values, ending with END_OBJECT), but as "raw" objects.

Note

this token is never returned by regular JSON readers, but only by readers that expose other kinds of source (like JsonNode-based JSON trees, Maps, Lists and such).

VALUE_FALSE	back to summary
public static final JsonToken VALUE_FALSE VALUE_FALSE is returned when encountering literal "false" in value context

VALUE_NULL	back to summary
public static final JsonToken VALUE_NULL VALUE_NULL is returned when encountering literal "null" in value context

VALUE_NUMBER_FLOAT	back to summary
public static final JsonToken VALUE_NUMBER_FLOAT VALUE_NUMBER_FLOAT is returned when a numeric token other than integer is encountered: that is, a number that does have floating point or exponent marker in it, in addition to one or more digits (or, for non-textual formats, has internal floating-point representation).

VALUE_NUMBER_INT	back to summary
public static final JsonToken VALUE_NUMBER_INT VALUE_NUMBER_INT is returned when an integer numeric token is encountered in value context: that is, a number that does not have floating point or exponent marker in it (consists only of an optional sign, followed by one or more digits; or, for binary formats, is indicated as integral number by internal representation).

VALUE_STRING	back to summary
public static final JsonToken VALUE_STRING VALUE_STRING is returned when a String token is encountered in value context (array element, field value, or root-level stand-alone value)

VALUE_TRUE	back to summary
public static final JsonToken VALUE_TRUE VALUE_TRUE is returned when encountering literal "true" in value context

Constructor Detail

JsonToken	back to summary
private JsonToken(String token, int id) Parameters token:String representation for this token, if there is a single static representation; null otherwise id:int Numeric id from `JsonTokenId`

Method Detail

asByteArray	back to summary
public final byte[] asByteArray()

asCharArray	back to summary
public final char[] asCharArray()

asString	back to summary
public final String asString()

id	back to summary
public final int id()

isBoolean	back to summary
public final boolean isBoolean() Returns:boolean `True` if this token is `VALUE_TRUE` or `VALUE_FALSE`, `false` otherwise

isNumeric	back to summary
public final boolean isNumeric() Returns:boolean `True` if this token is `VALUE_NUMBER_INT` or `VALUE_NUMBER_FLOAT`, `false` otherwise

isScalarValue back to summary

isScalarValue	back to summary
public final boolean isScalarValue() Method that can be used to check whether this token represents a valid non-structured value. This means all `VALUE_xxx` tokens; excluding `START_xxx` and `END_xxx` tokens as well `FIELD_NAME`. Returns:boolean `True` if this token is a scalar value token (one of `VALUE_xxx` tokens), `false` otherwise

public final boolean isScalarValue()

Method that can be used to check whether this token represents a valid non-structured value. This means all VALUE_xxx tokens; excluding START_xxx and END_xxx tokens as well FIELD_NAME.

Returns:boolean: True if this token is a scalar value token (one of VALUE_xxx tokens), false otherwise

isStructEnd back to summary

isStructEnd	back to summary
public final boolean isStructEnd() Accessor that is functionally equivalent to: `this == JsonToken.END_OBJECT \|\| this == JsonToken.END_ARRAY` Returns:boolean `True` if this token is `END_OBJECT` or `END_ARRAY`, `false` otherwise Since 2.3

public final boolean isStructEnd()

Accessor that is functionally equivalent to: this == JsonToken.END_OBJECT || this == JsonToken.END_ARRAY

Returns:boolean: True if this token is END_OBJECT or END_ARRAY, false otherwise
Since: 2.3

isStructStart back to summary

isStructStart	back to summary
public final boolean isStructStart() Accessor that is functionally equivalent to: `this == JsonToken.START_OBJECT \|\| this == JsonToken.START_ARRAY` Returns:boolean `True` if this token is `START_OBJECT` or `START_ARRAY`, `false` otherwise Since 2.3

public final boolean isStructStart()

Accessor that is functionally equivalent to: this == JsonToken.START_OBJECT || this == JsonToken.START_ARRAY

Returns:boolean: True if this token is START_OBJECT or START_ARRAY, false otherwise
Since: 2.3

valueDescFor back to summary

valueDescFor	back to summary
public static String valueDescFor(JsonToken t) Helper method for constructing description like "Object value" given `JsonToken` encountered. Parameters t:JsonToken Token to get description for Returns:String String description of given token Since 2.16

public static String valueDescFor(JsonToken t)

Helper method for constructing description like "Object value" given JsonToken encountered.

Parameters

t:JsonToken: Token to get description for

Returns:String

String description of given token

Since

2.16

valueOf	back to summary
public static JsonToken valueOf(String name)

values	back to summary
public static JsonToken[] values()

public final Enum JsonToken

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail