com.fasterxml.jackson.databind.deser

Class SettableBeanProperty

java.lang.Object

com.fasterxml.jackson.databind.deser.SettableBeanProperty

All Implemented Interfaces:

BeanProperty, Named, Serializable

Direct Known Subclasses:

CreatorProperty, FieldProperty, InnerClassProperty, ManagedReferenceProperty, MethodProperty, ObjectIdValueProperty, SetterlessProperty

public abstract class SettableBeanProperty
extends Object
implements BeanProperty, Serializable

Base class for deserilizable properties of a bean: contains both type and name definitions, and reflection-based set functionality. Concrete sub-classes implement details, so that field- and setter-backed properties, as well as a few more esoteric variations, can be handled.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.BeanProperty

BeanProperty.Std

Field Summary

Fields

Modifier and Type	Field and Description
protected Annotations	_contextAnnotations Class that contains this property (either class that declares the property or one of its subclasses), class that is deserialized using deserializer that contains this property.
protected boolean	_isRequired Whether value of this property has been marked as required.
protected String	_managedReferenceName If property represents a managed (forward) reference (see [JACKSON-235]), we will need name of reference for later linking.
protected NullProvider	_nullProvider Object used to figure out value to be used when 'null' literal is encountered in JSON.
protected int	_propertyIndex Index of property (within all property of a bean); assigned when all properties have been collected.
protected String	_propName Logical name of the property (often but not always derived from the setter method name)
protected JavaType	_type Base type for property; may be a supertype of actual value.
protected JsonDeserializer<Object>	_valueDeserializer Deserializer used for handling property value.
protected TypeDeserializer	_valueTypeDeserializer If value will contain type information (to support polymorphic handling), this is the type deserializer used to handle type resolution.
protected ViewMatcher	_viewMatcher Helper object used for checking whether this property is to be included in the active view, if property is view-specific; null otherwise.
protected PropertyName	_wrapperName
protected static JsonDeserializer<Object>	MISSING_VALUE_DESERIALIZER To avoid nasty NPEs, let's use a placeholder for _valueDeserializer, if real deserializer is not (yet) available.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SettableBeanProperty(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations)
protected	SettableBeanProperty(SettableBeanProperty src) Basic copy-constructor for sub-classes to use.
protected	SettableBeanProperty(SettableBeanProperty src, JsonDeserializer<?> deser) Copy-with-deserializer-change constructor for sub-classes to use.
protected	SettableBeanProperty(SettableBeanProperty src, String newName) Copy-with-deserializer-change constructor for sub-classes to use.
protected	SettableBeanProperty(String propName, JavaType type, PropertyName wrapper, TypeDeserializer typeDeser, Annotations contextAnnotations) Deprecated.
protected	SettableBeanProperty(String propName, JavaType type, PropertyName wrapper, TypeDeserializer typeDeser, Annotations contextAnnotations, boolean isRequired)

Method Summary

Methods

Modifier and Type	Method and Description
protected IOException	_throwAsIOE(Exception e)
protected void	_throwAsIOE(Exception e, Object value) Method that takes in exception of any type, and casts or wraps it to an IOException or its subclass.
void	assignIndex(int index) Method used to assign index for property.
void	depositSchemaProperty(JsonObjectFormatVisitor objectVisitor) Method that can be called to visit the type structure that this property is part of.
Object	deserialize(JsonParser jp, DeserializationContext ctxt) This method is needed by some specialized bean deserializers, and also called by some deserializeAndSet(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, java.lang.Object) implementations.
abstract void	deserializeAndSet(JsonParser jp, DeserializationContext ctxt, Object instance) Method called to deserialize appropriate value, given parser (and context), and set it using appropriate mechanism.
abstract Object	deserializeSetAndReturn(JsonParser jp, DeserializationContext ctxt, Object instance) Alternative to deserializeAndSet(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, java.lang.Object) that returns either return value of setter method called (if one is), or null to indicate that no return value is available.
abstract <A extends Annotation> A	getAnnotation(Class<A> acls) Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property.
<A extends Annotation> A	getContextAnnotation(Class<A> acls) Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype).
int	getCreatorIndex() Method for accessing index of the creator property: for other types of properties will simply return -1.
protected Class<?>	getDeclaringClass()
Object	getInjectableValueId() Accessor for id of injectable value, if this bean property supports value injection.
String	getManagedReferenceName()
abstract AnnotatedMember	getMember() Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
String	getName() Method to get logical name of the property
int	getPropertyIndex() Method for accessing unique index of this property; indexes are assigned once all properties of a BeanDeserializer have been collected.
JavaType	getType() Method to get declared type of the property.
JsonDeserializer<Object>	getValueDeserializer()
TypeDeserializer	getValueTypeDeserializer()
PropertyName	getWrapperName() If property is indicated to be wrapped, name of wrapper element to use.
boolean	hasValueDeserializer()
boolean	hasValueTypeDeserializer()
boolean	hasViews()
boolean	isRequired() Whether value for property is marked as required using annotations or associated schema.
abstract void	set(Object instance, Object value) Method called to assign given value to this property, on specified Object.
abstract Object	setAndReturn(Object instance, Object value) Method called to assign given value to this property, on specified Object, and return whatever delegating accessor returned (if anything)
void	setManagedReferenceName(String n)
void	setViews(Class<?>[] views)
String	toString()
boolean	visibleInView(Class<?> activeView)
abstract SettableBeanProperty	withName(String newName) Fluent factory method for constructing and returning a new instance with specified propert name.
abstract SettableBeanProperty	withValueDeserializer(JsonDeserializer<?> deser) Fluent factory method for constructing and returning a new instance with specified value deserializer.

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_VALUE_DESERIALIZER

