Module tools.jackson.core

Package tools.jackson.core

Interface ObjectWriteContext

All Known Implementing Classes:

ObjectWriteContext.Base

public interface ObjectWriteContext

Defines API for accessing configuration and state exposed by higher level databind functionality during write (Object to token stream serialization) process. Access is mostly needed during construction of JsonGenerator instances by TokenStreamFactory.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ObjectWriteContext.Base	Default no-op implementation.

Method Summary

Modifier and Type	Method	Description
ArrayTreeNode	createArrayNode()	Method for construct Array nodes for Tree Model instances.
default JsonGenerator	createGenerator(OutputStream out)
default JsonGenerator	createGenerator(OutputStream out, JsonEncoding enc)
default JsonGenerator	createGenerator(Writer w)
ObjectTreeNode	createObjectNode()	Method for construct Object nodes for Tree Model instances.
static ObjectWriteContext	empty()
CharacterEscapes	getCharacterEscapes()
int	getFormatWriteFeatures(int defaults)
PrettyPrinter	getPrettyPrinter()	Accessor for getting PrettyPrinter instance to use for a new generator.
SerializableString	getRootValueSeparator(SerializableString defaultSeparator)
FormatSchema	getSchema()
int	getStreamWriteFeatures(int defaults)
boolean	hasPrettyPrinter()	Accessor similar to getPrettyPrinter() but which only indicates whether a non-null instance would be constructed if requested, or not.
TokenStreamFactory	tokenStreamFactory()
void	writeTree(JsonGenerator g, TreeNode value)
void	writeValue(JsonGenerator g, Object value)	Method that may be called to serialize given value, using specified token stream generator.

Method Details

empty

static ObjectWriteContext empty()

getSchema

FormatSchema getSchema()

getCharacterEscapes

CharacterEscapes getCharacterEscapes()

getPrettyPrinter

PrettyPrinter getPrettyPrinter()

Accessor for getting PrettyPrinter instance to use for a new generator. Note that this MUST BE a thread-safe instance: that is, if the pretty printer implementation is stateful, a new unshared instance needs to be returned -- caller will NOT try to make a copy of Instantiatable printers, context must do that.

Returns:

PrettyPrinter instance to use for a single serialization operation

hasPrettyPrinter

boolean hasPrettyPrinter()

Accessor similar to getPrettyPrinter() but which only indicates whether a non-null instance would be constructed if requested, or not. This is useful for backends that have custom pretty-printing instead of relying on Jackson standard mechanism.

Returns:

True if getPrettyPrinter() would return non-null; false otherwise.

getRootValueSeparator

SerializableString getRootValueSeparator(SerializableString defaultSeparator)

getStreamWriteFeatures

int getStreamWriteFeatures(int defaults)

getFormatWriteFeatures

int getFormatWriteFeatures(int defaults)

tokenStreamFactory

TokenStreamFactory tokenStreamFactory()

createGenerator

default JsonGenerator createGenerator(OutputStream out)
                               throws JacksonException

Throws:

JacksonException

createGenerator

default JsonGenerator createGenerator(OutputStream out,
 JsonEncoding enc)
                               throws JacksonException

Throws:

JacksonException

createGenerator

default JsonGenerator createGenerator(Writer w)
                               throws JacksonException

Throws:

JacksonException

createArrayNode

ArrayTreeNode createArrayNode()

Method for construct Array nodes for Tree Model instances.

Returns:

Array node created

createObjectNode

ObjectTreeNode createObjectNode()

Method for construct Object nodes for Tree Model instances.

Returns:

Object node created

writeValue

void writeValue(JsonGenerator g,
 Object value)
         throws JacksonException

Method that may be called to serialize given value, using specified token stream generator.

Parameters:

g - Generator to use for serialization

value - Java value to be serialized

Throws:

JacksonIOException - for low-level write problems,

StreamWriteException - for encoding problems

JacksonException - (various subtypes) for databinding problems

writeTree

void writeTree(JsonGenerator g,
 TreeNode value)
        throws JacksonException

Throws:

JacksonException