Class SettableBeanProperty.Delegating
- java.lang.Object
-
- com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
-
- com.fasterxml.jackson.databind.deser.SettableBeanProperty
-
- com.fasterxml.jackson.databind.deser.SettableBeanProperty.Delegating
-
- All Implemented Interfaces:
BeanProperty,Named,Serializable
- Direct Known Subclasses:
InnerClassProperty,ManagedReferenceProperty,MergingSettableBeanProperty
- Enclosing class:
- SettableBeanProperty
public abstract static class SettableBeanProperty.Delegating extends SettableBeanProperty
Helper class that is designed to both make it easier to sub-class delegating subtypes and to reduce likelihood of breakage when new methods are added.Class was specifically added to help with
Afterburnermodule, but its use is not limited to only support it.- Since:
- 2.9
- 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 SettableBeanPropertydelegate-
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 protectedDelegating(SettableBeanProperty d)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected SettableBeanProperty_with(SettableBeanProperty newDelegate)voidassignIndex(int index)Method used to assign index for property.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.intgetCreatorIndex()Method for accessing index of the creator property: for other types of properties will simply return -1.protected Class<?>getDeclaringClass()SettableBeanPropertygetDelegate()ObjectgetInjectableValueId()Accessor for id of injectable value, if this bean property supports value injection.StringgetManagedReferenceName()AnnotatedMembergetMember()Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.ObjectIdInfogetObjectIdInfo()intgetPropertyIndex()Method for accessing unique index of this property; indexes are assigned once all properties of aBeanDeserializerhave been collected.JsonDeserializer<Object>getValueDeserializer()TypeDeserializergetValueTypeDeserializer()booleanhasValueDeserializer()booleanhasValueTypeDeserializer()booleanhasViews()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)booleanvisibleInView(Class<?> activeView)protected abstract SettableBeanPropertywithDelegate(SettableBeanProperty d)Method sub-classes must implement, to construct a new instance with given delegate.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, depositSchemaProperty, deserialize, deserializeWith, getContextAnnotation, getFullName, getName, getNullValueProvider, getType, getWrapperName, isIgnorable, markAsIgnorable, setManagedReferenceName, setObjectIdInfo, setViews, toString, withSimpleName
-
Methods inherited from class com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
findAliases, findFormatOverrides, findPropertyFormat, findPropertyInclusion, getMetadata, isRequired, isVirtual
-
-
-
-
Field Detail
-
delegate
protected final SettableBeanProperty delegate
-
-
Constructor Detail
-
Delegating
protected Delegating(SettableBeanProperty d)
-
-
Method Detail
-
withDelegate
protected abstract SettableBeanProperty withDelegate(SettableBeanProperty d)
Method sub-classes must implement, to construct a new instance with given delegate.
-
_with
protected SettableBeanProperty _with(SettableBeanProperty newDelegate)
-
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.
-
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.
-
withNullProvider
public SettableBeanProperty withNullProvider(NullValueProvider nva)
- Specified by:
withNullProviderin classSettableBeanProperty
-
assignIndex
public void assignIndex(int index)
Description copied from class:SettableBeanPropertyMethod used to assign index for property.- Overrides:
assignIndexin 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
-
getDeclaringClass
protected Class<?> getDeclaringClass()
- Overrides:
getDeclaringClassin classSettableBeanProperty
-
getManagedReferenceName
public String getManagedReferenceName()
- Overrides:
getManagedReferenceNamein classSettableBeanProperty
-
getObjectIdInfo
public ObjectIdInfo getObjectIdInfo()
- Overrides:
getObjectIdInfoin classSettableBeanProperty
-
hasValueDeserializer
public boolean hasValueDeserializer()
- Overrides:
hasValueDeserializerin classSettableBeanProperty
-
hasValueTypeDeserializer
public boolean hasValueTypeDeserializer()
- Overrides:
hasValueTypeDeserializerin classSettableBeanProperty
-
getValueDeserializer
public JsonDeserializer<Object> getValueDeserializer()
- Overrides:
getValueDeserializerin classSettableBeanProperty
-
getValueTypeDeserializer
public TypeDeserializer getValueTypeDeserializer()
- Overrides:
getValueTypeDeserializerin classSettableBeanProperty
-
visibleInView
public boolean visibleInView(Class<?> activeView)
- Overrides:
visibleInViewin classSettableBeanProperty
-
hasViews
public boolean hasViews()
- Overrides:
hasViewsin classSettableBeanProperty
-
getPropertyIndex
public int getPropertyIndex()
Description copied from class:SettableBeanPropertyMethod for accessing unique index of this property; indexes are assigned once all properties of aBeanDeserializerhave been collected.- Overrides:
getPropertyIndexin classSettableBeanProperty- Returns:
- Index of this property
-
getCreatorIndex
public int getCreatorIndex()
Description copied from class:SettableBeanPropertyMethod for accessing index of the creator property: for other types of properties will simply return -1.- Overrides:
getCreatorIndexin classSettableBeanProperty
-
getInjectableValueId
public Object getInjectableValueId()
Description copied from class:SettableBeanPropertyAccessor for id of injectable value, if this bean property supports value injection.- Overrides:
getInjectableValueIdin 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
-
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
-
getDelegate
public SettableBeanProperty getDelegate()
-
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
-
-