Module tools.jackson.databind

Package tools.jackson.databind.node

Class TreeBuildingGenerator

java.lang.Object

tools.jackson.core.JsonGenerator

tools.jackson.databind.node.TreeBuildingGenerator

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Versioned

public class TreeBuildingGenerator
extends JsonGenerator

Helper class used for creating JsonNode values directly as part of serialization.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final JsonNodeFactory	_nodeFactory
protected final ObjectWriteContext	_objectWriteContext
protected tools.jackson.databind.node.TreeBuildingGenerator.RootContext	_rootWriteContext
protected final int	_streamWriteFeatures	Bit flag composed of bits that indicate which StreamWriteFeatures are enabled.
protected tools.jackson.databind.node.TreeBuildingGenerator.TreeWriteContext	_tokenWriteContext
protected static final JacksonFeatureSet<StreamWriteCapability>	BOGUS_WRITE_CAPABILITIES
protected static final int	DEFAULT_STREAM_WRITE_FEATURES

Method Summary

Modifier and Type	Method	Description
void	assignCurrentValue(Object v)
boolean	canWriteObjectId()
boolean	canWriteTypeId()
void	close()
JsonGenerator	configure(StreamWriteFeature f, boolean state)
Object	currentValue()
void	flush()
static TreeBuildingGenerator	forSerialization(SerializationContext ctxt, JsonNodeFactory nodeFactory)
boolean	isClosed()
boolean	isEnabled(StreamWriteFeature f)
ObjectWriteContext	objectWriteContext()
JacksonFeatureSet<StreamWriteCapability>	streamWriteCapabilities()
TokenStreamContext	streamWriteContext()
int	streamWriteFeatures()
int	streamWriteOutputBuffered()
Object	streamWriteOutputTarget()
JsonNode	treeBuilt()
Version	version()
JsonGenerator	writeBinary(Base64Variant b64variant, byte[] data, int offset, int len)
int	writeBinary(Base64Variant b64variant, InputStream data, int dataLength)	Although we could support this method, it does not necessarily make sense: we cannot make good use of streaming because buffer must hold all the data.
JsonGenerator	writeBoolean(boolean state)
JsonGenerator	writeEmbeddedObject(Object object)
JsonGenerator	writeEndArray()
JsonGenerator	writeEndObject()
JsonGenerator	writeName(String name)
JsonGenerator	writeName(SerializableString name)
JsonGenerator	writeNull()
JsonGenerator	writeNumber(double v)
JsonGenerator	writeNumber(float v)
JsonGenerator	writeNumber(int v)
JsonGenerator	writeNumber(long v)
JsonGenerator	writeNumber(short v)
JsonGenerator	writeNumber(String encodedValue)
JsonGenerator	writeNumber(BigDecimal v)
JsonGenerator	writeNumber(BigInteger v)
JsonGenerator	writeObjectId(Object id)
JsonGenerator	writePOJO(Object value)
JsonGenerator	writePropertyId(long id)
JsonGenerator	writeRaw(char c)
JsonGenerator	writeRaw(char[] text, int offset, int len)
JsonGenerator	writeRaw(String text)
JsonGenerator	writeRaw(String text, int offset, int len)
JsonGenerator	writeRaw(SerializableString text)
JsonGenerator	writeRawUTF8String(byte[] text, int offset, int length)
JsonGenerator	writeRawValue(char[] text, int offset, int len)
JsonGenerator	writeRawValue(String text)
JsonGenerator	writeRawValue(String text, int offset, int len)
JsonGenerator	writeStartArray()
JsonGenerator	writeStartArray(Object forValue)
JsonGenerator	writeStartArray(Object forValue, int len)
JsonGenerator	writeStartObject()
JsonGenerator	writeStartObject(Object forValue)
JsonGenerator	writeStartObject(Object forValue, int size)
JsonGenerator	writeString(char[] text, int offset, int len)
JsonGenerator	writeString(Reader reader, int len)
JsonGenerator	writeString(String text)
JsonGenerator	writeString(SerializableString text)
JsonGenerator	writeTree(TreeNode node)
JsonGenerator	writeTypeId(Object id)
JsonGenerator	writeUTF8String(byte[] text, int offset, int length)

Methods inherited from class tools.jackson.core.JsonGenerator

