Class BeanDeserializerBuilder

java.lang.Object
com.fasterxml.jackson.databind.deser.BeanDeserializerBuilder

public class BeanDeserializerBuilder extends Object
Builder class used for aggregating deserialization information about a POJO, in order to build a JsonDeserializer for deserializing instances.
  • Constructor Details

  • Method Details

    • 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(String referenceName, SettableBeanProperty prop) throws JsonMappingException
      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.
      Throws:
      JsonMappingException
    • addInjectable

      public void addInjectable(PropertyName propName, JavaType propType, Annotations contextAnnotations, AnnotatedMember member, Object valueId) throws JsonMappingException
      Throws:
      JsonMappingException
    • addIgnorable

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

      public void addIncludable(String propName)
      Method that will add property name as one of the properties that will be included.
      Since:
      2.12
    • addCreatorProperty

      public void addCreatorProperty(SettableBeanProperty prop)
      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).

    • setAnySetter

      public void setAnySetter(SettableAnyProperty s)
    • setIgnoreUnknownProperties

      public void setIgnoreUnknownProperties(boolean ignore)
    • setValueInstantiator

      public void setValueInstantiator(ValueInstantiator inst)
    • setObjectIdReader

      public void setObjectIdReader(ObjectIdReader r)
    • setPOJOBuilder

      public void setPOJOBuilder(AnnotatedMethod buildMethod, JsonPOJOBuilder.Value config)
    • getProperties

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

    • findProperty

      public SettableBeanProperty findProperty(PropertyName propertyName)
    • hasProperty

      public boolean hasProperty(PropertyName propertyName)
    • removeProperty

      public SettableBeanProperty removeProperty(PropertyName name)
    • getAnySetter

      public SettableAnyProperty getAnySetter()
    • getValueInstantiator

      public ValueInstantiator getValueInstantiator()
    • getInjectables

      public List<ValueInjector> getInjectables()
    • getObjectIdReader

      public ObjectIdReader getObjectIdReader()
    • getBuildMethod

      public AnnotatedMethod getBuildMethod()
    • getBuilderConfig

      public JsonPOJOBuilder.Value getBuilderConfig()
    • hasIgnorable

      public boolean hasIgnorable(String name)
      Since:
      2.9.4
    • build

      public JsonDeserializer<?> build() throws JsonMappingException
      Method for constructing a BeanDeserializer, given all information collected.
      Throws:
      JsonMappingException
    • buildAbstract

      public AbstractDeserializer buildAbstract()
      Alternate build method used when we must be using some form of abstract resolution, usually by using addition Type Id ("polymorphic deserialization")
      Since:
      2.0
    • buildBuilderBased

      public JsonDeserializer<?> buildBuilderBased(JavaType valueType, String expBuildMethodName) throws JsonMappingException
      Method for constructing a specialized deserializer that uses additional external Builder object during data binding.
      Throws:
      JsonMappingException