Top Description Inners Fields Constructors Methods

com.fasterxml.jackson.databind.node

pack-priv abstract Class NodeCursor

Class Inheritance

java.lang.Object
com.fasterxml.jackson.core.JsonStreamContext
com.fasterxml.jackson.databind.node.NodeCursor

Known Direct Subclasses

com.fasterxml.jackson.databind.node.NodeCursor.RootCursor, com.fasterxml.jackson.databind.node.NodeCursor.ArrayCursor, com.fasterxml.jackson.databind.node.NodeCursor.ObjectCursor

Imports

java.util.*, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.JsonNode

Helper class used by TreeTraversingParser to keep track of current location within traversed JSON tree.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static class	NodeCursor.ArrayCursor
protected static class	NodeCursor.ObjectCursor
protected static class	NodeCursor.RootCursor Context for all root-level value nodes (including Arrays and Objects): only context for scalar values.

Field Summary

Modifier and Type	Field and Description
protected String	_currentName Current field name
protected Object	_currentValue
protected final NodeCursor	_parent Parent cursor of this cursor, if any; null for root cursors.

Inherited from com.fasterxml.jackson.core.JsonStreamContext:: _index _nestingDepth _type TYPE_ARRAY TYPE_OBJECT TYPE_ROOT

Constructor Summary

Access	Constructor and Description
public	NodeCursor(int contextType, NodeCursor p)

Method Summary

Modifier and Type	Method and Description
public abstract JsonNode	currentNode()
public final String	getCurrentName() Implements abstract com.fasterxml.jackson.core.JsonStreamContext.getCurrentName. Method for accessing name associated with the current location.
public Object	getCurrentValue() Overrides com.fasterxml.jackson.core.JsonStreamContext.getCurrentValue. 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 NodeCursor	getParent() Implements abstract com.fasterxml.jackson.core.JsonStreamContext.getParent. Accessor for finding parent context of this context; will return null for root context.
public final NodeCursor	iterateChildren() Method called to create a new context for iterating all contents of the current structured value (JSON array or object)
public abstract JsonToken	nextToken()
public void	overrideCurrentName(String name)
public void	setCurrentValue(Object Current value to assign to this context v) Overrides com.fasterxml.jackson.core.JsonStreamContext.setCurrentValue. Method to call to pass value to be returned via `getCurrentValue`; typically called indirectly through `JsonParser#setCurrentValue` or `JsonGenerator#setCurrentValue`).
public abstract NodeCursor	startArray()
public abstract NodeCursor	startObject()

Inherited from com.fasterxml.jackson.core.JsonStreamContext:: getCurrentIndex getEntryCount getNestingDepth getStartLocation getTypeDesc hasCurrentIndex hasCurrentName hasPathSegment inArray inObject inRoot pathAsPointer pathAsPointer startLocation toString typeDesc

Field Detail

_currentName	back to summary
protected String _currentName Current field name

_currentValue	back to summary
protected Object _currentValue Since 2.5

_parent	back to summary
protected final NodeCursor _parent Parent cursor of this cursor, if any; null for root cursors.

Constructor Detail

NodeCursor	back to summary
public NodeCursor(int contextType, NodeCursor p)

Method Detail

currentNode	back to summary
public abstract JsonNode currentNode()

getCurrentName back to summary

getCurrentName	back to summary
public final String getCurrentName() Implements abstract com.fasterxml.jackson.core.JsonStreamContext.getCurrentName. Doc from com.fasterxml.jackson.core.JsonStreamContext.getCurrentName. Method for accessing name associated with the current location. Non-null for `FIELD_NAME` and value events that directly follow field names; null for root level and array values. Returns:String Current field name within context, if any; `null` if none Annotations @Override

public final String getCurrentName()

Implements abstract com.fasterxml.jackson.core.JsonStreamContext.getCurrentName.

Doc from com.fasterxml.jackson.core.JsonStreamContext.getCurrentName.

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

Returns:String

Current field name within context, if any; null if none

Annotations

@Override

getCurrentValue	back to summary
public Object getCurrentValue() Overrides com.fasterxml.jackson.core.JsonStreamContext.getCurrentValue. Doc from com.fasterxml.jackson.core.JsonStreamContext.getCurrentValue. 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. Annotations @Override

getCurrentValue

back to summary

public Object getCurrentValue()

