Package com.fasterxml.jackson.databind.introspect

Class AnnotatedParameter

  • All Implemented Interfaces:
    java.io.Serializable
    public final class AnnotatedParameter
extends AnnotatedMember
    Object that represents method parameters, mostly so that associated annotations can be processed conveniently. Note that many of accessors cannot return meaningful values since parameters do not have stand-alone JDK objects associated; so access should mostly be limited to checking annotation values which are properly aggregated and included.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      java.lang.reflect.AnnotatedElement getAnnotated()
      Since there is no matching JDK element, this method will always return null
      java.lang.Class<?> getDeclaringClass()
      Actual physical class in which this memmber was declared.
      int getIndex()
      Accessor for index of this parameter within argument list
      java.lang.reflect.Member getMember()  
      int getModifiers()
      Returns modifiers of the constructor, as parameters do not have independent modifiers.
      java.lang.String getName()
      Parameters have no names in bytecode (unlike in source code), will always return empty String ("").
      AnnotatedWithParams getOwner()
      Accessor for 'owner' of this parameter; method or constructor that has this parameter as member of its argument list.
      java.lang.reflect.Type getParameterType()  
      java.lang.Class<?> getRawType()
      "Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.
      JavaType getType()
      Full generic type of the annotated element; definition of what exactly this means depends on sub-class.
      java.lang.Object getValue​(java.lang.Object pojo)
      Optional method that can be used to access the value of this member on given object, if this is a supported operation for member type.
      int hashCode()  
      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()  
      AnnotatedParameter 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 com.fasterxml.jackson.databind.introspect.Annotated

        isPublic

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • getAnnotated

        public java.lang.reflect.AnnotatedElement getAnnotated()
        Since there is no matching JDK element, this method will always return null
        Specified by:
        getAnnotated in class Annotated

      • getModifiers

        public int getModifiers()
        Returns modifiers of the constructor, as parameters do not have independent modifiers.

      • getName

        public java.lang.String getName()
        Parameters have no names in bytecode (unlike in source code), will always return empty String ("").
        Specified by:
        getName 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

      • getType

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

      • setValue

        public void setValue​(java.lang.Object pojo,
                     java.lang.Object value)
              throws java.lang.UnsupportedOperationException
        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 fields and single-argument member methods; but not for constructor parameters or other types of methods (like static methods)

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

      • getValue

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

        This is implemented for fields and no-argument member methods; but not for constructor parameters or other types of methods (like static methods)

        Specified by:
        getValue in class AnnotatedMember
        Throws:
        java.lang.UnsupportedOperationException

      • getParameterType

        public java.lang.reflect.Type getParameterType()

      • getOwner

        public AnnotatedWithParams getOwner()
        Accessor for 'owner' of this parameter; method or constructor that has this parameter as member of its argument list.
        Returns:
        Owner (member or creator) object of this parameter

      • getIndex

        public int getIndex()
        Accessor for index of this parameter within argument list
        Returns:
        Index of this parameter within argument list

      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in class Annotated

      • toString

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