Class FieldProperty
- java.lang.Object
-
- com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
-
- com.fasterxml.jackson.databind.deser.SettableBeanProperty
-
- com.fasterxml.jackson.databind.deser.impl.FieldProperty
-
- All Implemented Interfaces:
BeanProperty,Named,Serializable
public final class FieldProperty extends SettableBeanProperty
This concrete sub-class implements property that is set directly assigning to a Field.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.deser.SettableBeanProperty
SettableBeanProperty.Delegating
-
Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.BeanProperty
BeanProperty.Bogus, BeanProperty.Std
-
-
Field Summary
Fields Modifier and Type Field Description protected AnnotatedField_annotatedprotected Field_fieldActual field to set when deserializing this property.protected boolean_skipNulls-
Fields inherited from class com.fasterxml.jackson.databind.deser.SettableBeanProperty
_contextAnnotations, _managedReferenceName, _nullProvider, _objectIdInfo, _propertyIndex, _propName, _type, _valueDeserializer, _valueTypeDeserializer, _viewMatcher, _wrapperName, MISSING_VALUE_DESERIALIZER
-
Fields inherited from class com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
_aliases, _metadata
-
Fields inherited from interface com.fasterxml.jackson.databind.BeanProperty
EMPTY_FORMAT, EMPTY_INCLUDE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFieldProperty(FieldProperty src)Constructor used for JDK Serialization when reading persisted objectprotectedFieldProperty(FieldProperty src, JsonDeserializer<?> deser, NullValueProvider nva)protectedFieldProperty(FieldProperty src, PropertyName newName)FieldProperty(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedField field)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddeserializeAndSet(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object instance)Method called to deserialize appropriate value, given parser (and context), and set it using appropriate mechanism.ObjectdeserializeSetAndReturn(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object instance)Alternative toSettableBeanProperty.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.voidfixAccess(DeserializationConfig config)Method called to ensure that the mutator has proper access rights to be called, as per configuration.<A extends Annotation>
AgetAnnotation(Class<A> acls)Method for finding annotation associated with this property; meaning annotation associated with one of entities used to access property.AnnotatedMembergetMember()Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.voidset(Object instance, Object value)Method called to assign given value to this property, on specified Object.ObjectsetAndReturn(Object instance, Object value)Method called to assign given value to this property, on specified Object, and return whatever delegating accessor returned (if anything)SettableBeanPropertywithName(PropertyName newName)Fluent factory method for constructing and returning a new instance with specified property name.SettableBeanPropertywithNullProvider(NullValueProvider nva)SettableBeanPropertywithValueDeserializer(JsonDeserializer<?> deser)Fluent factory method for constructing and returning a new instance with specified value deserializer.-
Methods inherited from class com.fasterxml.jackson.databind.deser.SettableBeanProperty
_throwAsIOE, _throwAsIOE, _throwAsIOE, _throwAsIOE, assignIndex, depositSchemaProperty, deserialize, deserializeWith, getContextAnnotation, getCreatorIndex, getDeclaringClass, getFullName, getInjectableValueId, getManagedReferenceName, getName, getNullValueProvider, getObjectIdInfo, getPropertyIndex, getType, getValueDeserializer, getValueTypeDeserializer, getWrapperName, hasValueDeserializer, hasValueTypeDeserializer, hasViews, isIgnorable, markAsIgnorable, setManagedReferenceName, setObjectIdInfo, setViews, toString, visibleInView, withSimpleName
-
Methods inherited from class com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
findAliases, findFormatOverrides, findPropertyFormat, findPropertyInclusion, getMetadata, isRequired, isVirtual
-
-
-
-
Field Detail
-
_annotated
protected final AnnotatedField _annotated
-
_field
protected final transient Field _field
Actual field to set when deserializing this property. Transient since there is no need to persist; only needed during construction of objects.
-
_skipNulls
protected final boolean _skipNulls
- Since:
- 2.9
-
-
Constructor Detail
-
FieldProperty
public FieldProperty(BeanPropertyDefinition propDef, JavaType type, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedField field)
-
FieldProperty
protected FieldProperty(FieldProperty src, JsonDeserializer<?> deser, NullValueProvider nva)
-
FieldProperty
protected FieldProperty(FieldProperty src, PropertyName newName)
-
FieldProperty
protected FieldProperty(FieldProperty src)
Constructor used for JDK Serialization when reading persisted object
-
-
Method Detail
-
withName
public SettableBeanProperty withName(PropertyName newName)
Description copied from class:SettableBeanPropertyFluent 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:
withNamein classSettableBeanProperty- 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(JsonDeserializer<?> deser)
Description copied from class:SettableBeanPropertyFluent 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:
withValueDeserializerin classSettableBeanProperty- 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:
withNullProviderin classSettableBeanProperty
-
fixAccess
public void fixAccess(DeserializationConfig config)
Description copied from class:SettableBeanPropertyMethod 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:
fixAccessin classSettableBeanProperty
-
getAnnotation
public <A extends Annotation> A getAnnotation(Class<A> acls)
Description copied from interface:BeanPropertyMethod 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 throughAnnotationIntrospector.- Specified by:
getAnnotationin interfaceBeanProperty- Specified by:
getAnnotationin classSettableBeanProperty
-
getMember
public AnnotatedMember getMember()
Description copied from interface:BeanPropertyMethod for accessing primary physical entity that represents the property; annotated field, method or constructor property.- Specified by:
getMemberin interfaceBeanProperty- Specified by:
getMemberin classSettableBeanProperty
-
deserializeAndSet
public void deserializeAndSet(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object instance) throws IOExceptionDescription copied from class:SettableBeanPropertyMethod 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:
deserializeAndSetin classSettableBeanProperty- Throws:
IOException
-
deserializeSetAndReturn
public Object deserializeSetAndReturn(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object instance) throws IOException
Description copied from class:SettableBeanPropertyAlternative toSettableBeanProperty.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.- Specified by:
deserializeSetAndReturnin classSettableBeanProperty- Throws:
IOException
-
set
public void set(Object instance, Object value) throws IOException
Description copied from class:SettableBeanPropertyMethod 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:
setin classSettableBeanProperty- Throws:
IOException
-
setAndReturn
public Object setAndReturn(Object instance, Object value) throws IOException
Description copied from class:SettableBeanPropertyMethod 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:
setAndReturnin classSettableBeanProperty- Throws:
IOException
-
-