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:
java.io.Serializable
public final class AnnotatedMethod extends AnnotatedWithParams implements java.io.Serializable
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AnnotatedMethod(TypeResolutionContext ctxt, java.lang.reflect.Method method, AnnotationMap classAnn, AnnotationMap[] paramAnnotations)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Objectcall()Method that can be used to (try to) call this object without arguments.java.lang.Objectcall(java.lang.Object[] args)Method that can be used to (try to) call this object with specified arguments.java.lang.Objectcall1(java.lang.Object arg)Method that can be used to (try to) call this object with single arguments.java.lang.ObjectcallOn(java.lang.Object pojo)java.lang.ObjectcallOnWith(java.lang.Object pojo, java.lang.Object... args)booleanequals(java.lang.Object o)java.lang.reflect.MethodgetAnnotated()Method that can be used to find actual JDK element that this instance represents.java.lang.Class<?>getDeclaringClass()Actual physical class in which this member was declared.java.lang.StringgetFullName()java.lang.reflect.TypegetGenericParameterType(int index)Deprecated.java.lang.reflect.Type[]getGenericParameterTypes()Deprecated.java.lang.reflect.MethodgetMember()intgetModifiers()java.lang.StringgetName()intgetParameterCount()JavaTypegetParameterType(int index)java.lang.Class<?>getRawParameterType(int index)java.lang.Class<?>[]getRawParameterTypes()java.lang.Class<?>getRawReturnType()java.lang.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)JavaTypegetType()For methods, this returns declared return type, which is only useful with getters (setters do not return anything; hence `Void` would be returned here)java.lang.ObjectgetValue(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.inthashCode()booleanhasReturnType()Deprecated.Since 2.12 (related to [databind#2675]), needs to be configurablevoidsetValue(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.StringtoString()AnnotatedMethodwithAnnotations(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.AnnotatedWithParams
addOrOverrideParam, getAnnotationCount, getParameter, getParameterAnnotations
-
Methods inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember
annotations, fixAccess, getAllAnnotations, getAnnotation, getTypeContext, hasAnnotation, hasOneOf
-
-
-
-
Constructor Detail
-
AnnotatedMethod
public AnnotatedMethod(TypeResolutionContext ctxt, java.lang.reflect.Method method, AnnotationMap classAnn, AnnotationMap[] paramAnnotations)
-
-
Method Detail
-
withAnnotations
public AnnotatedMethod withAnnotations(AnnotationMap ann)
Description copied from class:AnnotatedMemberFluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.- Specified by:
withAnnotationsin classAnnotatedMember
-
getAnnotated
public java.lang.reflect.Method getAnnotated()
Description copied from class:AnnotatedMethod 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:
getAnnotatedin classAnnotated
-
getModifiers
public int getModifiers()
-
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)
-
getRawType
public java.lang.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:
getRawTypein classAnnotated
-
call
public final java.lang.Object call() throws java.lang.ExceptionDescription copied from class:AnnotatedWithParamsMethod 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:
callin classAnnotatedWithParams- Throws:
java.lang.Exception
-
call
public final java.lang.Object call(java.lang.Object[] args) throws java.lang.ExceptionDescription copied from class:AnnotatedWithParamsMethod 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:
callin classAnnotatedWithParams- Throws:
java.lang.Exception
-
call1
public final java.lang.Object call1(java.lang.Object arg) throws java.lang.ExceptionDescription copied from class:AnnotatedWithParamsMethod 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:
call1in classAnnotatedWithParams- Throws:
java.lang.Exception
-
callOn
public final java.lang.Object callOn(java.lang.Object pojo) throws java.lang.Exception- Throws:
java.lang.Exception
-
callOnWith
public final java.lang.Object callOnWith(java.lang.Object pojo, java.lang.Object... args) throws java.lang.Exception- Throws:
java.lang.Exception
-
getParameterCount
public int getParameterCount()
- Specified by:
getParameterCountin classAnnotatedWithParams
-
getRawParameterType
public java.lang.Class<?> getRawParameterType(int index)
- Specified by:
getRawParameterTypein classAnnotatedWithParams
-
getParameterType
public JavaType getParameterType(int index)
- Specified by:
getParameterTypein classAnnotatedWithParams
-
getGenericParameterType
@Deprecated public java.lang.reflect.Type getGenericParameterType(int index)
Deprecated.- Specified by:
getGenericParameterTypein classAnnotatedWithParams
-
getDeclaringClass
public java.lang.Class<?> getDeclaringClass()
Description copied from class:AnnotatedMemberActual physical class in which this member was declared.- Specified by:
getDeclaringClassin classAnnotatedMember
-
getMember
public java.lang.reflect.Method getMember()
- Specified by:
getMemberin classAnnotatedMember
-
setValue
public void setValue(java.lang.Object pojo, java.lang.Object value) throws java.lang.IllegalArgumentExceptionDescription copied from class:AnnotatedMemberOptional 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:
setValuein classAnnotatedMember- Throws:
java.lang.IllegalArgumentException
-
getValue
public java.lang.Object getValue(java.lang.Object pojo) throws java.lang.IllegalArgumentExceptionDescription copied from class:AnnotatedMemberOptional 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:
getValuein classAnnotatedMember- Throws:
java.lang.IllegalArgumentException
-
getFullName
public java.lang.String getFullName()
- Overrides:
getFullNamein classAnnotatedMember
-
getRawParameterTypes
public java.lang.Class<?>[] getRawParameterTypes()
-
getGenericParameterTypes
@Deprecated public java.lang.reflect.Type[] getGenericParameterTypes()
Deprecated.
-
getRawReturnType
public java.lang.Class<?> getRawReturnType()
-
hasReturnType
@Deprecated public boolean hasReturnType()
Deprecated.Since 2.12 (related to [databind#2675]), needs to be configurableHelper method that can be used to check whether method returns a value or not; if return type declared asvoid, returns false, otherwise true- Since:
- 2.4
-
-