Overrides com.fasterxml.jackson.core.JsonStreamContext.getCurrentValue.

Doc from com.fasterxml.jackson.core.JsonStreamContext.getCurrentValue.

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.

Annotations

@Override

getParent back to summary

getParent	back to summary
public final NodeCursor getParent() Implements abstract com.fasterxml.jackson.core.JsonStreamContext.getParent. Doc from com.fasterxml.jackson.core.JsonStreamContext.getParent. Accessor for finding parent context of this context; will return null for root context. Returns:NodeCursor Parent context of this context, if any; `null` for Root contexts Annotations @Override

public final NodeCursor getParent()

Implements abstract com.fasterxml.jackson.core.JsonStreamContext.getParent.

Doc from com.fasterxml.jackson.core.JsonStreamContext.getParent.

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

Returns:NodeCursor

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

Annotations

@Override

iterateChildren	back to summary
public final NodeCursor iterateChildren() Method called to create a new context for iterating all contents of the current structured value (JSON array or object)

nextToken	back to summary
public abstract JsonToken nextToken()

overrideCurrentName	back to summary
public void overrideCurrentName(String name) Since 2.0

setCurrentValue back to summary

setCurrentValue	back to summary
public void setCurrentValue(Object v) Overrides com.fasterxml.jackson.core.JsonStreamContext.setCurrentValue. Doc from com.fasterxml.jackson.core.JsonStreamContext.setCurrentValue. Method to call to pass value to be returned via `getCurrentValue`; typically called indirectly through `JsonParser#setCurrentValue` or `JsonGenerator#setCurrentValue`). Parameters v:Object Current value to assign to this context Annotations @Override

public void setCurrentValue(Object v)

Overrides com.fasterxml.jackson.core.JsonStreamContext.setCurrentValue.

Doc from com.fasterxml.jackson.core.JsonStreamContext.setCurrentValue.

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

Parameters

v:Object: Current value to assign to this context

Annotations

@Override

startArray	back to summary
public abstract NodeCursor startArray()

startObject	back to summary
public abstract NodeCursor startObject()

com.fasterxml.jackson.databind.node back to summary

protected final Class NodeCursor.ArrayCursor

Class Inheritance

extends NodeCursor

java.lang.Object
com.fasterxml.jackson.core.JsonStreamContext
com.fasterxml.jackson.databind.node.NodeCursor
com.fasterxml.jackson.databind.node.NodeCursor.ArrayCursor

Field Summary

Modifier and Type	Field and Description
protected Iterator<JsonNode>	_contents
protected JsonNode	_currentElement

Inherited from com.fasterxml.jackson.databind.node.NodeCursor:: _currentName _currentValue _parent

Constructor Summary

Access	Constructor and Description
public	ArrayCursor(JsonNode n, NodeCursor p)

Method Summary

Modifier and Type	Method and Description
public JsonNode	currentNode() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode.
public JsonToken	nextToken() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken.
public NodeCursor	startArray() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startArray.
public NodeCursor	startObject() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startObject.

Inherited from com.fasterxml.jackson.databind.node.NodeCursor:: getCurrentName getCurrentValue getParent iterateChildren overrideCurrentName setCurrentValue

Field Detail

_contents	back to summary
protected Iterator<JsonNode> _contents

_currentElement	back to summary
protected JsonNode _currentElement

Constructor Detail

ArrayCursor	back to summary
public ArrayCursor(JsonNode n, NodeCursor p)

Method Detail

currentNode	back to summary
public JsonNode currentNode() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode. Annotations @Override

currentNode

back to summary

public JsonNode currentNode()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode.

Annotations

@Override

nextToken	back to summary
public JsonToken nextToken() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken. Annotations @Override

nextToken

back to summary

public JsonToken nextToken()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken.

Annotations

@Override

startArray	back to summary
public NodeCursor startArray() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startArray. Annotations @Override

startArray

back to summary

public NodeCursor startArray()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startArray.

Annotations

@Override

startObject	back to summary
public NodeCursor startObject() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startObject. Annotations @Override

startObject

back to summary

public NodeCursor startObject()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startObject.

Annotations

@Override

com.fasterxml.jackson.databind.node back to summary

protected final Class NodeCursor.ObjectCursor

Class Inheritance

extends NodeCursor

