Module tools.jackson.databind

Package tools.jackson.databind.deser

Class SettableAnyProperty

java.lang.Object

tools.jackson.databind.deser.SettableAnyProperty

Direct Known Subclasses:

SettableAnyProperty.JsonNodeFieldAnyProperty, SettableAnyProperty.JsonNodeParameterAnyProperty, SettableAnyProperty.MapFieldAnyProperty, SettableAnyProperty.MapParameterAnyProperty, SettableAnyProperty.MethodAnyProperty

public abstract class SettableAnyProperty
extends Object

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	SettableAnyProperty.JsonNodeFieldAnyProperty
protected static class	SettableAnyProperty.JsonNodeParameterAnyProperty	[databind#562] Allow @JsonAnySetter on Creator constructor
protected static class	SettableAnyProperty.MapFieldAnyProperty
protected static class	SettableAnyProperty.MapParameterAnyProperty	[databind#562] Allow @JsonAnySetter on Creator constructor
protected static class	SettableAnyProperty.MethodAnyProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected final KeyDeserializer	_keyDeserializer
protected final BeanProperty	_property	Method used for setting "any" properties, along with annotation information.
protected final AnnotatedMember	_setter	Annotated variant is needed for JDK serialization only
protected final boolean	_setterIsField
protected final JavaType	_type
protected ValueDeserializer<Object>	_valueDeserializer
protected final TypeDeserializer	_valueTypeDeserializer

Constructor Summary

Constructors

Constructor	Description
SettableAnyProperty(BeanProperty property, AnnotatedMember setter, JavaType type, KeyDeserializer keyDeser, ValueDeserializer<Object> valueDeser, TypeDeserializer typeDeser)

Method Summary

Modifier and Type	Method	Description
protected abstract void	_set(DeserializationContext ctxt, Object instance, Object propName, Object value)
protected void	_throwAsIOE(DeserializationContext ctxt, Throwable t, Object propName, Object value)
static SettableAnyProperty	constructForJsonNodeField(DeserializationContext ctxt, BeanProperty property, AnnotatedMember field, JavaType valueType, ValueDeserializer<Object> valueDeser)
static SettableAnyProperty	constructForJsonNodeParameter(DeserializationContext ctxt, BeanProperty prop, AnnotatedMember mutator, JavaType valueType, ValueDeserializer<Object> valueDeser, int parameterIndex)
static SettableAnyProperty	constructForMapField(DeserializationContext ctxt, BeanProperty property, AnnotatedMember field, JavaType valueType, KeyDeserializer keyDeser, ValueDeserializer<Object> valueDeser, TypeDeserializer typeDeser)
static SettableAnyProperty	constructForMapParameter(DeserializationContext ctxt, BeanProperty property, AnnotatedMember field, JavaType valueType, KeyDeserializer keyDeser, ValueDeserializer<Object> valueDeser, TypeDeserializer typeDeser, int parameterIndex)
static SettableAnyProperty	constructForMethod(DeserializationContext ctxt, BeanProperty property, AnnotatedMember field, JavaType valueType, KeyDeserializer keyDeser, ValueDeserializer<Object> valueDeser, TypeDeserializer typeDeser)
Object	createParameterObject()	Create an instance of value to pass through Creator parameter.
Object	deserialize(JsonParser p, DeserializationContext ctxt)
void	deserializeAndSet(JsonParser p, DeserializationContext ctxt, Object instance, String propName)	Method called to deserialize appropriate value, given parser (and context), and set it using appropriate method (a setter method).
void	fixAccess(DeserializationConfig config)
int	getParameterIndex()	Accessor for parameterIndex.
BeanProperty	getProperty()
String	getPropertyName()
JavaType	getType()
boolean	hasValueDeserializer()
boolean	isFieldType()	Method called to check whether this property is field
boolean	isSetterType()	Method called to check whether this property is method
void	set(DeserializationContext ctxt, Object instance, Object propName, Object value)
String	toString()
abstract SettableAnyProperty	withValueDeserializer(ValueDeserializer<Object> deser)

Methods inherited from class java.lang.Object

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

Field Details

_property

protected final BeanProperty _property

Method used for setting "any" properties, along with annotation information. Retained to allow contextualization of any properties.

_setter

protected final AnnotatedMember _setter

Annotated variant is needed for JDK serialization only

_setterIsField

protected final boolean _setterIsField

_type

protected final JavaType _type

_valueDeserializer

protected ValueDeserializer<Object> _valueDeserializer

_valueTypeDeserializer

protected final TypeDeserializer _valueTypeDeserializer

_keyDeserializer

protected final KeyDeserializer _keyDeserializer

Constructor Details

SettableAnyProperty

public SettableAnyProperty(BeanProperty property,
 AnnotatedMember setter,
 JavaType type,
 KeyDeserializer keyDeser,
 ValueDeserializer<Object> valueDeser,
 TypeDeserializer typeDeser)

Method Details

constructForMethod

public static SettableAnyProperty constructForMethod(DeserializationContext ctxt,
 BeanProperty property,
 AnnotatedMember field,
 JavaType valueType,
 KeyDeserializer keyDeser,
 ValueDeserializer<Object> valueDeser,
 TypeDeserializer typeDeser)

constructForMapField

public static SettableAnyProperty constructForMapField(DeserializationContext ctxt,
 BeanProperty property,
 AnnotatedMember field,
 JavaType valueType,
 KeyDeserializer keyDeser,
 ValueDeserializer<Object> valueDeser,
 TypeDeserializer typeDeser)

constructForJsonNodeField

public static SettableAnyProperty constructForJsonNodeField(DeserializationContext ctxt,
 BeanProperty property,
 AnnotatedMember field,
 JavaType valueType,
 ValueDeserializer<Object> valueDeser)

constructForMapParameter

public static SettableAnyProperty constructForMapParameter(DeserializationContext ctxt,
 BeanProperty property,
 AnnotatedMember field,
 JavaType valueType,
 KeyDeserializer keyDeser,
 ValueDeserializer<Object> valueDeser,
 TypeDeserializer typeDeser,
 int parameterIndex)

Since:

2.18

constructForJsonNodeParameter

public static SettableAnyProperty constructForJsonNodeParameter(DeserializationContext ctxt,
 BeanProperty prop,
 AnnotatedMember mutator,
 JavaType valueType,
 ValueDeserializer<Object> valueDeser,
 int parameterIndex)

withValueDeserializer

public abstract SettableAnyProperty withValueDeserializer(ValueDeserializer<Object> deser)

fixAccess

public void fixAccess(DeserializationConfig config)

getProperty

public BeanProperty getProperty()

hasValueDeserializer

public boolean hasValueDeserializer()

getType

public JavaType getType()

getPropertyName

public String getPropertyName()

getParameterIndex

public int getParameterIndex()

Accessor for parameterIndex.

Returns:

-1 if not a parameterized setter, otherwise index of parameter

Since:

2.18

isFieldType

public boolean isFieldType()

Method called to check whether this property is field

Since:

2.18.1

isSetterType

public boolean isSetterType()

Method called to check whether this property is method

Returns:

2.18.2

createParameterObject

public Object createParameterObject()

Create an instance of value to pass through Creator parameter.

Since:

2.18

deserializeAndSet

public void deserializeAndSet(JsonParser p,
 DeserializationContext ctxt,
 Object instance,
 String propName)
                       throws JacksonException

Method called to deserialize appropriate value, given parser (and context), and set it using appropriate method (a setter method).

Throws:

JacksonException

deserialize

public Object deserialize(JsonParser p,
 DeserializationContext ctxt)
                   throws JacksonException

Throws:

JacksonException

set

public void set(DeserializationContext ctxt,
 Object instance,
 Object propName,
 Object value)
         throws JacksonException

Throws:

JacksonException

_set

protected abstract void _set(DeserializationContext ctxt,
 Object instance,
 Object propName,
 Object value)
                      throws Exception

Throws:

Exception

_throwAsIOE

protected void _throwAsIOE(DeserializationContext ctxt,
 Throwable t,
 Object propName,
 Object value)
                    throws JacksonException

Parameters:

t - Exception to re-throw or wrap

propName - Name of property (from Json input) to set

value - Value of the property

Throws:

JacksonException

toString

public String toString()

Overrides:

toString in class Object