Jackson 3.0.1 · tools.jackson.core.TokenStreamContext

Modifier and Type	Field and Description
protected int	_index Index of the currently processed entry.
protected int	_nestingDepth The nesting depth is a count of objects and arrays that have not been closed, `{` and `[` respectively.
protected int	_type Indicates logical type of context as one of `TYPE_xxx` constants.
public static final int	TYPE_ARRAY Indicator for "Array" context.
public static final int	TYPE_OBJECT Indicator for "Object" context.
public static final int	TYPE_ROOT Indicator for "Root Value" context (has not parent)

Access	Constructor and Description
protected	TokenStreamContext()
protected	TokenStreamContext(TokenStreamContext Context instance to copy type and index from base) Copy constructor used by sub-classes for creating copies for buffering.
protected	TokenStreamContext(int type, int index)

Method Summary

Modifier and Type	Method and Description
public void	assignCurrentValue(Object Current value to assign to this context v) Method to call to pass value to be returned via `currentValue`; typically called indirectly through `JsonParser#assignCurrentValue` or `JsonGenerator#assignCurrentValue`).
public abstract String	Returns: Current property name within context, if any; `null` if none currentName() Method for accessing name associated with the current location.
public Object	Returns: Currently active value, if one has been assigned. currentValue() Method for accessing currently active value being used by data-binding (as the source of streaming data to write, or destination of data being read), at this level in hierarchy.
public final int	Returns: Index of the currently processed entry, if any getCurrentIndex()
public final int	Returns: Number of entries that are complete and started. getEntryCount()
public final int	Returns: Nesting depth getNestingDepth() The nesting depth is a count of objects and arrays that have not been closed, `{` and `[` respectively.
public abstract TokenStreamContext	Returns: Parent context of this context, if any; `null` for Root contexts getParent() Accessor for finding parent context of this context; will return null for root context.
public boolean	Returns: `True` if this context has value index to access, `false` otherwise hasCurrentIndex() Method that may be called to verify whether this context has valid index: will return `false` before the first entry of Object context or before first element of Array context; otherwise returns `true`.
public boolean	hasCurrentName()
public boolean	Returns: `True` if this context has value path segment to access, `false` otherwise hasPathSegment() Method that may be called to check if this context is either: Object, with at least one entry written (partially or completely) Array, with at least one entry written (partially or completely)
public final boolean	Returns: `True` if this context represents an Array; `false` otherwise inArray() Method that returns true if this context is an Array context; that is, content is being read from or written to a JSON Array.
public final boolean	Returns: `True` if this context represents an Object; `false` otherwise inObject() Method that returns true if this context is an Object context; that is, content is being read from or written to a JSON Object.
public final boolean	Returns: `True` if this context represents a sequence of Root values; `false` otherwise inRoot() Method that returns true if this context is a Root context; that is, content is being read from or written to without enclosing array or object structure.
public JsonPointer	Returns: Pointer instance constructed pathAsPointer() Factory method for constructing a `JsonPointer` that points to the current location within the stream that this context is for, excluding information about "root context" (only relevant for multi-root-value cases)
public JsonPointer	Returns: Pointer instance constructed pathAsPointer(boolean Whether root-value offset is included as the first segment or not includeRoot) Factory method for constructing a `JsonPointer` that points to the current location within the stream that this context is for, optionally including "root value index"
public TokenStreamLocation	Returns: Location pointing to the point where the context start marker was found (or written); never `null`. startLocation(ContentReference Source reference needed to construct location instance srcRef) Optional method that may be used to access starting location of this context: for example, in case of JSON `Object` context, offset at which `[` token was read or written.
public String	Returns: Simple developer-readable description this context layer (note: NOT constructed with parents, unlike `pathAsPointer`) toString() Overrides java.lang.Object.toString. Overridden to provide developer readable "JsonPath" representation of the context.
public String	Returns: Type description String typeDesc() Method for accessing simple type description of current context; either ROOT (for root-level values), OBJECT (for Object property names and values) or ARRAY (for elements of JSON Arrays)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

_index	back to summary
protected int _index Index of the currently processed entry. Starts with -1 to signal that no entries have been started, and gets advanced each time a new entry is started, either by encountering an expected separator, or with new values if no separators are expected (the case for root context).

_nestingDepth	back to summary
protected int _nestingDepth The nesting depth is a count of objects and arrays that have not been closed, `{` and `[` respectively. Since 2.15

_type	back to summary
protected int _type Indicates logical type of context as one of `TYPE_xxx` constants.