java.lang.Object
com.fasterxml.jackson.core.JsonStreamContext
com.fasterxml.jackson.databind.node.NodeCursor
com.fasterxml.jackson.databind.node.NodeCursor.ObjectCursor

Field Summary

Modifier and Type	Field and Description
protected Iterator<Map.Entry<String, JsonNode>>	_contents
protected Map.Entry<String, JsonNode>	_current
protected boolean	_needEntry

Inherited from com.fasterxml.jackson.databind.node.NodeCursor:: _currentName _currentValue _parent

Constructor Summary

Access	Constructor and Description
public	ObjectCursor(JsonNode n, NodeCursor p)

Method Summary

Modifier and Type	Method and Description
public JsonNode	currentNode() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode.
public JsonToken	nextToken() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken.
public NodeCursor	startArray() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startArray.
public NodeCursor	startObject() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startObject.

Inherited from com.fasterxml.jackson.databind.node.NodeCursor:: getCurrentName getCurrentValue getParent iterateChildren overrideCurrentName setCurrentValue

Field Detail

_contents	back to summary
protected Iterator<Map.Entry<String, JsonNode>> _contents

_current	back to summary
protected Map.Entry<String, JsonNode> _current

_needEntry	back to summary
protected boolean _needEntry

Constructor Detail

ObjectCursor	back to summary
public ObjectCursor(JsonNode n, NodeCursor p)

Method Detail

currentNode	back to summary
public JsonNode currentNode() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode. Annotations @Override

currentNode

back to summary

public JsonNode currentNode()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode.

Annotations

@Override

nextToken	back to summary
public JsonToken nextToken() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken. Annotations @Override

nextToken

back to summary

public JsonToken nextToken()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken.

Annotations

@Override

startArray	back to summary
public NodeCursor startArray() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startArray. Annotations @Override

startArray

back to summary

public NodeCursor startArray()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startArray.

Annotations

@Override

startObject	back to summary
public NodeCursor startObject() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startObject. Annotations @Override

startObject

back to summary

public NodeCursor startObject()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startObject.

Annotations

@Override

com.fasterxml.jackson.databind.node back to summary

protected final Class NodeCursor.RootCursor

Class Inheritance

extends NodeCursor

java.lang.Object
com.fasterxml.jackson.core.JsonStreamContext
com.fasterxml.jackson.databind.node.NodeCursor
com.fasterxml.jackson.databind.node.NodeCursor.RootCursor

Context for all root-level value nodes (including Arrays and Objects): only context for scalar values.

Field Summary

Modifier and Type	Field and Description
protected boolean	_done
protected JsonNode	_node

Inherited from com.fasterxml.jackson.databind.node.NodeCursor:: _currentName _currentValue _parent

Constructor Summary

Access	Constructor and Description
public	RootCursor(JsonNode n, NodeCursor p)

Method Summary

Modifier and Type	Method and Description
public JsonNode	currentNode() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode.
public JsonToken	nextToken() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken.
public void	overrideCurrentName(String name) Overrides com.fasterxml.jackson.databind.node.NodeCursor.overrideCurrentName.
public NodeCursor	startArray() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startArray.
public NodeCursor	startObject() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.startObject.

Inherited from com.fasterxml.jackson.databind.node.NodeCursor:: getCurrentName getCurrentValue getParent iterateChildren setCurrentValue

Field Detail

_done	back to summary
protected boolean _done

_node	back to summary
protected JsonNode _node

Constructor Detail

RootCursor	back to summary
public RootCursor(JsonNode n, NodeCursor p)

Method Detail

currentNode	back to summary
public JsonNode currentNode() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode. Annotations @Override

currentNode

back to summary

public JsonNode currentNode()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.currentNode.

Annotations

@Override

nextToken	back to summary
public JsonToken nextToken() Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken. Annotations @Override

nextToken

back to summary

public JsonToken nextToken()

Implements abstract com.fasterxml.jackson.databind.node.NodeCursor.nextToken.

Annotations

@Override

overrideCurrentName	back to summary
public void overrideCurrentName(String name) Overrides com.fasterxml.jackson.databind.node.NodeCursor.overrideCurrentName. Annotations @Override

overrideCurrentName

back to summary

public void overrideCurrentName(String name)

Overrides com.fasterxml.jackson.databind.node.NodeCursor.overrideCurrentName.

Annotations