Class CreatorProperty

  • All Implemented Interfaces:
    BeanProperty, Named

    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 never be called -- instead, value must separately passed.

    Note on injectable values (1.9): unlike with other mutators, where deserializer and injecting are separate, here we deal the two as related things. This is necessary to add proper priority, as well as to simplify coordination.

    Note that this class was moved in Jackson 1.9 from being a static sub-class of "org.codehaus.jackson.map.deser.SettableBeanProperty" into separate class, to make it easier to use it for custom creators.

    • 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.
      • _injectableValueId

        protected final java.lang.Object _injectableValueId
        Id of value to inject, if value injection should be used for this parameter (in addition to, or instead of, regular deserialization).
        Since:
        1.9
    • Constructor Detail

      • CreatorProperty

        public CreatorProperty​(java.lang.String name,
                               JavaType type,
                               TypeDeserializer typeDeser,
                               Annotations contextAnnotations,
                               AnnotatedParameter param,
                               int index,
                               java.lang.Object injectableValueId)
        Parameters:
        name - Name of the logical property
        type - Type of the property, used to find deserializer
        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
    • Method Detail

      • findInjectableValue

        public java.lang.Object findInjectableValue​(DeserializationContext context,
                                                    java.lang.Object beanInstance)
        Method that can be called to locate value to be injected for this property, if it is configured for this.
        Since:
        1.9
      • inject

        public void inject​(DeserializationContext context,
                           java.lang.Object beanInstance)
                    throws java.io.IOException
        Method to find value to inject, and inject it to this property.
        Throws:
        java.io.IOException
        Since:
        1.9
      • 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.
        Specified by:
        getAnnotation in interface BeanProperty
        Specified by:
        getAnnotation in class SettableBeanProperty
      • set

        public void set​(java.lang.Object instance,
                        java.lang.Object value)
                 throws java.io.IOException
        Specified by:
        set in class SettableBeanProperty
        Throws:
        java.io.IOException