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 final ObjectIdGenerator.IdKey	_key
protected LinkedList<ReadableObjectId.Referring>	_referringProperties
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()
Iterator<ReadableObjectId.Referring>	referringProperties()
Object	resolve()
void	setResolver(ObjectIdResolver resolver)
String	toString()
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`)

_key

protected final ObjectIdGenerator.IdKey _key

_referringProperties

protected LinkedList<ReadableObjectId.Referring> _referringProperties

_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)

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

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