Class BeanProperty.Bogus

  • All Implemented Interfaces:
    BeanProperty, Named
    Enclosing interface:
    BeanProperty

    public static class BeanProperty.Bogus
    extends java.lang.Object
    implements BeanProperty
    Alternative "Null" implementation that can be used in cases where a non-null BeanProperty is needed
    Since:
    2.9
    • Constructor Summary

      Constructors 
      Constructor Description
      Bogus()  
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void depositSchemaProperty​(JsonObjectFormatVisitor objectVisitor, SerializerProvider provider)
      Method that can be called to visit the type structure that this property is part of.
      java.util.List<PropertyName> findAliases​(MapperConfig<?> config)
      Method for accessing set of possible alternate names that are accepted during deserialization.
      com.fasterxml.jackson.annotation.JsonFormat.Value findFormatOverrides​(AnnotationIntrospector intr)
      Deprecated.
      com.fasterxml.jackson.annotation.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
      com.fasterxml.jackson.annotation.JsonInclude.Value findPropertyInclusion​(MapperConfig<?> config, java.lang.Class<?> baseType)
      Convenience method that is roughly equivalent to
      <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.
      <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).
      PropertyName getFullName()
      Method for getting full name definition, including possible format-specific additional properties (such as namespace when using XML backend).
      AnnotatedMember getMember()
      Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
      PropertyMetadata getMetadata()
      Accessor for additional optional information about property.
      java.lang.String getName()
      Method to get logical name of the property
      JavaType getType()
      Method to get declared type of the property.
      PropertyName getWrapperName()
      If property is indicated to be wrapped, name of wrapper element to use.
      boolean isRequired()
      Whether value for property is marked as required using annotations or associated schema.
      boolean isVirtual()
      Accessor for checking whether there is an actual physical property behind this property abstraction or not.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Bogus

        public Bogus()
    • Method Detail

      • 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
      • 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.
      • 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
      • 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
      • 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
      • 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
      • 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
      • depositSchemaProperty

        public void depositSchemaProperty​(JsonObjectFormatVisitor objectVisitor,
                                          SerializerProvider provider)
                                   throws JsonMappingException
        Description copied from interface: BeanProperty
        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.

        Specified by:
        depositSchemaProperty in interface BeanProperty
        Parameters:
        objectVisitor - Visitor to used as the callback handler
        Throws:
        JsonMappingException