Module tools.jackson.databind

Package tools.jackson.databind.deser.impl

Class MethodProperty

java.lang.Object

tools.jackson.databind.introspect.ConcreteBeanPropertyBase

tools.jackson.databind.deser.SettableBeanProperty

tools.jackson.databind.deser.impl.MethodProperty

All Implemented Interfaces:

tools.jackson.core.util.Named, BeanProperty, FullyNamed

public final class MethodProperty
extends SettableBeanProperty

This concrete sub-class implements property that is set using a MethodHandle to the setter, which is either a setter method or a field setter.

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.deser.SettableBeanProperty

SettableBeanProperty.Delegating

Nested classes/interfaces inherited from interface tools.jackson.databind.BeanProperty

BeanProperty.Bogus, BeanProperty.Std

Nested classes/interfaces inherited from interface tools.jackson.core.util.Named

tools.jackson.core.util.Named.StringAsNamed

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotatedMember	_annotated
protected final tools.jackson.databind.deser.impl.MethodProperty.SetterHolder	_setter	Setter MethodHandle holder for modifying property value.
protected final tools.jackson.databind.deser.impl.MethodProperty.SetterHolder	_setterReturn	Setter MethodHandle holder for modifying property value and returning the modified bean.
protected final boolean	_skipNulls

Fields inherited from class tools.jackson.databind.deser.SettableBeanProperty

_contextAnnotations, _managedReferenceName, _nullProvider, _objectIdInfo, _propertyIndex, _propName, _type, _valueDeserializer, _valueTypeDeserializer, _viewMatcher, _wrapperName, MISSING_VALUE_DESERIALIZER

Fields inherited from class tools.jackson.databind.introspect.ConcreteBeanPropertyBase

_aliases, _metadata

Fields inherited from interface tools.jackson.databind.BeanProperty

EMPTY_FORMAT, EMPTY_INCLUDE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MethodProperty(MethodProperty src, PropertyName newName)
protected	MethodProperty(MethodProperty src, ValueDeserializer<?> deser, NullValueProvider nva)
	MethodProperty(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedMember annotated)

Method Summary

