Module tools.jackson.core

Package tools.jackson.core.util

Class SimpleStreamWriteContext

java.lang.Object

tools.jackson.core.TokenStreamContext

tools.jackson.core.util.SimpleStreamWriteContext

public final class SimpleStreamWriteContext
extends TokenStreamContext

Basic implementation of TokenStreamContext useful for most format backend JsonGenerator implementations (with notable exception of JSON that needs bit more advanced state).

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected SimpleStreamWriteContext	_childToRecycle
protected String	_currentName	Name of the property of which value is to be written; only used for OBJECT contexts.
protected Object	_currentValue
protected DupDetector	_dups
protected boolean	_gotPropertyId	Marker used to indicate that we just wrote a property name (or possibly property id for some backends) and now expect a value to write.
protected final SimpleStreamWriteContext	_parent	Parent context for this context; null for root context.

Fields inherited from class tools.jackson.core.TokenStreamContext

_index, _nestingDepth, _type, TYPE_ARRAY, TYPE_OBJECT, TYPE_ROOT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleStreamWriteContext(int type, SimpleStreamWriteContext parent, int nestingDepth, DupDetector dups, Object currentValue)

Method Summary

Modifier and Type	Method	Description
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)).
SimpleStreamWriteContext	clearAndGetParent()	Method that can be used to both clear the accumulated references (specifically value set with assignCurrentValue(Object)) that should not be retained, and returns parent (as would getParent() do).
SimpleStreamWriteContext	createChildArrayContext(Object currentValue)
SimpleStreamWriteContext	createChildObjectContext(Object currentValue)
static SimpleStreamWriteContext	createRootContext(DupDetector dd)
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.
DupDetector	getDupDetector()
final SimpleStreamWriteContext	getParent()	Accessor for finding parent context of this context; will return null for root context.
boolean	hasCurrentName()
SimpleStreamWriteContext	withDupDetector(DupDetector dups)
boolean	writeName(String name)	Method that writer is to call before it writes an Object Property name.
boolean	writeValue()

Methods inherited from class tools.jackson.core.TokenStreamContext

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

Methods inherited from class java.lang.Object

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

Field Details

_parent

protected final SimpleStreamWriteContext _parent

Parent context for this context; null for root context.

_dups

protected DupDetector _dups

_childToRecycle

protected SimpleStreamWriteContext _childToRecycle

_currentName

protected String _currentName

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

_currentValue

protected Object _currentValue

_gotPropertyId

protected boolean _gotPropertyId

Marker used to indicate that we just wrote a property name (or possibly property id for some backends) and now expect a value to write.

Constructor Details

SimpleStreamWriteContext

protected SimpleStreamWriteContext(int type,
 SimpleStreamWriteContext parent,
 int nestingDepth,
 DupDetector dups,
 Object currentValue)

Method Details

withDupDetector

public SimpleStreamWriteContext withDupDetector(DupDetector dups)

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

createRootContext

public static SimpleStreamWriteContext createRootContext(DupDetector dd)

createChildArrayContext

public SimpleStreamWriteContext createChildArrayContext(Object currentValue)

createChildObjectContext

public SimpleStreamWriteContext createChildObjectContext(Object currentValue)

getParent

public final SimpleStreamWriteContext 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

clearAndGetParent

public SimpleStreamWriteContext clearAndGetParent()

Method that can be used to both clear the accumulated references (specifically value set with assignCurrentValue(Object)) that should not be retained, and returns parent (as would getParent() do). Typically called when closing the active context when encountering JsonToken.END_ARRAY or JsonToken.END_OBJECT.

Returns:

Parent context of this context node, if any; null for root context

getDupDetector

public DupDetector getDupDetector()

writeName

public boolean writeName(String name)
                  throws StreamWriteException

Method that writer is to call before it writes an Object Property name.

Parameters:

name - Name of Object property name being written

Returns:

True if name writing should proceed; false if not

Throws:

StreamWriteException - If write fails due to duplicate check

writeValue

public boolean writeValue()