CreatorProperty (jackson-databind 2.15.0)

java.lang.Object
- com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
- - com.fasterxml.jackson.databind.deser.SettableBeanProperty
  - - com.fasterxml.jackson.databind.deser.CreatorProperty

All Implemented Interfaces:

BeanProperty, Named, Serializable
```
public class CreatorProperty
extends SettableBeanProperty
```
This concrete sub-class implements property that is passed via Creator (constructor or static factory method). It is not a full-featured implementation in that its set method should usually not be called for primary mutation -- instead, value must separately passed -- but some aspects are still needed (specifically, injection).
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.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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> A`	`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.

Methods inherited from class com.fasterxml.jackson.databind.deser.SettableBeanProperty
_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

Methods inherited from class com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase
findAliases, findFormatOverrides, findPropertyFormat, findPropertyInclusion, isRequired, isVirtual

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - _annotated
```
protected final AnnotatedParameter _annotated
```
    Placeholder that represents constructor parameter, when it is created from actual constructor. May be null when a synthetic instance is created.
  - _injectableValue
```
protected final 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).
    
    Since:
    
    2.11
  - _fallbackSetter
```
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). If so, this refers to that fallback accessor.
    Mutable only to allow setting after construction, but must be strictly set before any use.
    
    Since:
    
    2.3
  - _creatorIndex
```
protected final int _creatorIndex
```
    Since:
    
    2.1
  - _ignorable
```
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. This mostly concerns Creator properties which may not be easily deleted during processing.
    
    Since:
    
    2.9.4
- Constructor Detail
  - CreatorProperty
```
protected CreatorProperty(PropertyName name,
                          JavaType type,
                          PropertyName wrapperName,
                          TypeDeserializer typeDeser,
                          Annotations contextAnnotations,
                          AnnotatedParameter param,
                          int index,
                          JacksonInject.Value injectable,
                          PropertyMetadata metadata)
```
    Since:
    
    2.11
  - CreatorProperty
```
@Deprecated
public 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
  - CreatorProperty
```
protected CreatorProperty(CreatorProperty src,
                          PropertyName newName)
```
    Since:
    
    2.3
  - CreatorProperty
```
protected CreatorProperty(CreatorProperty src,
                          JsonDeserializer<?> deser,
                          NullValueProvider nva)
```
- Method Detail
  - construct
```
public 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
    
    Parameters:
    
    name - Name of the logical property
    
    type - Type of the property, used to find deserializer
    
    wrapperName - Possible wrapper to use for logical property, if any
    
    typeDeser - Type deserializer to use for handling polymorphic type information, if one is needed
    
    contextAnnotations - 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 property
    
    injectable - Information about injectable value, if any
    
    index - Index of this property within creator invocation
    
    Since:
    
    2.11
  - 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(JsonDeserializer<?> 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
  - setFallbackSetter
```
public void setFallbackSetter(SettableBeanProperty fallbackSetter)
```
    NOTE: one exception to immutability, due to problems with CreatorProperty instances being shared between Bean, separate PropertyBasedCreator
    
    Since:
    
    2.6
  - markAsIgnorable
```
public void markAsIgnorable()
```
    Overrides:
    
    markAsIgnorable in class SettableBeanProperty
  - isIgnorable
```
public boolean isIgnorable()
```
    Overrides:
    
    isIgnorable in class SettableBeanProperty
  - findInjectableValue
```
@Deprecated
public Object findInjectableValue(DeserializationContext context,
                                              Object beanInstance)
                                       throws JsonMappingException
```
    Deprecated.
    
    Throws:
    
    JsonMappingException
  - inject
```
@Deprecated
public void inject(DeserializationContext context,
                               Object beanInstance)
                        throws IOException
```
    Deprecated.
    
    Throws:
    
    IOException
  - 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
  - getCreatorIndex
```
public int getCreatorIndex()
```
    Description copied from class: SettableBeanProperty
    
    Method for accessing index of the creator property: for other types of properties will simply return -1.
    
    Overrides:
    
    getCreatorIndex in class SettableBeanProperty
  - deserializeAndSet
```
public void deserializeAndSet(JsonParser p,
                              DeserializationContext ctxt,
                              Object instance)
                       throws IOException
```
    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:
    
    IOException
  - deserializeSetAndReturn
```
public Object deserializeSetAndReturn(JsonParser p,
                                      DeserializationContext ctxt,
                                      Object instance)
                               throws IOException
```
    Description copied from class: SettableBeanProperty
    
    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. Mostly used to support Builder style deserialization.
    
    Specified by:
    
    deserializeSetAndReturn in class SettableBeanProperty
    
    Throws:
    
    IOException
  - set
```
public void set(Object instance,
                Object value)
         throws IOException
```
    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:
    
    IOException
  - setAndReturn
```
public Object setAndReturn(Object instance,
                           Object value)
                    throws IOException
```
    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:
    
    IOException
  - getMetadata
```
public PropertyMetadata getMetadata()
```
    Description copied from interface: BeanProperty
    
    Accessor for additional optional information about property.
    
    Specified by:
    
    getMetadata in interface BeanProperty
    
    Overrides:
    
    getMetadata in class ConcreteBeanPropertyBase
    
    Returns:
    
    Metadata about property; never null.
  - getInjectableValueId
```
public Object getInjectableValueId()
```
    Description copied from class: SettableBeanProperty
    
    Accessor for id of injectable value, if this bean property supports value injection.
    
    Overrides:
    
    getInjectableValueId in class SettableBeanProperty
  - isInjectionOnly
```
public boolean isInjectionOnly()
```
    Description copied from class: SettableBeanProperty
    
    Accessor for checking whether this property is injectable, and if so, ONLY injectable (will not bind from input). Currently (2.11) can only return true for Creator-backed properties.
    
    Overrides:
    
    isInjectionOnly in class SettableBeanProperty
    
    Returns:
    
    True if (and only if) property has injector that is also defined NOT to bind from input.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class SettableBeanProperty

Class CreatorProperty

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.deser.SettableBeanProperty

Fields inherited from class com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase

Fields inherited from interface com.fasterxml.jackson.databind.BeanProperty

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.databind.deser.SettableBeanProperty

Methods inherited from class com.fasterxml.jackson.databind.introspect.ConcreteBeanPropertyBase

Methods inherited from class java.lang.Object

Field Detail

_annotated

_injectableValue

_fallbackSetter

_creatorIndex

_ignorable

Constructor Detail

CreatorProperty

CreatorProperty

CreatorProperty

CreatorProperty

Method Detail

construct

withName

withValueDeserializer

withNullProvider

fixAccess

setFallbackSetter

markAsIgnorable

isIgnorable

findInjectableValue

inject

getAnnotation

getMember

getCreatorIndex

deserializeAndSet

deserializeSetAndReturn

set

setAndReturn

getMetadata

getInjectableValueId

isInjectionOnly

toString