Package com.fasterxml.jackson.databind.introspect

Class AnnotatedMethod

java.lang.Object
com.fasterxml.jackson.databind.introspect.Annotated
com.fasterxml.jackson.databind.introspect.AnnotatedMember
com.fasterxml.jackson.databind.introspect.AnnotatedWithParams
com.fasterxml.jackson.databind.introspect.AnnotatedMethod
All Implemented Interfaces:
Serializable
public final class AnnotatedMethod extends AnnotatedWithParams implements Serializable
See Also:

  • Constructor Details

  • Method Details

    • withAnnotations

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

    • getAnnotated

      public Method 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

    • getModifiers

      public int getModifiers()

    • getName

      public String getName()
      Specified by:
      getName in class Annotated

    • getType

      public JavaType getType()
      For methods, this returns declared return type, which is only useful with getters (setters do not return anything; hence `Void` would be returned here)
      Specified by:
      getType in class Annotated

    • getRawType

      public Class<?> getRawType()
      For methods, this returns declared return type, which is only useful with getters (setters do not usually return anything; hence "void" type is returned here)
      Specified by:
      getRawType in class Annotated

    • call

      public final Object call() throws Exception
      Description copied from class: AnnotatedWithParams
      Method that can be used to (try to) call this object without arguments. This may succeed or fail, depending on expected number of arguments: caller needs to take care to pass correct number. Exceptions are thrown directly from actual low-level call.

      Note: only works for constructors and static methods.

      Specified by:
      call in class AnnotatedWithParams
      Throws:
      Exception

    • call

      public final Object call(Object[] args) throws Exception
      Description copied from class: AnnotatedWithParams
      Method that can be used to (try to) call this object with specified arguments. This may succeed or fail, depending on expected number of arguments: caller needs to take care to pass correct number. Exceptions are thrown directly from actual low-level call.

      Note: only works for constructors and static methods.

      Specified by:
      call in class AnnotatedWithParams
      Throws:
      Exception

    • call1

      public final Object call1(Object arg) throws Exception
      Description copied from class: AnnotatedWithParams
      Method that can be used to (try to) call this object with single arguments. This may succeed or fail, depending on expected number of arguments: caller needs to take care to pass correct number. Exceptions are thrown directly from actual low-level call.

      Note: only works for constructors and static methods.

      Specified by:
      call1 in class AnnotatedWithParams
      Throws:
      Exception

    • callOn

      public final Object callOn(Object pojo) throws Exception
      Throws:
      Exception

    • callOnWith

      public final Object callOnWith(Object pojo, Object... args) throws Exception
      Throws:
      Exception

    • getParameterCount

      public int getParameterCount()
      Specified by:
      getParameterCount in class AnnotatedWithParams

    • getRawParameterType

      public Class<?> getRawParameterType(int index)
      Specified by:
      getRawParameterType in class AnnotatedWithParams

    • getParameterType

      public JavaType getParameterType(int index)
      Specified by:
      getParameterType in class AnnotatedWithParams

    • getGenericParameterType

      @Deprecated public Type getGenericParameterType(int index)
      Deprecated.
      Specified by:
      getGenericParameterType in class AnnotatedWithParams

    • getDeclaringClass

      public Class<?> getDeclaringClass()
      Description copied from class: AnnotatedMember
      Actual physical class in which this member was declared.
      Specified by:
      getDeclaringClass in class AnnotatedMember

    • getMember

      public Method getMember()
      Specified by:
      getMember in class AnnotatedMember

    • setValue

      public void setValue(Object pojo, Object value) throws 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 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:
      IllegalArgumentException

    • getValue

      public Object getValue(Object pojo) throws IllegalArgumentException
      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:
      IllegalArgumentException

    • getFullName

      public String getFullName()
      Overrides:
      getFullName in class AnnotatedMember

    • getRawParameterTypes

      public Class<?>[] getRawParameterTypes()

    • getGenericParameterTypes

      @Deprecated public Type[] getGenericParameterTypes()
      Deprecated.

    • getRawReturnType

      public Class<?> getRawReturnType()

    • hasReturnType

      @Deprecated public boolean hasReturnType()
      Deprecated.
      Since 2.12 (related to [databind#2675]), needs to be configurable
      Helper method that can be used to check whether method returns a value or not; if return type declared as void, returns false, otherwise true
      Since:
      2.4

    • toString

      public String toString()
      Specified by:
      toString in class Annotated

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class Annotated

    • equals

      public boolean equals(Object o)
      Specified by:
      equals in class Annotated