Class BeanDeserializerBuilder


  • public class BeanDeserializerBuilder
    extends java.lang.Object
    Builder class used for aggregating deserialization information about a POJO, in order to build a JsonDeserializer for deserializing intances.
    Since:
    1.7
    • Field Detail

      • _properties

        protected final java.util.HashMap<java.lang.String,​SettableBeanProperty> _properties
        Properties to deserialize collected so far.

        Note: since 1.9.1, LinkedHashMap has been used, since preservation of order is actually important for some use cases.

      • _injectables

        protected java.util.List<ValueInjector> _injectables
        Value injectors for deserialization
        Since:
        1.9
      • _backRefProperties

        protected java.util.HashMap<java.lang.String,​SettableBeanProperty> _backRefProperties
        Back-reference properties this bean contains (if any)
      • _ignorableProps

        protected java.util.HashSet<java.lang.String> _ignorableProps
        Set of names of properties that are recognized but are to be ignored for deserialization purposes (meaning no exception is thrown, value is just skipped).
      • _valueInstantiator

        protected ValueInstantiator _valueInstantiator
        Object that will handle value instantiation for the bean type.
        Since:
        1.9
      • _anySetter

        protected SettableAnyProperty _anySetter
        Fallback setter used for handling any properties that are not mapped to regular setters. If setter is not null, it will be called once for each such property.
      • _ignoreAllUnknown

        protected boolean _ignoreAllUnknown
        Flag that can be set to ignore and skip unknown properties. If set, will not throw an exception for unknown properties.
    • Constructor Detail

      • BeanDeserializerBuilder

        protected BeanDeserializerBuilder​(BeanDeserializerBuilder src)
        Copy constructor for sub-classes to use, when constructing custom builder instances
        Since:
        1.9
    • Method Detail

      • addOrReplaceProperty

        public void addOrReplaceProperty​(SettableBeanProperty prop,
                                         boolean allowOverride)
        Method for adding a new property or replacing a property.
      • addProperty

        public void addProperty​(SettableBeanProperty prop)
        Method to add a property setter. Will ensure that there is no unexpected override; if one is found will throw a IllegalArgumentException.
      • addBackReferenceProperty

        public void addBackReferenceProperty​(java.lang.String referenceName,
                                             SettableBeanProperty prop)
        Method called to add a property that represents so-called back reference; reference that "points back" to object that has forward reference to currently built bean.
      • addInjectable

        public void addInjectable​(java.lang.String propertyName,
                                  JavaType propertyType,
                                  Annotations contextAnnotations,
                                  AnnotatedMember member,
                                  java.lang.Object valueId)
        Since:
        1.9
      • addIgnorable

        public void addIgnorable​(java.lang.String propName)
        Method that will add property name as one of properties that can be ignored if not recognized.
      • addCreatorProperty

        public void addCreatorProperty​(BeanPropertyDefinition propDef)
        Method called by deserializer factory, when a "creator property" (something that is passed via constructor- or factory method argument; instead of setter or field).

        Default implementation does not do anything; we may need to revisit this decision if these properties need to be available through accessors. For now, however, we just have to ensure that we don't try to resolve types that masked setter/field has (see [JACKSON-700] for details).

        Since:
        1.9.2
      • setIgnoreUnknownProperties

        public void setIgnoreUnknownProperties​(boolean ignore)
      • setValueInstantiator

        public void setValueInstantiator​(ValueInstantiator inst)
        Since:
        1.9
      • getProperties

        public java.util.Iterator<SettableBeanProperty> getProperties()
        Method that allows accessing all properties that this builder currently contains.

        Note that properties are returned in order that properties are ordered (explictly, or by rule), which is the serialization order.

        Since:
        1.8.3
      • hasProperty

        public boolean hasProperty​(java.lang.String propertyName)