Module tools.jackson.databind

Package tools.jackson.databind.ser

Class WritableObjectId

java.lang.Object

tools.jackson.databind.ser.WritableObjectId

public final class WritableObjectId
extends Object

Simple value container used to keep track of Object Ids during serialization.

Field Summary

Fields

Modifier and Type	Field	Description
final ObjectIdGenerator<?>	generator
Object	id
protected boolean	idWritten	Marker to denote whether Object Id value has been written as part of an Object, to be referencible.

Constructor Summary

Constructors

Constructor	Description
WritableObjectId(ObjectIdGenerator<?> g)

Method Summary

Modifier and Type	Method	Description
Object	generateId(Object forPojo)
void	writeAsDeclaration(tools.jackson.core.JsonGenerator g, SerializationContext ctxt, ObjectIdWriter w)	Method called to output Object Id declaration, either using native Object Id write method JsonGenerator.writeObjectId(Object) (if allowed), or, if not, just writing it as an Object property with specified property name and id value.
boolean	writeAsReference(tools.jackson.core.JsonGenerator g, SerializationContext ctxt, ObjectIdWriter w)	Method to call to write a reference to object that this id refers.

Methods inherited from class java.lang.Object

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

Field Details

generator

public final ObjectIdGenerator<?> generator

id

public Object id

idWritten

protected boolean idWritten

Marker to denote whether Object Id value has been written as part of an Object, to be referencible. Remains false when forward-reference is written.

Constructor Details

WritableObjectId

public WritableObjectId(ObjectIdGenerator<?> g)

Method Details

writeAsReference

public boolean writeAsReference(tools.jackson.core.JsonGenerator g,
 SerializationContext ctxt,
 ObjectIdWriter w)
                         throws tools.jackson.core.JacksonException

Method to call to write a reference to object that this id refers. Usually this is done after an earlier call to writeAsDeclaration(tools.jackson.core.JsonGenerator, tools.jackson.databind.SerializationContext, tools.jackson.databind.ser.impl.ObjectIdWriter).

Throws:

tools.jackson.core.JacksonException

generateId

public Object generateId(Object forPojo)

writeAsDeclaration

public void writeAsDeclaration(tools.jackson.core.JsonGenerator g,
 SerializationContext ctxt,
 ObjectIdWriter w)
                        throws tools.jackson.core.JacksonException

Method called to output Object Id declaration, either using native Object Id write method JsonGenerator.writeObjectId(Object) (if allowed), or, if not, just writing it as an Object property with specified property name and id value.

Throws:

tools.jackson.core.JacksonException