Package org.codehaus.jackson.map.introspect

Class AnnotatedField

  • public final class AnnotatedField
extends AnnotatedMember
    Object that represents non-static (and usually non-transient/volatile) fields of a class.
    Author:
    tatu

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.reflect.Field _field  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addOrOverride​(java.lang.annotation.Annotation a)
      Method called to override an annotation, usually due to a mix-in annotation masking or overriding an annotation 'real' constructor has.
      java.lang.reflect.Field getAnnotated()
      Method that can be used to find actual JDK element that this instance represents.
      <A extends java.lang.annotation.Annotation>
      A      		 getAnnotation​(java.lang.Class<A> acls)  
      int getAnnotationCount()  
      java.lang.Class<?> getDeclaringClass()  
      java.lang.String getFullName()  
      java.lang.reflect.Type getGenericType()
      Full generic type of the annotated element; definition of what exactly this means depends on sub-class.
      java.lang.reflect.Member getMember()  
      int getModifiers()  
      java.lang.String getName()  
      java.lang.Class<?> getRawType()
      "Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.
      void setValue​(java.lang.Object pojo, java.lang.Object value)
      Optional method that can be used to assign value of this member on given object, if this is a supported operation for member type.
      java.lang.String toString()  
      AnnotatedField withAnnotations​(AnnotationMap ann)
      Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • _field

        protected final java.lang.reflect.Field _field

    • Constructor Detail

      • AnnotatedField

        public AnnotatedField​(java.lang.reflect.Field field,
                      AnnotationMap annMap)

    • Method Detail

      • withAnnotations

        public AnnotatedField withAnnotations​(AnnotationMap ann)
        Description copied from class: Annotated
        Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.
        Specified by:
        withAnnotations in class Annotated

      • addOrOverride

        public void addOrOverride​(java.lang.annotation.Annotation a)
        Method called to override an annotation, usually due to a mix-in annotation masking or overriding an annotation 'real' constructor has.

      • getAnnotated

        public java.lang.reflect.Field getAnnotated()
        Description copied from class: Annotated
        Method that can be used to find actual JDK element that this instance represents. It is non-null, except for method/constructor parameters which do not have a JDK counterpart.
        Specified by:
        getAnnotated in class Annotated

      • getName

        public java.lang.String getName()
        Specified by:
        getName in class Annotated

      • getAnnotation

        public <A extends java.lang.annotation.Annotation> A getAnnotation​(java.lang.Class<A> acls)
        Specified by:
        getAnnotation in class Annotated

      • getGenericType

        public java.lang.reflect.Type getGenericType()
        Description copied from class: Annotated
        Full generic type of the annotated element; definition of what exactly this means depends on sub-class.
        Specified by:
        getGenericType in class Annotated

      • getRawType

        public java.lang.Class<?> getRawType()
        Description copied from class: Annotated
        "Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.
        Specified by:
        getRawType in class Annotated

      • setValue

        public void setValue​(java.lang.Object pojo,
                     java.lang.Object value)
              throws java.lang.IllegalArgumentException
        Description copied from class: AnnotatedMember
        Optional method that can be used to assign value of this member on given object, if this is a supported operation for member type.

        This is implemented for fiedlds and single-argument methods; but not for constructor parameters or other types of methods.

        Specified by:
        setValue in class AnnotatedMember
        Throws:
        java.lang.IllegalArgumentException

      • getFullName

        public java.lang.String getFullName()

      • getAnnotationCount

        public int getAnnotationCount()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object