TYPE_ARRAY	back to summary
public static final int TYPE_ARRAY Indicator for "Array" context.

TYPE_OBJECT	back to summary
public static final int TYPE_OBJECT Indicator for "Object" context.

TYPE_ROOT	back to summary
public static final int TYPE_ROOT Indicator for "Root Value" context (has not parent)

TokenStreamContext	back to summary
protected TokenStreamContext()

TokenStreamContext	back to summary
protected TokenStreamContext(TokenStreamContext base) Copy constructor used by sub-classes for creating copies for buffering. Parameters base:TokenStreamContext Context instance to copy type and index from

TokenStreamContext	back to summary
protected TokenStreamContext(int type, int index)

Method Detail

assignCurrentValue back to summary

assignCurrentValue	back to summary
public void assignCurrentValue(Object v) Method to call to pass value to be returned via `currentValue`; typically called indirectly through `JsonParser#assignCurrentValue` or `JsonGenerator#assignCurrentValue`). Parameters v:Object Current value to assign to this context

public void assignCurrentValue(Object v)

Method to call to pass value to be returned via currentValue; typically called indirectly through JsonParser#assignCurrentValue or JsonGenerator#assignCurrentValue).

Parameters

v:Object: Current value to assign to this context

currentName back to summary

currentName	back to summary
public abstract String currentName() Method for accessing name associated with the current location. Non-null for `PROPERTY_NAME` and value events that directly follow Property names; null for root level and array values. Returns:String Current property name within context, if any; `null` if none

public abstract String currentName()

Method for accessing name associated with the current location. Non-null for PROPERTY_NAME and value events that directly follow Property names; null for root level and array values.

Returns:String: Current property name within context, if any; null if none

currentValue	back to summary
public Object currentValue() Method for accessing currently active value being used by data-binding (as the source of streaming data to write, or destination of data being read), at this level in hierarchy. Note that "current value" is NOT populated (or used) by Streaming parser or generator; 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. Returns:Object Currently active value, if one has been assigned.

currentValue

back to summary

public Object currentValue()

Method for accessing currently active value being used by data-binding (as the source of streaming data to write, or destination of data being read), at this level in hierarchy.

Note that "current value" is NOT populated (or used) by Streaming parser or generator; 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.

Returns:Object: Currently active value, if one has been assigned.

getCurrentIndex	back to summary
public final int getCurrentIndex() Returns:int Index of the currently processed entry, if any

getEntryCount	back to summary
public final int getEntryCount() Returns:int Number of entries that are complete and started.

getNestingDepth	back to summary
public final int getNestingDepth() The nesting depth is a count of objects and arrays that have not been closed, `{` and `[` respectively. Returns:int Nesting depth Since 2.15

getNestingDepth

back to summary

public final int getNestingDepth()

The nesting depth is a count of objects and arrays that have not been closed, `{` and `[` respectively.

Returns:int: Nesting depth
Since: 2.15

getParent back to summary

getParent	back to summary
public abstract TokenStreamContext getParent() Accessor for finding parent context of this context; will return null for root context. Returns:TokenStreamContext Parent context of this context, if any; `null` for Root contexts

public abstract TokenStreamContext getParent()

Accessor for finding parent context of this context; will return null for root context.

Returns:TokenStreamContext: Parent context of this context, if any; null for Root contexts

hasCurrentIndex back to summary

hasCurrentIndex	back to summary
public boolean hasCurrentIndex() Method that may be called to verify whether this context has valid index: will return `false` before the first entry of Object context or before first element of Array context; otherwise returns `true`. Returns:boolean `True` if this context has value index to access, `false` otherwise

public boolean hasCurrentIndex()

Method that may be called to verify whether this context has valid index: will return `false` before the first entry of Object context or before first element of Array context; otherwise returns `true`.

Returns:boolean: True if this context has value index to access, false otherwise

hasCurrentName	back to summary
public boolean hasCurrentName()

hasPathSegment back to summary

hasPathSegment	back to summary
public boolean hasPathSegment() Method that may be called to check if this context is either: Object, with at least one entry written (partially or completely) Array, with at least one entry written (partially or completely) and if so, return `true`; otherwise return `false`. Latter case includes Root context (always), and Object/Array contexts before any entries/elements have been read or written. Method is mostly used to determine whether this context should be used for constructing `JsonPointer` Returns:boolean `True` if this context has value path segment to access, `false` otherwise

public boolean hasPathSegment()

Method that may be called to check if this context is either:

Object, with at least one entry written (partially or completely)
Array, with at least one entry written (partially or completely)