_constructWriteException, _constructWriteException, _constructWriteException, _constructWriteException, _copyCurrentContents, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportArgumentError, _reportError, _reportUnsupportedOperation, _reportUnsupportedOperation, _verifyOffsets, _wrapIOFailure, _writeTypePrefixUsingNative, _writeTypePrefixUsingWrapper, canOmitProperties, copyCurrentEvent, copyCurrentEventExact, copyCurrentStructure, getCharacterEscapes, getHighestNonEscapedChar, getSchema, setCharacterEscapes, streamWriteConstraints, writeArray, writeArray, writeArray, writeArray, writeArrayPropertyStart, writeBinary, writeBinary, writeBinary, writeBinaryProperty, writeBooleanProperty, writeNullProperty, writeNumber, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeNumberProperty, writeObjectPropertyStart, writeObjectRef, writeOmittedProperty, writePOJOProperty, writeRawValue, writeStringProperty, writeTypePrefix, writeTypeSuffix

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_STREAM_WRITE_FEATURES

protected static final int DEFAULT_STREAM_WRITE_FEATURES

BOGUS_WRITE_CAPABILITIES

protected static final JacksonFeatureSet<StreamWriteCapability> BOGUS_WRITE_CAPABILITIES

_objectWriteContext

protected final ObjectWriteContext _objectWriteContext

_nodeFactory

protected final JsonNodeFactory _nodeFactory

_streamWriteFeatures

protected final int _streamWriteFeatures

Bit flag composed of bits that indicate which StreamWriteFeatures are enabled.

NOTE: most features have no effect on this class

_rootWriteContext

protected tools.jackson.databind.node.TreeBuildingGenerator.RootContext _rootWriteContext

_tokenWriteContext

protected tools.jackson.databind.node.TreeBuildingGenerator.TreeWriteContext _tokenWriteContext

Method Details

forSerialization

public static TreeBuildingGenerator forSerialization(SerializationContext ctxt,
 JsonNodeFactory nodeFactory)

treeBuilt

public JsonNode treeBuilt()

streamWriteContext

public TokenStreamContext streamWriteContext()

Specified by:

streamWriteContext in class JsonGenerator

currentValue

public Object currentValue()

Specified by:

currentValue in class JsonGenerator

assignCurrentValue

public void assignCurrentValue(Object v)

Specified by:

assignCurrentValue in class JsonGenerator

objectWriteContext

public ObjectWriteContext objectWriteContext()

Specified by:

objectWriteContext in class JsonGenerator

version

public Version version()

Specified by:

version in interface Versioned

Specified by:

version in class JsonGenerator

configure

public JsonGenerator configure(StreamWriteFeature f,
 boolean state)

Specified by:

configure in class JsonGenerator

isEnabled

public boolean isEnabled(StreamWriteFeature f)

Specified by:

isEnabled in class JsonGenerator

streamWriteFeatures

public int streamWriteFeatures()

Specified by:

streamWriteFeatures in class JsonGenerator

streamWriteCapabilities

public JacksonFeatureSet<StreamWriteCapability> streamWriteCapabilities()

Specified by:

streamWriteCapabilities in class JsonGenerator

flush

public void flush()

Specified by:

flush in interface Flushable

Specified by:

flush in class JsonGenerator

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class JsonGenerator

isClosed

public boolean isClosed()

Specified by:

isClosed in class JsonGenerator

streamWriteOutputTarget

public Object streamWriteOutputTarget()

Specified by:

streamWriteOutputTarget in class JsonGenerator

streamWriteOutputBuffered

public int streamWriteOutputBuffered()

Specified by:

streamWriteOutputBuffered in class JsonGenerator

writeStartArray

public JsonGenerator writeStartArray()

Specified by:

writeStartArray in class JsonGenerator

writeStartArray

public JsonGenerator writeStartArray(Object forValue)

Specified by:

writeStartArray in class JsonGenerator

writeStartArray

public JsonGenerator writeStartArray(Object forValue,
 int len)

Specified by:

writeStartArray in class JsonGenerator

writeEndArray

public JsonGenerator writeEndArray()

Specified by:

writeEndArray in class JsonGenerator

writeStartObject

public JsonGenerator writeStartObject()

Specified by:

writeStartObject in class JsonGenerator

writeStartObject

public JsonGenerator writeStartObject(Object forValue)

Specified by:

writeStartObject in class JsonGenerator

writeStartObject

public JsonGenerator writeStartObject(Object forValue,
 int size)

Specified by:

