Class BeanProperty.Std

  • All Implemented Interfaces:
    BeanProperty, Named, java.io.Serializable
    Direct Known Subclasses:
    ValueInjector
    Enclosing interface:
    BeanProperty

    public static class BeanProperty.Std
    extends java.lang.Object
    implements BeanProperty, java.io.Serializable
    Simple stand-alone implementation, useful as a placeholder or base class for more complex implementations.
    See Also:
    Serialized Form
    • Field Detail

      • _member

        protected final AnnotatedMember _member
        Physical entity (field, method or constructor argument) that is used to access value of property (or in case of constructor property, just placeholder)
    • Method Detail

      • 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
      • getContextAnnotation

        public <A extends java.lang.annotation.Annotation> A getContextAnnotation​(java.lang.Class<A> acls)
        Description copied from interface: BeanProperty
        Method for finding annotation associated with context of this property; usually class in which member is declared (or its subtype if processing subtype).

        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:
        getContextAnnotation in interface BeanProperty
      • findPropertyFormat

        public com.fasterxml.jackson.annotation.JsonFormat.Value findPropertyFormat​(MapperConfig<?> config,
                                                                                    java.lang.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 com.fasterxml.jackson.annotation.JsonInclude.Value findPropertyInclusion​(MapperConfig<?> config,
                                                                                        java.lang.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 java.util.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
      • getName

        public java.lang.String getName()
        Description copied from interface: BeanProperty
        Method to get logical name of the property
        Specified by:
        getName in interface BeanProperty
        Specified by:
        getName in interface Named
      • getFullName

        public PropertyName getFullName()
        Description copied from interface: BeanProperty
        Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
        Specified by:
        getFullName in interface BeanProperty
      • 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.
      • getMember

        public AnnotatedMember getMember()
        Description copied from interface: BeanProperty
        Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
        Specified by:
        getMember in interface BeanProperty
      • 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
      • depositSchemaProperty

        public void depositSchemaProperty​(JsonObjectFormatVisitor objectVisitor,
                                          SerializerProvider provider)
        Implementation of this method throws UnsupportedOperationException, since instances of this implementation should not be used as part of actual structure visited. Rather, other implementations should handle it.
        Specified by:
        depositSchemaProperty in interface BeanProperty
        Parameters:
        objectVisitor - Visitor to used as the callback handler