and if so, return `true`; otherwise return `false`. Latter case includes Root context (always), and Object/Array contexts before any entries/elements have been read or written.

Method is mostly used to determine whether this context should be used for constructing JsonPointer

Returns:boolean: True if this context has value path segment to access, false otherwise

inArray back to summary

inArray	back to summary
public final boolean inArray() Method that returns true if this context is an Array context; that is, content is being read from or written to a JSON Array. Returns:boolean `True` if this context represents an Array; `false` otherwise

public final boolean inArray()

Method that returns true if this context is an Array context; that is, content is being read from or written to a JSON Array.

Returns:boolean: True if this context represents an Array; false otherwise

inObject back to summary

inObject	back to summary
public final boolean inObject() Method that returns true if this context is an Object context; that is, content is being read from or written to a JSON Object. Returns:boolean `True` if this context represents an Object; `false` otherwise

public final boolean inObject()

Method that returns true if this context is an Object context; that is, content is being read from or written to a JSON Object.

Returns:boolean: True if this context represents an Object; false otherwise

inRoot back to summary

inRoot	back to summary
public final boolean inRoot() Method that returns true if this context is a Root context; that is, content is being read from or written to without enclosing array or object structure. Returns:boolean `True` if this context represents a sequence of Root values; `false` otherwise

public final boolean inRoot()

Method that returns true if this context is a Root context; that is, content is being read from or written to without enclosing array or object structure.

Returns:boolean: True if this context represents a sequence of Root values; false otherwise

pathAsPointer back to summary

pathAsPointer	back to summary
public JsonPointer pathAsPointer() Factory method for constructing a `JsonPointer` that points to the current location within the stream that this context is for, excluding information about "root context" (only relevant for multi-root-value cases) Returns:JsonPointer Pointer instance constructed

public JsonPointer pathAsPointer()

Factory method for constructing a JsonPointer that points to the current location within the stream that this context is for, excluding information about "root context" (only relevant for multi-root-value cases)

Returns:JsonPointer: Pointer instance constructed

pathAsPointer back to summary

pathAsPointer	back to summary
public JsonPointer pathAsPointer(boolean includeRoot) Factory method for constructing a `JsonPointer` that points to the current location within the stream that this context is for, optionally including "root value index" Parameters includeRoot:boolean Whether root-value offset is included as the first segment or not Returns:JsonPointer Pointer instance constructed

public JsonPointer pathAsPointer(boolean includeRoot)

Factory method for constructing a JsonPointer that points to the current location within the stream that this context is for, optionally including "root value index"

Parameters

includeRoot:boolean: Whether root-value offset is included as the first segment or not

Returns:JsonPointer

Pointer instance constructed

startLocation back to summary

startLocation	back to summary
public TokenStreamLocation startLocation(ContentReference srcRef) Optional method that may be used to access starting location of this context: for example, in case of JSON `Object` context, offset at which `[` token was read or written. Often used for error reporting purposes. Implementations that do not keep track of such location are expected to return `TokenStreamLocation#NA`; this is what the default implementation does. Parameters srcRef:ContentReference Source reference needed to construct location instance Returns:TokenStreamLocation Location pointing to the point where the context start marker was found (or written); never `null`.

public TokenStreamLocation startLocation(ContentReference srcRef)

Optional method that may be used to access starting location of this context: for example, in case of JSON `Object` context, offset at which `[` token was read or written. Often used for error reporting purposes. Implementations that do not keep track of such location are expected to return TokenStreamLocation#NA; this is what the default implementation does.

Parameters

srcRef:ContentReference: Source reference needed to construct location instance

Returns:TokenStreamLocation

Location pointing to the point where the context start marker was found (or written); never null.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Overridden to provide developer readable "JsonPath" representation of the context. Returns:String Simple developer-readable description this context layer (note: NOT constructed with parents, unlike `pathAsPointer`) Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Overridden to provide developer readable "JsonPath" representation of the context.

Returns:String

Simple developer-readable description this context layer (note: NOT constructed with parents, unlike pathAsPointer)

Annotations

@Override

typeDesc	back to summary
public String typeDesc() Method for accessing simple type description of current context; either ROOT (for root-level values), OBJECT (for Object property names and values) or ARRAY (for elements of JSON Arrays) Returns:String Type description String

typeDesc

back to summary

public String typeDesc()

Method for accessing simple type description of current context; either ROOT (for root-level values), OBJECT (for Object property names and values) or ARRAY (for elements of JSON Arrays)

Returns:String: Type description String

public abstract Class TokenStreamContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail