Module tools.jackson.core

Package tools.jackson.core.filter

Class TokenFilterContext

java.lang.Object

tools.jackson.core.TokenStreamContext

tools.jackson.core.filter.TokenFilterContext

public class TokenFilterContext
extends TokenStreamContext

Alternative variant of TokenStreamContext, used when filtering content being read or written (based on TokenFilter).

Field Summary

Fields

Modifier and Type	Field	Description
protected TokenFilterContext	_child
protected String	_currentName	Name of the property of which value is to be parsed; only used for OBJECT contexts
protected Object	_currentValue
protected TokenFilter	_filter	Filter to use for items in this state (for properties of Objects, elements of Arrays, and root-level values of root context)
protected boolean	_needToHandleName	Flag that indicates that the current name of this context still needs to be read/written, if path from root down to included leaf is to be exposed.
protected final TokenFilterContext	_parent	Parent context for this context; null for root context.
protected boolean	_startHandled	Flag that indicates that start token has been read/written, so that matching close token needs to be read/written as well when context is getting closed.

Fields inherited from class tools.jackson.core.TokenStreamContext

_index, _nestingDepth, _type, TYPE_ARRAY, TYPE_OBJECT, TYPE_ROOT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TokenFilterContext(int type, TokenFilterContext parent, TokenFilter filter, Object currValue, boolean startHandled)

Method Summary

Modifier and Type	Method	Description
protected void	appendDesc(StringBuilder sb)
void	assignCurrentValue(Object v)	Method to call to pass value to be returned via TokenStreamContext.currentValue(); typically called indirectly through JsonParser.assignCurrentValue(java.lang.Object) or JsonGenerator.assignCurrentValue(java.lang.Object)).
TokenFilter	checkValue(TokenFilter filter)	Method called to check whether value is to be included at current output position, either as Object property, Array element, or root value.
TokenFilterContext	closeArray(JsonGenerator gen)
TokenFilterContext	closeObject(JsonGenerator gen)
TokenFilterContext	createChildArrayContext(TokenFilter filter, Object currentValue, boolean writeStart)
TokenFilterContext	createChildObjectContext(TokenFilter filter, Object currentValue, boolean writeStart)
static TokenFilterContext	createRootContext(TokenFilter filter)
final String	currentName()	Method for accessing name associated with the current location.
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.
void	ensurePropertyNameWritten(JsonGenerator gen)	Method called to ensure that the property name, if present, has been written; may result (but does not always) in a call using given generator
TokenFilterContext	findChildOf(TokenFilterContext parent)
TokenFilter	getFilter()
final TokenFilterContext	getParent()	Accessor for finding parent context of this context; will return null for root context.
boolean	hasCurrentName()
boolean	isStartHandled()
JsonToken	nextTokenToRead()
protected TokenFilterContext	reset(int type, TokenFilter filter, Object currValue, boolean startWritten)
TokenFilter	setPropertyName(String name)
void	skipParentChecks()
String	toString()	Overridden to provide developer readable "JsonPath" representation of the context.
void	writePath(JsonGenerator gen)	Method called to ensure that parent path from root is written up to and including this node.

Methods inherited from class tools.jackson.core.TokenStreamContext

getCurrentIndex, getEntryCount, getNestingDepth, hasCurrentIndex, hasPathSegment, inArray, inObject, inRoot, pathAsPointer, pathAsPointer, startLocation, typeDesc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_parent

protected final TokenFilterContext _parent

Parent context for this context; null for root context.

_child

protected TokenFilterContext _child

_currentName

protected String _currentName

Name of the property of which value is to be parsed; only used for OBJECT contexts

_currentValue

protected Object _currentValue

Since:

3.0

_filter

protected TokenFilter _filter

Filter to use for items in this state (for properties of Objects, elements of Arrays, and root-level values of root context)

_startHandled

protected boolean _startHandled

Flag that indicates that start token has been read/written, so that matching close token needs to be read/written as well when context is getting closed.

_needToHandleName

protected boolean _needToHandleName

Flag that indicates that the current name of this context still needs to be read/written, if path from root down to included leaf is to be exposed.

Constructor Details

TokenFilterContext

protected TokenFilterContext(int type,
 TokenFilterContext parent,
 TokenFilter filter,
 Object currValue,
 boolean startHandled)

Method Details

reset

protected TokenFilterContext reset(int type,
 TokenFilter filter,
 Object currValue,
 boolean startWritten)

createRootContext

public static TokenFilterContext createRootContext(TokenFilter filter)

createChildArrayContext

public TokenFilterContext createChildArrayContext(TokenFilter filter,
 Object currentValue,
 boolean writeStart)

createChildObjectContext

public TokenFilterContext createChildObjectContext(TokenFilter filter,
 Object currentValue,
 boolean writeStart)

setPropertyName

public TokenFilter setPropertyName(String name)

checkValue

public TokenFilter checkValue(TokenFilter filter)

Method called to check whether value is to be included at current output position, either as Object property, Array element, or root value.

Parameters:

filter - Currently active filter

Returns:

Filter to use for value

ensurePropertyNameWritten

public void ensurePropertyNameWritten(JsonGenerator gen)
                               throws JacksonException

Method called to ensure that the property name, if present, has been written; may result (but does not always) in a call using given generator

Parameters:

gen - Generator to use to write the property name, if necessary

Throws:

JacksonException - If there is a problem writing property name (typically thrown by JsonGenerator)

writePath

public void writePath(JsonGenerator gen)
               throws JacksonException

Method called to ensure that parent path from root is written up to and including this node.

Parameters:

gen - Generator to use to write the path, if necessary

Throws:

JacksonException - If there is a problem writing property name (typically thrown by JsonGenerator)

closeArray

public TokenFilterContext closeArray(JsonGenerator gen)
                              throws JacksonException

Throws:

JacksonException

closeObject

public TokenFilterContext closeObject(JsonGenerator gen)
                               throws JacksonException

Throws:

JacksonException

skipParentChecks

public void skipParentChecks()

currentValue

public Object currentValue()

Description copied from class: TokenStreamContext

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.

Overrides:

currentValue in class TokenStreamContext

Returns:

Currently active value, if one has been assigned.

assignCurrentValue

public void assignCurrentValue(Object v)

Description copied from class: TokenStreamContext

Method to call to pass value to be returned via TokenStreamContext.currentValue(); typically called indirectly through JsonParser.assignCurrentValue(java.lang.Object) or JsonGenerator.assignCurrentValue(java.lang.Object)).

Overrides:

assignCurrentValue in class TokenStreamContext

Parameters:

v - Current value to assign to this context

getParent

public final TokenFilterContext getParent()

Description copied from class: TokenStreamContext

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

Specified by:

getParent in class TokenStreamContext

Returns:

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

currentName

public final String currentName()

Description copied from class: TokenStreamContext

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.

Specified by:

currentName in class TokenStreamContext

Returns:

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

hasCurrentName

public boolean hasCurrentName()

Overrides:

hasCurrentName in class TokenStreamContext

getFilter

public TokenFilter getFilter()

isStartHandled

public boolean isStartHandled()

nextTokenToRead

public JsonToken nextTokenToRead()

findChildOf

public TokenFilterContext findChildOf(TokenFilterContext parent)

appendDesc

protected void appendDesc(StringBuilder sb)

toString

public String toString()

Description copied from class: TokenStreamContext

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

Overrides:

toString in class TokenStreamContext

Returns:

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