Module tools.jackson.databind

Package tools.jackson.databind.deser

Class ReadableObjectId

java.lang.Object

tools.jackson.databind.deser.ReadableObjectId

public class ReadableObjectId
extends Object

Simple value container for containing information about single Object Id during deserialization

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadableObjectId.Referring

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	_item
protected boolean	_itemReplaced	Flag set when tryReplaceBoundItem(java.lang.Object, java.lang.Object) is called, indicating that _item has been replaced and should not be refreshed from resolver.
protected final ObjectIdGenerator.IdKey	_key
protected boolean	_mayRebind	Flag set by callers (e.g., builder-based id property) to indicate that the bound item is a transient delegate that may later be rebuilt via DeserializationContext.updateObjectId(java.lang.Object, java.lang.Object); only then is it worth retaining resolved Referrings for notifyReferringsOfRebind(java.lang.Object, java.lang.Object).
protected LinkedList<ReadableObjectId.Referring>	_referringProperties
protected List<ReadableObjectId.Referring>	_resolvedReferringProperties	Referring properties that have already been resolved via bindItem(tools.jackson.databind.DeserializationContext, java.lang.Object).
protected ObjectIdResolver	_resolver

Constructor Summary

Constructors

Constructor	Description
ReadableObjectId(ObjectIdGenerator.IdKey key)

Method Summary

Modifier and Type	Method	Description
void	appendReferring(ReadableObjectId.Referring currentReferring)
void	bindItem(DeserializationContext ctxt, Object ob)	Method called to assign actual POJO to which ObjectId refers to: will also handle referring properties, if any, by assigning POJO.
ObjectIdGenerator.IdKey	getKey()
ObjectIdResolver	getResolver()	Allow access to the resolver in case anybody wants to use it directly, for examples from DeserializationContextExt.tryToResolveUnresolvedObjectId(tools.jackson.databind.deser.ReadableObjectId).
boolean	hasReferringProperties()
void	markMayRebind()	Mark this entry as potentially rebindable (e.g., bound to a Builder instance whose finishBuild will later trigger DeserializationContext.updateObjectId(java.lang.Object, java.lang.Object)).
void	notifyReferringsOfRebind(Object oldItem, Object newItem)	Method called after tryReplaceBoundItem(java.lang.Object, java.lang.Object) to notify previously-resolved ReadableObjectId.Referring instances that the bound item has been replaced (e.g., builder → built object).
Iterator<ReadableObjectId.Referring>	referringProperties()
Object	resolve()
void	setResolver(ObjectIdResolver resolver)
String	toString()
boolean	tryReplaceBoundItem(Object delegate, Object newItem)	Method called to try to replace the bound item after a delegating @JsonCreator has converted the intermediate delegate object into the final bean.
boolean	tryToResolveUnresolved(DeserializationContext ctxt)	Method called by DeserializationContext at the end of deserialization if this Object Id was not resolved during normal processing.

Methods inherited from class java.lang.Object

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

Field Details

_item

protected Object _item

Since:

2.8 (with this name, formerly `public Object item`)

_itemReplaced

protected boolean _itemReplaced

Flag set when tryReplaceBoundItem(java.lang.Object, java.lang.Object) is called, indicating that _item has been replaced and should not be refreshed from resolver.

Since:

3.2

_key

protected final ObjectIdGenerator.IdKey _key

_referringProperties

protected LinkedList<ReadableObjectId.Referring> _referringProperties

_resolvedReferringProperties

protected List<ReadableObjectId.Referring> _resolvedReferringProperties

Referring properties that have already been resolved via bindItem(tools.jackson.databind.DeserializationContext, java.lang.Object). Kept alive so that notifyReferringsOfRebind(java.lang.Object, java.lang.Object) can propagate builder-to-built-object replacements (e.g., after finishBuild). Only populated when _mayRebind is set, since plain (non-Builder) deserialization never calls updateObjectId and would otherwise retain Referrings as dead memory.

Since:

3.2

_mayRebind

protected boolean _mayRebind

Flag set by callers (e.g., builder-based id property) to indicate that the bound item is a transient delegate that may later be rebuilt via DeserializationContext.updateObjectId(java.lang.Object, java.lang.Object); only then is it worth retaining resolved Referrings for notifyReferringsOfRebind(java.lang.Object, java.lang.Object).

Since:

3.2

_resolver

protected ObjectIdResolver _resolver

Constructor Details

ReadableObjectId

public ReadableObjectId(ObjectIdGenerator.IdKey key)

Method Details

setResolver

public void setResolver(ObjectIdResolver resolver)

getKey

public ObjectIdGenerator.IdKey getKey()

appendReferring

public void appendReferring(ReadableObjectId.Referring currentReferring)

markMayRebind

public void markMayRebind()

Mark this entry as potentially rebindable (e.g., bound to a Builder instance whose finishBuild will later trigger DeserializationContext.updateObjectId(java.lang.Object, java.lang.Object)). Enables retention of resolved Referrings so notifyReferringsOfRebind(java.lang.Object, java.lang.Object) can fire.

Since:

3.2

bindItem

public void bindItem(DeserializationContext ctxt,
 Object ob)
              throws JacksonException

Method called to assign actual POJO to which ObjectId refers to: will also handle referring properties, if any, by assigning POJO.

Throws:

JacksonException

tryReplaceBoundItem

public boolean tryReplaceBoundItem(Object delegate,
 Object newItem)

Method called to try to replace the bound item after a delegating @JsonCreator has converted the intermediate delegate object into the final bean. Unlike bindItem(tools.jackson.databind.DeserializationContext, java.lang.Object), this method does not go through the ObjectIdResolver (which would reject re-binding) but instead directly replaces the tracked item.

Parameters:

delegate - The intermediate delegate object to match against current binding

newItem - The final bean to replace the delegate with

Returns:

true if this entry was bound to delegate and was replaced; false if not bound to delegate

Since:

3.2

notifyReferringsOfRebind

public void notifyReferringsOfRebind(Object oldItem,
 Object newItem)
                              throws JacksonException

Method called after tryReplaceBoundItem(java.lang.Object, java.lang.Object) to notify previously-resolved ReadableObjectId.Referring instances that the bound item has been replaced (e.g., builder → built object). Collection-like Referring implementations should override ReadableObjectId.Referring.handleItemRebind(java.lang.Object, java.lang.Object) to swap the old item for the new one.

Throws:

JacksonException

Since:

3.2

resolve

public Object resolve()

hasReferringProperties

public boolean hasReferringProperties()

referringProperties

public Iterator<ReadableObjectId.Referring> referringProperties()

tryToResolveUnresolved

public boolean tryToResolveUnresolved(DeserializationContext ctxt)

Method called by DeserializationContext at the end of deserialization if this Object Id was not resolved during normal processing. Call is made to allow custom implementations to use alternative resolution strategies; currently the only way to make use of this functionality is by sub-classing ReadableObjectId and overriding this method.

Default implementation simply returns false to indicate that resolution attempt did not succeed.

Returns:

True, if resolution succeeded (and no error needs to be reported); false to indicate resolution did not succeed.

Since:

2.6

getResolver

public ObjectIdResolver getResolver()

Allow access to the resolver in case anybody wants to use it directly, for examples from DeserializationContextExt.tryToResolveUnresolvedObjectId(tools.jackson.databind.deser.ReadableObjectId).

Returns:

The registered resolver

Since:

2.7

toString

public String toString()

Overrides:

toString in class Object