org.apache.juli.logging.com.fasterxml.jackson.databind.deser.impl.ReadableObjectId Maven / Gradle / Ivy
package org.apache.juli.logging.com.fasterxml.jackson.databind.deser.impl;
import java.io.IOException;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import org.apache.juli.logging.com.fasterxml.jackson.annotation.ObjectIdGenerator;
import org.apache.juli.logging.com.fasterxml.jackson.annotation.ObjectIdResolver;
import org.apache.juli.logging.com.fasterxml.jackson.core.JsonLocation;
import org.apache.juli.logging.com.fasterxml.jackson.databind.DeserializationContext;
import org.apache.juli.logging.com.fasterxml.jackson.databind.JavaType;
import org.apache.juli.logging.com.fasterxml.jackson.databind.deser.UnresolvedForwardReference;
/**
* Simple value container for containing information about single Object Id
* during deserialization
*/
public class ReadableObjectId
{
/**
* @since 2.8 (with this name, formerly `public Object item`)
*/
protected Object _item;
protected final ObjectIdGenerator.IdKey _key;
protected LinkedList _referringProperties;
protected ObjectIdResolver _resolver;
public ReadableObjectId(ObjectIdGenerator.IdKey key) {
_key = key;
}
public void setResolver(ObjectIdResolver resolver) {
_resolver = resolver;
}
public ObjectIdGenerator.IdKey getKey() {
return _key;
}
public void appendReferring(Referring currentReferring) {
if (_referringProperties == null) {
_referringProperties = new LinkedList();
}
_referringProperties.add(currentReferring);
}
/**
* Method called to assign actual POJO to which ObjectId refers to: will
* also handle referring properties, if any, by assigning POJO.
*/
public void bindItem(Object ob) throws IOException
{
_resolver.bindItem(_key, ob);
_item = ob;
Object id = _key.key;
if (_referringProperties != null) {
Iterator it = _referringProperties.iterator();
_referringProperties = null;
while (it.hasNext()) {
it.next().handleResolvedForwardReference(id, ob);
}
}
}
public Object resolve(){
return (_item = _resolver.resolveId(_key));
}
public boolean hasReferringProperties() {
return (_referringProperties != null) && !_referringProperties.isEmpty();
}
public Iterator referringProperties() {
if (_referringProperties == null) {
return Collections. emptyList().iterator();
}
return _referringProperties.iterator();
}
/**
* Method called by {@link 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
* {@link ReadableObjectId} and overriding this method.
*
* Default implementation simply returns false
to indicate that resolution
* attempt did not succeed.
*
* @return True, if resolution succeeded (and no error needs to be reported); false to
* indicate resolution did not succeed.
*
* @since 2.6
*/
public boolean tryToResolveUnresolved(DeserializationContext ctxt)
{
return false;
}
/**
* Allow access to the resolver in case anybody wants to use it directly, for
* examples from
* {@link org.apache.juli.logging.com.fasterxml.jackson.databind.deser.DefaultDeserializationContext#tryToResolveUnresolvedObjectId}.
*
* @return The registered resolver
*
* @since 2.7
*/
public ObjectIdResolver getResolver() {
return _resolver;
}
@Override
public String toString() {
return String.valueOf(_key);
}
/*
/**********************************************************
/* Helper classes
/**********************************************************
*/
public static abstract class Referring {
private final UnresolvedForwardReference _reference;
private final Class _beanType;
public Referring(UnresolvedForwardReference ref, Class beanType) {
_reference = ref;
_beanType = beanType;
}
public Referring(UnresolvedForwardReference ref, JavaType beanType) {
_reference = ref;
_beanType = beanType.getRawClass();
}
public JsonLocation getLocation() { return _reference.getLocation(); }
public Class getBeanType() { return _beanType; }
public abstract void handleResolvedForwardReference(Object id, Object value) throws IOException;
public boolean hasId(Object id) {
return id.equals(_reference.getUnresolvedId());
}
}
}