Class CreatorProperty

  • All Implemented Interfaces:
    BeanProperty, Named, java.io.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
    • 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 com.fasterxml.jackson.annotation.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
    • Method Detail

      • construct

        public static CreatorProperty construct​(PropertyName name,
                                                JavaType type,
                                                PropertyName wrapperName,
                                                TypeDeserializer typeDeser,
                                                Annotations contextAnnotations,
                                                AnnotatedParameter param,
                                                int index,
                                                com.fasterxml.jackson.annotation.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.
      • 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
      • inject

        @Deprecated
        public void inject​(DeserializationContext context,
                           java.lang.Object beanInstance)
                    throws java.io.IOException
        Deprecated.
        Throws:
        java.io.IOException
      • getAnnotation

        public <A extends java.lang.annotation.Annotation> A getAnnotation​(java.lang.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
      • deserializeAndSet

        public void deserializeAndSet​(com.fasterxml.jackson.core.JsonParser p,
                                      DeserializationContext ctxt,
                                      java.lang.Object instance)
                               throws java.io.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:
        java.io.IOException
      • set

        public void set​(java.lang.Object instance,
                        java.lang.Object value)
                 throws java.io.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:
        java.io.IOException
      • setAndReturn

        public java.lang.Object setAndReturn​(java.lang.Object instance,
                                             java.lang.Object value)
                                      throws java.io.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:
        java.io.IOException
      • 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.