Modifier and Type	Method	Description
void	deserializeAndSet(tools.jackson.core.JsonParser p, DeserializationContext ctxt, Object instance)	Method called to deserialize appropriate value, given parser (and context), and set it using appropriate mechanism.
Object	deserializeSetAndReturn(tools.jackson.core.JsonParser p, DeserializationContext ctxt, Object instance)	Alternative to SettableBeanProperty.deserializeAndSet(tools.jackson.core.JsonParser, tools.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.
void	fixAccess(DeserializationConfig config)	Method called to ensure that the mutator has proper access rights to be called, as per configuration.
<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.
AnnotatedMember	getMember()	Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
final void	set(DeserializationContext ctxt, Object instance, Object value)	Method called to assign given value to this property, on specified Object.
Object	setAndReturn(DeserializationContext ctxt, Object instance, Object value)	Method called to assign given value to this property, on specified Object, and return whatever delegating accessor returned (if anything)
SettableBeanProperty	withName(PropertyName newName)	Fluent factory method for constructing and returning a new instance with specified property name.
SettableBeanProperty	withNullProvider(NullValueProvider nva)
SettableBeanProperty	withValueDeserializer(ValueDeserializer<?> deser)	Fluent factory method for constructing and returning a new instance with specified value deserializer.

Methods inherited from class tools.jackson.databind.deser.SettableBeanProperty

_throwAsJacksonE, _throwAsJacksonE, assignIndex, depositSchemaProperty, deserialize, deserializeWith, findPropertyInclusion, getContextAnnotation, getCreatorIndex, getDeclaringClass, getFullName, getInjectableValueId, getInjectionDefinition, getManagedReferenceName, getName, getNullValueProvider, getObjectIdInfo, getPropertyIndex, getType, getValueDeserializer, getValueTypeDeserializer, getWrapperName, hasValueDeserializer, hasValueTypeDeserializer, hasViews, isCreatorProperty, isIgnorable, isInjectionOnly, isMerging, markAsIgnorable, setManagedReferenceName, setObjectIdInfo, setViews, toString, unwrapped, visibleInView, withSimpleName

Methods inherited from class tools.jackson.databind.introspect.ConcreteBeanPropertyBase

findAliases, findFormatOverrides, findPropertyFormat, getMetadata, isRequired, isVirtual

Methods inherited from class java.lang.Object

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

Methods inherited from interface tools.jackson.databind.util.FullyNamed

hasName

Field Details

_annotated

protected final AnnotatedMember _annotated

_setter

protected final tools.jackson.databind.deser.impl.MethodProperty.SetterHolder _setter

Setter MethodHandle holder for modifying property value.

_setterReturn

protected final tools.jackson.databind.deser.impl.MethodProperty.SetterHolder _setterReturn

Setter MethodHandle holder for modifying property value and returning the modified bean.

_skipNulls

protected final boolean _skipNulls

Constructor Details

MethodProperty

public MethodProperty(BeanPropertyDefinition propDef,
 JavaType type,
 TypeDeserializer typeDeser,
 Annotations contextAnnotations,
 AnnotatedMember annotated)

MethodProperty

protected MethodProperty(MethodProperty src,
 ValueDeserializer<?> deser,
 NullValueProvider nva)

MethodProperty

protected MethodProperty(MethodProperty src,
 PropertyName newName)

Method Details

withName

public SettableBeanProperty withName(PropertyName newName)

Description copied from class: SettableBeanProperty

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

Specified by:

withName in class SettableBeanProperty

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.

withValueDeserializer

public SettableBeanProperty withValueDeserializer(ValueDeserializer<?> deser)

Description copied from class: SettableBeanProperty

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.

Specified by:

withValueDeserializer in class SettableBeanProperty

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.

withNullProvider

public SettableBeanProperty withNullProvider(NullValueProvider nva)

Specified by:

withNullProvider in class SettableBeanProperty

fixAccess

public void fixAccess(DeserializationConfig config)

Description copied from class: SettableBeanProperty

Method called to ensure that the mutator has proper access rights to be called, as per configuration. Overridden by implementations that have mutators that require access, fields and setters.

Overrides:

fixAccess in class SettableBeanProperty

getAnnotation

public <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.

Note that this method should only be called for custom annotations; access to standard Jackson annotations (or ones supported by alternate AnnotationIntrospectors) should be accessed through AnnotationIntrospector.

Specified by:

getAnnotation in interface BeanProperty

Specified by:

getAnnotation in class SettableBeanProperty

getMember

public 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

Specified by:

getMember in class SettableBeanProperty

deserializeAndSet

public void deserializeAndSet(tools.jackson.core.JsonParser p,
 DeserializationContext ctxt,
 Object instance)
                       throws tools.jackson.core.JacksonException

Description copied from class: SettableBeanProperty

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

Specified by:

deserializeAndSet in class SettableBeanProperty

Throws:

tools.jackson.core.JacksonException

deserializeSetAndReturn

public Object deserializeSetAndReturn(tools.jackson.core.JsonParser p,
 DeserializationContext ctxt,
 Object instance)
                               throws tools.jackson.core.JacksonException

Description copied from class: SettableBeanProperty

Alternative to SettableBeanProperty.deserializeAndSet(tools.jackson.core.JsonParser, tools.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.

Specified by:

deserializeSetAndReturn in class SettableBeanProperty

Throws:

tools.jackson.core.JacksonException

set

public final void set(DeserializationContext ctxt,
 Object instance,
 Object value)
               throws tools.jackson.core.JacksonException

Description copied from class: SettableBeanProperty

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.

Specified by:

set in class SettableBeanProperty

Throws:

tools.jackson.core.JacksonException

setAndReturn

public Object setAndReturn(DeserializationContext ctxt,
 Object instance,
 Object value)
                    throws tools.jackson.core.JacksonException

Description copied from class: SettableBeanProperty

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.

Specified by:

setAndReturn in class SettableBeanProperty

Throws:

tools.jackson.core.JacksonException