All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.fasterxml.jackson.databind.deser.SettableAnyProperty Maven / Gradle / Ivy

The newest version!
package com.fasterxml.jackson.databind.deser;

import java.io.IOException;
import java.lang.reflect.*;

import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.deser.impl.ReadableObjectId.Referring;
import com.fasterxml.jackson.databind.introspect.AnnotatedMethod;
import com.fasterxml.jackson.databind.jsontype.TypeDeserializer;

/**
 * Class that represents a "wildcard" set method which can be used
 * to generically set values of otherwise unmapped (aka "unknown")
 * properties read from Json content.
 *

* !!! Note: might make sense to refactor to share some code * with {@link SettableBeanProperty}? */ public class SettableAnyProperty implements java.io.Serializable { private static final long serialVersionUID = 1L; /** * Method used for setting "any" properties, along with annotation * information. Retained to allow contextualization of any properties. */ protected final BeanProperty _property; /** * Physical JDK object used for assigning properties. *

* NOTE: must be marked transient since it is not serializable, * in case these are to be serialized */ protected final transient Method _setter; protected final JavaType _type; protected JsonDeserializer _valueDeserializer; protected final TypeDeserializer _valueTypeDeserializer; /* /********************************************************** /* Life-cycle /********************************************************** */ @Deprecated // since 2.3 public SettableAnyProperty(BeanProperty property, AnnotatedMethod setter, JavaType type, JsonDeserializer valueDeser) { this(property, setter, type, valueDeser, null); } public SettableAnyProperty(BeanProperty property, AnnotatedMethod setter, JavaType type, JsonDeserializer valueDeser, TypeDeserializer typeDeser) { this(property, setter.getAnnotated(), type, valueDeser, typeDeser); } @Deprecated // since 2.3 public SettableAnyProperty(BeanProperty property, Method rawSetter, JavaType type, JsonDeserializer valueDeser) { this(property, rawSetter, type, valueDeser, null); } public SettableAnyProperty(BeanProperty property, Method rawSetter, JavaType type, JsonDeserializer valueDeser, TypeDeserializer typeDeser) { _property = property; _type = type; _setter = rawSetter; _valueDeserializer = valueDeser; _valueTypeDeserializer = typeDeser; } public SettableAnyProperty withValueDeserializer(JsonDeserializer deser) { return new SettableAnyProperty(_property, _setter, _type, deser, _valueTypeDeserializer); } /* /********************************************************** /* JDK serialization handling /********************************************************** */ // TODO (2.3): handle restoring of reference to any-setter method /* Object readResolve() { return new SettableAnyProperty(this, _annotated.getAnnotated()); } */ /* /********************************************************** /* Public API, accessors /********************************************************** */ public BeanProperty getProperty() { return _property; } public boolean hasValueDeserializer() { return (_valueDeserializer != null); } public JavaType getType() { return _type; } /* /********************************************************** /* Public API, deserialization /********************************************************** */ /** * Method called to deserialize appropriate value, given parser (and * context), and set it using appropriate method (a setter method). */ public final void deserializeAndSet(JsonParser jp, DeserializationContext ctxt, Object instance, String propName) throws IOException { try { set(instance, propName, deserialize(jp, ctxt)); } catch (UnresolvedForwardReference reference) { if (!(_valueDeserializer.getObjectIdReader() != null)) { throw JsonMappingException.from(jp, "Unresolved forward reference but no identity info.", reference); } AnySetterReferring referring = new AnySetterReferring(this, reference, _type.getRawClass(), instance, propName); reference.getRoid().appendReferring(referring); } } public Object deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException { JsonToken t = jp.getCurrentToken(); if (t == JsonToken.VALUE_NULL) { return null; } if (_valueTypeDeserializer != null) { return _valueDeserializer.deserializeWithType(jp, ctxt, _valueTypeDeserializer); } return _valueDeserializer.deserialize(jp, ctxt); } public void set(Object instance, String propName, Object value) throws IOException { try { _setter.invoke(instance, propName, value); } catch (Exception e) { _throwAsIOE(e, propName, value); } } /* /********************************************************** /* Helper methods /********************************************************** */ /** * @param e Exception to re-throw or wrap * @param propName Name of property (from Json input) to set * @param value Value of the property */ protected void _throwAsIOE(Exception e, String propName, Object value) throws IOException { if (e instanceof IllegalArgumentException) { String actType = (value == null) ? "[NULL]" : value.getClass().getName(); StringBuilder msg = new StringBuilder("Problem deserializing \"any\" property '").append(propName); msg.append("' of class "+getClassName()+" (expected type: ").append(_type); msg.append("; actual type: ").append(actType).append(")"); String origMsg = e.getMessage(); if (origMsg != null) { msg.append(", problem: ").append(origMsg); } else { msg.append(" (no error message provided)"); } throw new JsonMappingException(msg.toString(), null, e); } if (e instanceof IOException) { throw (IOException) e; } if (e instanceof RuntimeException) { throw (RuntimeException) e; } // let's wrap the innermost problem Throwable t = e; while (t.getCause() != null) { t = t.getCause(); } throw new JsonMappingException(t.getMessage(), null, t); } private String getClassName() { return _setter.getDeclaringClass().getName(); } @Override public String toString() { return "[any property on class "+getClassName()+"]"; } private static class AnySetterReferring extends Referring { private final SettableAnyProperty _parent; private final Object _pojo; private final String _propName; public AnySetterReferring(SettableAnyProperty parent, UnresolvedForwardReference reference, Class type, Object instance, String propName) { super(reference, type); _parent = parent; _pojo = instance; _propName = propName; } @Override public void handleResolvedForwardReference(Object id, Object value) throws IOException { if (!hasId(id)) { throw new IllegalArgumentException("Trying to resolve a forward reference with id [" + id.toString() + "] that wasn't previously registered."); } _parent.set(_pojo, _propName, value); } } }