Module tools.jackson.databind
Package tools.jackson.databind.introspect

Class ConcreteBeanPropertyBase

java.lang.Object
tools.jackson.databind.introspect.ConcreteBeanPropertyBase
All Implemented Interfaces:
Named, BeanProperty, FullyNamed
Direct Known Subclasses:
PropertyWriter, SettableBeanProperty
public abstract class ConcreteBeanPropertyBase extends Object implements BeanProperty
Intermediate BeanProperty class shared by concrete readable- and writable property implementations for sharing common functionality.

  • Field Details

  • Constructor Details

  • Method Details

    • isRequired

      public boolean isRequired()
      Description copied from interface: BeanProperty
      Whether value for property is marked as required using annotations or associated schema. Equivalent to: getMetadata().isRequired()
      Specified by:
      isRequired in interface BeanProperty

    • getMetadata

      public PropertyMetadata getMetadata()
      Description copied from interface: BeanProperty
      Accessor for additional optional information about property.
      Specified by:
      getMetadata in interface BeanProperty
      Returns:
      Metadata about property; never null.

    • isVirtual

      public boolean isVirtual()
      Description copied from interface: BeanProperty
      Accessor for checking whether there is an actual physical property behind this property abstraction or not.
      Specified by:
      isVirtual in interface BeanProperty

    • findFormatOverrides

      public JsonFormat.Value findFormatOverrides(MapperConfig<?> config)
      Description copied from interface: BeanProperty
      Helper method used to only access property-specified format overrides, if any, not considering type or global default format settings.
      Specified by:
      findFormatOverrides in interface BeanProperty
      Returns:
      Format override settings if any; `null` if no overrides

    • findPropertyFormat

      public JsonFormat.Value findPropertyFormat(MapperConfig<?> config, Class<?> baseType)
      Description copied from interface: BeanProperty
      Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings
      Specified by:
      findPropertyFormat in interface BeanProperty

    • findPropertyInclusion

      public JsonInclude.Value findPropertyInclusion(MapperConfig<?> config, Class<?> baseType)
      Description copied from interface: BeanProperty
      Convenience method that is roughly equivalent to 
         return config.getAnnotationIntrospector().findPropertyInclusion(getMember());
      but also considers global default settings for inclusion
      Specified by:
      findPropertyInclusion in interface BeanProperty

    • findAliases

      public List<PropertyName> findAliases(MapperConfig<?> config)
      Description copied from interface: BeanProperty
      Method for accessing set of possible alternate names that are accepted during deserialization.
      Specified by:
      findAliases in interface BeanProperty
      Returns:
      List (possibly empty) of alternate names; never null