protected static final JsonDeserializer<Object> MISSING_VALUE_DESERIALIZER

To avoid nasty NPEs, let's use a placeholder for _valueDeserializer, if real deserializer is not (yet) available.

Since:

2.2

_propName

protected final String _propName

Logical name of the property (often but not always derived from the setter method name)

_type

protected final JavaType _type

Base type for property; may be a supertype of actual value.

_wrapperName

protected final PropertyName _wrapperName

Since:

2.2

_contextAnnotations

protected final transient Annotations _contextAnnotations

Class that contains this property (either class that declares the property or one of its subclasses), class that is deserialized using deserializer that contains this property.

_valueDeserializer

protected JsonDeserializer<Object> _valueDeserializer

Deserializer used for handling property value.

_valueTypeDeserializer

protected TypeDeserializer _valueTypeDeserializer

If value will contain type information (to support polymorphic handling), this is the type deserializer used to handle type resolution.

_nullProvider

protected NullProvider _nullProvider

Object used to figure out value to be used when 'null' literal is encountered in JSON. For most types simply Java null, but for primitive types must be a non-null value (like Integer.valueOf(0) for int).

_managedReferenceName

protected String _managedReferenceName

If property represents a managed (forward) reference (see [JACKSON-235]), we will need name of reference for later linking.

_viewMatcher

protected ViewMatcher _viewMatcher

Helper object used for checking whether this property is to be included in the active view, if property is view-specific; null otherwise.

_propertyIndex

protected int _propertyIndex

Index of property (within all property of a bean); assigned when all properties have been collected. Order of entries is arbitrary, but once indexes are assigned they are not changed.

_isRequired

protected final boolean _isRequired

Whether value of this property has been marked as required. Retained since it will be needed when traversing type hierarchy for producing schemas (and other similar tasks); currently not used for serialization.

Since:

2.2

Constructor Detail

SettableBeanProperty

protected SettableBeanProperty(BeanPropertyDefinition propDef,
                    JavaType type,
                    TypeDeserializer typeDeser,
                    Annotations contextAnnotations)

SettableBeanProperty

@Deprecated
protected SettableBeanProperty(String propName,
                               JavaType type,
                               PropertyName wrapper,
                               TypeDeserializer typeDeser,
                               Annotations contextAnnotations)

Deprecated.

SettableBeanProperty

protected SettableBeanProperty(String propName,
                    JavaType type,
                    PropertyName wrapper,
                    TypeDeserializer typeDeser,
                    Annotations contextAnnotations,
                    boolean isRequired)

SettableBeanProperty

protected SettableBeanProperty(SettableBeanProperty src)

Basic copy-constructor for sub-classes to use.

SettableBeanProperty

protected SettableBeanProperty(SettableBeanProperty src,
                    JsonDeserializer<?> deser)

Copy-with-deserializer-change constructor for sub-classes to use.

SettableBeanProperty

protected SettableBeanProperty(SettableBeanProperty src,
                    String newName)

Copy-with-deserializer-change constructor for sub-classes to use.

Method Detail

withValueDeserializer

public abstract SettableBeanProperty withValueDeserializer(JsonDeserializer<?> deser)

Fluent factory method for constructing and returning a new instance with specified value deserializer. Note that this method should NOT change configuration of this instance.

Parameters:

deser - Deserializer to assign to the new property instance

Returns:

Newly constructed instance, if value deserializer differs from the one used for this instance; or 'this' if not.

withName

public abstract SettableBeanProperty withName(String newName)

Fluent factory method for constructing and returning a new instance with specified propert name. Note that this method should NOT change configuration of this instance.

Parameters:

newName - Name to use for the new instance.

Returns:

Newly constructed instance, if property name differs from the one used for this instance; or 'this' if not.

setManagedReferenceName

public void setManagedReferenceName(String n)

setViews

public void setViews(Class<?>[] views)

assignIndex

public void assignIndex(int index)

Method used to assign index for property.

getName

public final String getName()

Description copied from interface: BeanProperty

Method to get logical name of the property

Specified by:

