Class TokenFilterContext
- java.lang.Object
-
- com.fasterxml.jackson.core.JsonStreamContext
-
- com.fasterxml.jackson.core.filter.TokenFilterContext
-
public class TokenFilterContext extends JsonStreamContext
Alternative variant ofJsonStreamContext
, used when filtering content being read or written (based onTokenFilter
).- Since:
- 2.6
-
-
Field Summary
Fields Modifier and Type Field Description protected TokenFilterContext
_child
protected String
_currentName
Name of the field of which value is to be parsed; only used for OBJECT contextsprotected 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 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 com.fasterxml.jackson.core.JsonStreamContext
_index, _type, TYPE_ARRAY, TYPE_OBJECT, TYPE_ROOT
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
TokenFilterContext(int type, TokenFilterContext parent, TokenFilter filter, boolean startHandled)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
appendDesc(StringBuilder sb)
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, boolean writeStart)
TokenFilterContext
createChildObjectContext(TokenFilter filter, boolean writeStart)
static TokenFilterContext
createRootContext(TokenFilter filter)
TokenFilterContext
findChildOf(TokenFilterContext parent)
String
getCurrentName()
Method for accessing name associated with the current location.Object
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.TokenFilter
getFilter()
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, boolean startWritten)
void
setCurrentValue(Object v)
Method to call to pass value to be returned viaJsonStreamContext.getCurrentValue()
; typically called indirectly throughJsonParser.setCurrentValue(java.lang.Object)
orJsonGenerator.setCurrentValue(java.lang.Object)
).TokenFilter
setFieldName(String name)
void
skipParentChecks()
String
toString()
Overridden to provide developer writeable "JsonPath" representation of the context.void
writeImmediatePath(JsonGenerator gen)
Variant ofwritePath(JsonGenerator)
called when all we need is immediately surrounding Object.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 com.fasterxml.jackson.core.JsonStreamContext
getCurrentIndex, getEntryCount, getStartLocation, getTypeDesc, hasCurrentIndex, hasPathSegment, inArray, inObject, inRoot, pathAsPointer, pathAsPointer, typeDesc
-
-
-
-
Field Detail
-
_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 field of which value is to be parsed; only used for OBJECT contexts
-
_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 Detail
-
TokenFilterContext
protected TokenFilterContext(int type, TokenFilterContext parent, TokenFilter filter, boolean startHandled)
-
-
Method Detail
-
reset
protected TokenFilterContext reset(int type, TokenFilter filter, boolean startWritten)
-
createRootContext
public static TokenFilterContext createRootContext(TokenFilter filter)
-
createChildArrayContext
public TokenFilterContext createChildArrayContext(TokenFilter filter, boolean writeStart)
-
createChildObjectContext
public TokenFilterContext createChildObjectContext(TokenFilter filter, boolean writeStart)
-
setFieldName
public TokenFilter setFieldName(String name) throws JsonProcessingException
- Throws:
JsonProcessingException
-
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.
-
writePath
public void writePath(JsonGenerator gen) throws IOException
Method called to ensure that parent path from root is written up to and including this node.- Throws:
IOException
-
writeImmediatePath
public void writeImmediatePath(JsonGenerator gen) throws IOException
Variant ofwritePath(JsonGenerator)
called when all we need is immediately surrounding Object. Method typically called when including a single property but not including full path to root.- Throws:
IOException
-
closeArray
public TokenFilterContext closeArray(JsonGenerator gen) throws IOException
- Throws:
IOException
-
closeObject
public TokenFilterContext closeObject(JsonGenerator gen) throws IOException
- Throws:
IOException
-
skipParentChecks
public void skipParentChecks()
-
getCurrentValue
public Object getCurrentValue()
Description copied from class:JsonStreamContext
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:
getCurrentValue
in classJsonStreamContext
- Returns:
- Currently active value, if one has been assigned.
-
setCurrentValue
public void setCurrentValue(Object v)
Description copied from class:JsonStreamContext
Method to call to pass value to be returned viaJsonStreamContext.getCurrentValue()
; typically called indirectly throughJsonParser.setCurrentValue(java.lang.Object)
orJsonGenerator.setCurrentValue(java.lang.Object)
).- Overrides:
setCurrentValue
in classJsonStreamContext
-
getParent
public final TokenFilterContext getParent()
Description copied from class:JsonStreamContext
Accessor for finding parent context of this context; will return null for root context.- Specified by:
getParent
in classJsonStreamContext
-
getCurrentName
public final String getCurrentName()
Description copied from class:JsonStreamContext
Method for accessing name associated with the current location. Non-null forFIELD_NAME
and value events that directly follow field names; null for root level and array values.- Specified by:
getCurrentName
in classJsonStreamContext
-
hasCurrentName
public boolean hasCurrentName()
- Overrides:
hasCurrentName
in classJsonStreamContext
-
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()
Overridden to provide developer writeable "JsonPath" representation of the context.- Overrides:
toString
in classJsonStreamContext
-
-