writeStartObject in class JsonGenerator

writeEndObject

public JsonGenerator writeEndObject()

Specified by:

writeEndObject in class JsonGenerator

writeName

public JsonGenerator writeName(String name)

Specified by:

writeName in class JsonGenerator

writeName

public JsonGenerator writeName(SerializableString name)

Specified by:

writeName in class JsonGenerator

writePropertyId

public JsonGenerator writePropertyId(long id)

Specified by:

writePropertyId in class JsonGenerator

writeString

public JsonGenerator writeString(String text)

Specified by:

writeString in class JsonGenerator

writeString

public JsonGenerator writeString(char[] text,
 int offset,
 int len)

Specified by:

writeString in class JsonGenerator

writeString

public JsonGenerator writeString(SerializableString text)

Specified by:

writeString in class JsonGenerator

writeString

public JsonGenerator writeString(Reader reader,
 int len)

Specified by:

writeString in class JsonGenerator

writeRawUTF8String

public JsonGenerator writeRawUTF8String(byte[] text,
 int offset,
 int length)

Specified by:

writeRawUTF8String in class JsonGenerator

writeUTF8String

public JsonGenerator writeUTF8String(byte[] text,
 int offset,
 int length)

Specified by:

writeUTF8String in class JsonGenerator

writeRaw

public JsonGenerator writeRaw(String text)

Specified by:

writeRaw in class JsonGenerator

writeRaw

public JsonGenerator writeRaw(String text,
 int offset,
 int len)

Specified by:

writeRaw in class JsonGenerator

writeRaw

public JsonGenerator writeRaw(SerializableString text)

Overrides:

writeRaw in class JsonGenerator

writeRaw

public JsonGenerator writeRaw(char[] text,
 int offset,
 int len)

Specified by:

writeRaw in class JsonGenerator

writeRaw

public JsonGenerator writeRaw(char c)

Specified by:

writeRaw in class JsonGenerator

writeRawValue

public JsonGenerator writeRawValue(String text)

Specified by:

writeRawValue in class JsonGenerator

writeRawValue

public JsonGenerator writeRawValue(String text,
 int offset,
 int len)

Specified by:

writeRawValue in class JsonGenerator

writeRawValue

public JsonGenerator writeRawValue(char[] text,
 int offset,
 int len)

Specified by:

writeRawValue in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(short v)

Specified by:

writeNumber in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(int v)

Specified by:

writeNumber in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(long v)

Specified by:

writeNumber in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(double v)

Specified by:

writeNumber in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(float v)

Specified by:

writeNumber in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(BigDecimal v)

Specified by:

writeNumber in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(BigInteger v)

Specified by:

writeNumber in class JsonGenerator

writeNumber

public JsonGenerator writeNumber(String encodedValue)

Specified by:

writeNumber in class JsonGenerator

writeBoolean

public JsonGenerator writeBoolean(boolean state)

Specified by:

writeBoolean in class JsonGenerator

writeNull

public JsonGenerator writeNull()

Specified by:

writeNull in class JsonGenerator

writePOJO

public JsonGenerator writePOJO(Object value)

Specified by:

writePOJO in class JsonGenerator

writeTree

public JsonGenerator writeTree(TreeNode node)

Specified by:

writeTree in class JsonGenerator

writeBinary

public JsonGenerator writeBinary(Base64Variant b64variant,
 byte[] data,
 int offset,
 int len)

Specified by:

writeBinary in class JsonGenerator

writeBinary

public int writeBinary(Base64Variant b64variant,
 InputStream data,
 int dataLength)

Although we could support this method, it does not necessarily make sense: we cannot make good use of streaming because buffer must hold all the data. Because of this, currently this will simply throw UnsupportedOperationException

Specified by:

writeBinary in class JsonGenerator

canWriteTypeId

public boolean canWriteTypeId()

Overrides:

canWriteTypeId in class JsonGenerator

canWriteObjectId

public boolean canWriteObjectId()

Overrides:

canWriteObjectId in class JsonGenerator

writeTypeId

public JsonGenerator writeTypeId(Object id)

Overrides:

writeTypeId in class JsonGenerator

writeObjectId

public JsonGenerator writeObjectId(Object id)

Overrides:

writeObjectId in class JsonGenerator

writeEmbeddedObject

public JsonGenerator writeEmbeddedObject(Object object)

Overrides:

writeEmbeddedObject in class JsonGenerator