public class CreatorProperty extends SettableBeanProperty
Note on injectable values: unlike with other mutators, where deserializer and injecting are separate, here we treat the two as related things. This is necessary to add proper priority, as well as to simplify coordination.
SettableBeanProperty.Delegating
BeanProperty.Bogus, BeanProperty.Std
Modifier and Type | Field and Description |
---|---|
protected AnnotatedParameter |
_annotated
Placeholder that represents constructor parameter, when it is created
from actual constructor.
|
protected int |
_creatorIndex |
protected SettableBeanProperty |
_fallbackSetter
In special cases, when implementing "updateValue", we cannot use
constructors or factory methods, but have to fall back on using a
setter (or mutable field property).
|
protected boolean |
_ignorable
Marker flag that may have to be set during construction, to indicate that
although property may have been constructed and added as a placeholder,
it represents something that should be ignored during deserialization.
|
protected JacksonInject.Value |
_injectableValue
Id of value to inject, if value injection should be used for this parameter
(in addition to, or instead of, regular deserialization).
|
_contextAnnotations, _managedReferenceName, _nullProvider, _objectIdInfo, _propertyIndex, _propName, _type, _valueDeserializer, _valueTypeDeserializer, _viewMatcher, _wrapperName, MISSING_VALUE_DESERIALIZER
_aliases, _metadata
EMPTY_FORMAT, EMPTY_INCLUDE
Modifier | Constructor and Description |
---|---|
protected |
CreatorProperty(CreatorProperty src,
JsonDeserializer<?> deser,
NullValueProvider nva) |
protected |
CreatorProperty(CreatorProperty src,
PropertyName newName) |
protected |
CreatorProperty(PropertyName name,
JavaType type,
PropertyName wrapperName,
TypeDeserializer typeDeser,
Annotations contextAnnotations,
AnnotatedParameter param,
int index,
JacksonInject.Value injectable,
PropertyMetadata metadata) |
|
CreatorProperty(PropertyName name,
JavaType type,
PropertyName wrapperName,
TypeDeserializer typeDeser,
Annotations contextAnnotations,
AnnotatedParameter param,
int index,
Object injectableValueId,
PropertyMetadata metadata)
Deprecated.
Since 2.11 use factory method instead
|
Modifier and Type | Method and Description |
---|---|
static CreatorProperty |
construct(PropertyName name,
JavaType type,
PropertyName wrapperName,
TypeDeserializer typeDeser,
Annotations contextAnnotations,
AnnotatedParameter param,
int index,
JacksonInject.Value injectable,
PropertyMetadata metadata)
Factory method for creating
CreatorProperty instances |
void |
deserializeAndSet(JsonParser p,
DeserializationContext ctxt,
Object instance)
Method called to deserialize appropriate value, given parser (and
context), and set it using appropriate mechanism.
|
Object |
deserializeSetAndReturn(JsonParser p,
DeserializationContext ctxt,
Object instance)
Alternative to
SettableBeanProperty.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. |
Object |
findInjectableValue(DeserializationContext context,
Object beanInstance)
Deprecated.
|
void |
fixAccess(DeserializationConfig config)
Method called to ensure that the mutator has proper access rights to
be called, as per configuration.
|
<A extends Annotation> |
getAnnotation(Class<A> acls)
Method for finding annotation associated with this property;
meaning annotation associated with one of entities used to
access property.
|
int |
getCreatorIndex()
Method for accessing index of the creator property: for other
types of properties will simply return -1.
|
Object |
getInjectableValueId()
Accessor for id of injectable value, if this bean property supports
value injection.
|
AnnotatedMember |
getMember()
Method for accessing primary physical entity that represents the property;
annotated field, method or constructor property.
|
PropertyMetadata |
getMetadata()
Accessor for additional optional information about property.
|
void |
inject(DeserializationContext context,
Object beanInstance)
Deprecated.
|
boolean |
isIgnorable() |
boolean |
isInjectionOnly()
Accessor for checking whether this property is injectable, and if so,
ONLY injectable (will not bind from input).
|
void |
markAsIgnorable() |
void |
set(Object instance,
Object value)
Method called to assign given value to this property, on
specified Object.
|
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 |
setFallbackSetter(SettableBeanProperty fallbackSetter)
NOTE: one exception to immutability, due to problems with CreatorProperty instances
being shared between Bean, separate PropertyBasedCreator
|
String |
toString() |
SettableBeanProperty |
withName(PropertyName newName)
Fluent factory method for constructing and returning a new instance
with specified property name.
|
SettableBeanProperty |
withNullProvider(NullValueProvider nva) |
SettableBeanProperty |
withValueDeserializer(JsonDeserializer<?> deser)
Fluent factory method for constructing and returning a new instance
with specified value deserializer.
|
_throwAsIOE, _throwAsIOE, _throwAsIOE, _throwAsIOE, assignIndex, depositSchemaProperty, deserialize, deserializeWith, getContextAnnotation, getDeclaringClass, getFullName, getManagedReferenceName, getName, getNullValueProvider, getObjectIdInfo, getPropertyIndex, getType, getValueDeserializer, getValueTypeDeserializer, getWrapperName, hasValueDeserializer, hasValueTypeDeserializer, hasViews, setManagedReferenceName, setObjectIdInfo, setViews, visibleInView, withSimpleName
findAliases, findFormatOverrides, findPropertyFormat, findPropertyInclusion, isRequired, isVirtual
protected final AnnotatedParameter _annotated
protected final JacksonInject.Value _injectableValue
protected SettableBeanProperty _fallbackSetter
Mutable only to allow setting after construction, but must be strictly set before any use.
protected final int _creatorIndex
protected boolean _ignorable
protected CreatorProperty(PropertyName name, JavaType type, PropertyName wrapperName, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedParameter param, int index, JacksonInject.Value injectable, PropertyMetadata metadata)
@Deprecated public CreatorProperty(PropertyName name, JavaType type, PropertyName wrapperName, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedParameter param, int index, Object injectableValueId, PropertyMetadata metadata)
protected CreatorProperty(CreatorProperty src, PropertyName newName)
protected CreatorProperty(CreatorProperty src, JsonDeserializer<?> deser, NullValueProvider nva)
public static CreatorProperty construct(PropertyName name, JavaType type, PropertyName wrapperName, TypeDeserializer typeDeser, Annotations contextAnnotations, AnnotatedParameter param, int index, JacksonInject.Value injectable, PropertyMetadata metadata)
CreatorProperty
instancesname
- Name of the logical propertytype
- Type of the property, used to find deserializerwrapperName
- Possible wrapper to use for logical property, if anytypeDeser
- Type deserializer to use for handling polymorphic type
information, if one is neededcontextAnnotations
- Contextual annotations (usually by class that
declares creator [constructor, factory method] that includes
this property)param
- Representation of property, constructor or factory
method parameter; used for accessing annotations of the propertyinjectable
- Information about injectable value, if anyindex
- Index of this property within creator invocationpublic SettableBeanProperty withName(PropertyName newName)
SettableBeanProperty
withName
in class SettableBeanProperty
newName
- Name to use for the new instance.public SettableBeanProperty withValueDeserializer(JsonDeserializer<?> deser)
SettableBeanProperty
withValueDeserializer
in class SettableBeanProperty
deser
- Deserializer to assign to the new property instancepublic SettableBeanProperty withNullProvider(NullValueProvider nva)
withNullProvider
in class SettableBeanProperty
public void fixAccess(DeserializationConfig config)
SettableBeanProperty
fixAccess
in class SettableBeanProperty
public void setFallbackSetter(SettableBeanProperty fallbackSetter)
public void markAsIgnorable()
markAsIgnorable
in class SettableBeanProperty
public boolean isIgnorable()
isIgnorable
in class SettableBeanProperty
@Deprecated public Object findInjectableValue(DeserializationContext context, Object beanInstance) throws JsonMappingException
JsonMappingException
@Deprecated public void inject(DeserializationContext context, Object beanInstance) throws IOException
IOException
public <A extends Annotation> A getAnnotation(Class<A> acls)
BeanProperty
Note that this method should only be called for custom annotations;
access to standard Jackson annotations (or ones supported by
alternate AnnotationIntrospector
s) should be accessed
through AnnotationIntrospector
.
getAnnotation
in interface BeanProperty
getAnnotation
in class SettableBeanProperty
public AnnotatedMember getMember()
BeanProperty
getMember
in interface BeanProperty
getMember
in class SettableBeanProperty
public int getCreatorIndex()
SettableBeanProperty
getCreatorIndex
in class SettableBeanProperty
public void deserializeAndSet(JsonParser p, DeserializationContext ctxt, Object instance) throws IOException
SettableBeanProperty
deserializeAndSet
in class SettableBeanProperty
IOException
public Object deserializeSetAndReturn(JsonParser p, DeserializationContext ctxt, Object instance) throws IOException
SettableBeanProperty
SettableBeanProperty.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.deserializeSetAndReturn
in class SettableBeanProperty
IOException
public void set(Object instance, Object value) throws IOException
SettableBeanProperty
Note: this is an optional operation, not supported by all implementations, creator-backed properties for example do not support this method.
set
in class SettableBeanProperty
IOException
public Object setAndReturn(Object instance, Object value) throws IOException
SettableBeanProperty
Note: this is an optional operation, not supported by all implementations, creator-backed properties for example do not support this method.
setAndReturn
in class SettableBeanProperty
IOException
public PropertyMetadata getMetadata()
BeanProperty
getMetadata
in interface BeanProperty
getMetadata
in class ConcreteBeanPropertyBase
public Object getInjectableValueId()
SettableBeanProperty
getInjectableValueId
in class SettableBeanProperty
public boolean isInjectionOnly()
SettableBeanProperty
true
for Creator-backed properties.isInjectionOnly
in class SettableBeanProperty
public String toString()
toString
in class SettableBeanProperty
Copyright © 2008–2020 FasterXML. All rights reserved.