Package com.fasterxml.jackson.databind

Interface BeanProperty

    • Method Detail

      • getName

        java.lang.String getName()
        Method to get logical name of the property
        Specified by:
        getName in interface Named

      • getFullName

        PropertyName getFullName()
        Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
        Since:
        2.3

      • getType

        JavaType getType()
        Method to get declared type of the property.

      • getWrapperName

        PropertyName getWrapperName()
        If property is indicated to be wrapped, name of wrapper element to use.
        Since:
        2.2

      • getMetadata

        PropertyMetadata getMetadata()
        Accessor for additional optional information about property.
        Returns:
        Metadata about property; never null.
        Since:
        2.3

      • isRequired

        boolean isRequired()
        Whether value for property is marked as required using annotations or associated schema. Equivalent to: getMetadata().isRequired()
        Since:
        2.2

      • isVirtual

        boolean isVirtual()
        Accessor for checking whether there is an actual physical property behind this property abstraction or not.
        Since:
        2.7

      • getAnnotation

        <A extends java.lang.annotation.Annotation> A getAnnotation​(java.lang.Class<A> acls)
        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.

      • getContextAnnotation

        <A extends java.lang.annotation.Annotation> A getContextAnnotation​(java.lang.Class<A> acls)
        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.

      • getMember

        AnnotatedMember getMember()
        Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.

      • findPropertyFormat

        JsonFormat.Value findPropertyFormat​(MapperConfig<?> config,
                                    java.lang.Class<?> baseType)
        Helper method used to look up format settings applicable to this property, considering both possible per-type configuration settings
        Since:
        2.7

      • findPropertyInclusion

        JsonInclude.Value findPropertyInclusion​(MapperConfig<?> config,
                                        java.lang.Class<?> baseType)
        Convenience method that is roughly equivalent to 
           return config.getAnnotationIntrospector().findPropertyInclusion(getMember());
        but also considers global default settings for inclusion
        Since:
        2.7

      • findAliases

        java.util.List<PropertyName> findAliases​(MapperConfig<?> config)
        Method for accessing set of possible alternate names that are accepted during deserialization.
        Returns:
        List (possibly empty) of alternate names; never null
        Since:
        2.9

      • depositSchemaProperty

        void depositSchemaProperty​(JsonObjectFormatVisitor objectVisitor,
                           SerializerProvider provider)
                    throws JsonMappingException
        Method that can be called to visit the type structure that this property is part of. Note that not all implementations support traversal with this method; those that do not should throw UnsupportedOperationException.

        NOTE: Starting with 2.7, takes explicit SerializerProvider argument to reduce the need to rely on provider visitor may or may not have assigned.

        Parameters:
        objectVisitor - Visitor to used as the callback handler
        Throws:
        JsonMappingException
        Since:
        2.2 (although signature did change in 2.7)