getName in interface BeanProperty

Specified by:

getName in interface Named

isRequired

public boolean isRequired()

Description copied from interface: BeanProperty

Whether value for property is marked as required using annotations or associated schema.

Specified by:

isRequired in interface BeanProperty

getType

public JavaType getType()

Description copied from interface: BeanProperty

Method to get declared type of the property.

Specified by:

getType in interface BeanProperty

getWrapperName

public PropertyName getWrapperName()

Description copied from interface: BeanProperty

If property is indicated to be wrapped, name of wrapper element to use.

Specified by:

getWrapperName in interface BeanProperty

getAnnotation

public abstract <A extends Annotation> A getAnnotation(Class<A> acls)

Description copied from interface: BeanProperty

Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property.

Specified by:

getAnnotation in interface BeanProperty

getMember

public abstract AnnotatedMember getMember()

Description copied from interface: BeanProperty

Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.

Specified by:

getMember in interface BeanProperty

getContextAnnotation

public <A extends Annotation> A getContextAnnotation(Class<A> acls)

Description copied from interface: BeanProperty

Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype).

Specified by:

getContextAnnotation in interface BeanProperty

depositSchemaProperty

public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor)
                           throws JsonMappingException

Description copied from interface: BeanProperty

Method that can be called to visit the type structure that this property is part of. Note that not all implementations support traversal with this method; those that do not should throw UnsupportedOperationException.

Specified by:

depositSchemaProperty in interface BeanProperty

Parameters:

objectVisitor - Visitor to used as the callback handler

Throws:

JsonMappingException

getDeclaringClass

protected final Class<?> getDeclaringClass()

getManagedReferenceName

public String getManagedReferenceName()

hasValueDeserializer

public boolean hasValueDeserializer()

hasValueTypeDeserializer

public boolean hasValueTypeDeserializer()

getValueDeserializer

public JsonDeserializer<Object> getValueDeserializer()

getValueTypeDeserializer

public TypeDeserializer getValueTypeDeserializer()

visibleInView

public boolean visibleInView(Class<?> activeView)

hasViews

public boolean hasViews()

getPropertyIndex

public int getPropertyIndex()

Method for accessing unique index of this property; indexes are assigned once all properties of a BeanDeserializer have been collected.

Returns:

Index of this property

getCreatorIndex

public int getCreatorIndex()

Method for accessing index of the creator property: for other types of properties will simply return -1.

Since:

2.1

getInjectableValueId

public Object getInjectableValueId()

Accessor for id of injectable value, if this bean property supports value injection.

deserializeAndSet

public abstract void deserializeAndSet(JsonParser jp,
                     DeserializationContext ctxt,
                     Object instance)
                                throws IOException,
                                       JsonProcessingException

Method called to deserialize appropriate value, given parser (and context), and set it using appropriate mechanism. Pre-condition is that passed parser must point to the first token that should be consumed to produce the value (the only value for scalars, multiple for Objects and Arrays).

Throws:

IOException

JsonProcessingException

deserializeSetAndReturn

public abstract Object deserializeSetAndReturn(JsonParser jp,
                             DeserializationContext ctxt,
                             Object instance)
                                        throws IOException,
                                               JsonProcessingException

Alternative to deserializeAndSet(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, java.lang.Object) that returns either return value of setter method called (if one is), or null to indicate that no return value is available. Mostly used to support Builder style deserialization.

Throws:

IOException

JsonProcessingException

Since:

2.0

set

public abstract void set(Object instance,
       Object value)
                  throws IOException

Method called to assign given value to this property, on specified Object.

Note: this is an optional operation, not supported by all implementations, creator-backed properties for example do not support this method.

Throws:

IOException

setAndReturn

public abstract Object setAndReturn(Object instance,
                  Object value)
                             throws IOException

Method called to assign given value to this property, on specified Object, and return whatever delegating accessor returned (if anything)

Note: this is an optional operation, not supported by all implementations, creator-backed properties for example do not support this method.

Throws:

IOException

Since:

2.0

deserialize

public final Object deserialize(JsonParser jp,
                 DeserializationContext ctxt)
                         throws IOException,
                                JsonProcessingException

This method is needed by some specialized bean deserializers, and also called by some deserializeAndSet(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, java.lang.Object) implementations.

Pre-condition is that passed parser must point to the first token that should be consumed to produce the value (the only value for scalars, multiple for Objects and Arrays).

Note that this method is final for performance reasons: to override functionality you must override other methods that call this method; this method should also not be called directly unless you really know what you are doing (and probably not even then).

Throws:

IOException

JsonProcessingException

_throwAsIOE

protected void _throwAsIOE(Exception e,
               Object value)
                    throws IOException

Method that takes in exception of any type, and casts or wraps it to an IOException or its subclass.

Throws:

IOException

_throwAsIOE

protected IOException _throwAsIOE(Exception e)
                           throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object