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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Method_methodprotected Class<?>[]_paramClassesprotected com.fasterxml.jackson.databind.introspect.AnnotatedMethod.Serialization_serializationField that is used to make JDK serialization work with this object.-
Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedWithParams
_paramAnnotations
-
Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember
_annotations, _typeContext
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAnnotatedMethod(com.fasterxml.jackson.databind.introspect.AnnotatedMethod.Serialization ser)Method used for JDK serialization supportAnnotatedMethod(TypeResolutionContext ctxt, Method method, AnnotationMap classAnn, AnnotationMap[] paramAnnotations)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Objectcall()Method that can be used to (try to) call this object without arguments.Objectcall(Object[] args)Method that can be used to (try to) call this object with specified arguments.Objectcall1(Object arg)Method that can be used to (try to) call this object with single arguments.ObjectcallOn(Object pojo)ObjectcallOnWith(Object pojo, Object... args)booleanequals(Object o)MethodgetAnnotated()Method that can be used to find actual JDK element that this instance represents.Class<?>getDeclaringClass()Actual physical class in which this memmber was declared.StringgetFullName()TypegetGenericParameterType(int index)Deprecated.Type[]getGenericParameterTypes()Deprecated.TypegetGenericType()Deprecated.MethodgetMember()intgetModifiers()StringgetName()intgetParameterCount()JavaTypegetParameterType(int index)Class<?>getRawParameterType(int index)Class<?>[]getRawParameterTypes()Class<?>getRawReturnType()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)ObjectgetValue(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()Helper method that can be used to check whether method returns a value or not; if return type declared asvoid, returns false, otherwise truevoidsetValue(Object pojo, 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.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, replaceParameterAnnotations
-
Methods inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember
annotations, fixAccess, getAllAnnotations, getAnnotation, getTypeContext, hasAnnotation, hasOneOf
-
-
-
-
Field Detail
-
_method
protected final transient Method _method
-
_paramClasses
protected Class<?>[] _paramClasses
-
_serialization
protected com.fasterxml.jackson.databind.introspect.AnnotatedMethod.Serialization _serialization
Field that is used to make JDK serialization work with this object.- Since:
- 2.1
-
-
Constructor Detail
-
AnnotatedMethod
public AnnotatedMethod(TypeResolutionContext ctxt, Method method, AnnotationMap classAnn, AnnotationMap[] paramAnnotations)
-
AnnotatedMethod
protected AnnotatedMethod(com.fasterxml.jackson.databind.introspect.AnnotatedMethod.Serialization ser)
Method used for JDK serialization support- Since:
- 2.1
-
-
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 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()
- Specified by:
getModifiersin classAnnotated
-
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 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
-
getGenericType
@Deprecated public Type getGenericType()
Deprecated.Description copied from class:AnnotatedJDK declared generic type of the annotated element; definition of what exactly this means depends on sub-class. Note that such type cannot be reliably resolved withoutTypeResolutionContext, and as a result use of this method was deprecated in Jackson 2.7: seeAnnotated.getType()for replacement.- Overrides:
getGenericTypein classAnnotated
-
call
public final Object call() throws Exception
Description 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:
Exception
-
call
public final Object call(Object[] args) throws Exception
Description 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:
Exception
-
call1
public final Object call1(Object arg) throws Exception
Description 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:
Exception
-
callOnWith
public final Object callOnWith(Object pojo, Object... args) throws Exception
- Throws:
Exception
-
getParameterCount
public int getParameterCount()
- Specified by:
getParameterCountin classAnnotatedWithParams
-
getRawParameterType
public Class<?> getRawParameterType(int index)
- Specified by:
getRawParameterTypein classAnnotatedWithParams
-
getParameterType
public JavaType getParameterType(int index)
- Specified by:
getParameterTypein classAnnotatedWithParams
-
getGenericParameterType
@Deprecated public Type getGenericParameterType(int index)
Deprecated.- Specified by:
getGenericParameterTypein classAnnotatedWithParams
-
getDeclaringClass
public Class<?> getDeclaringClass()
Description copied from class:AnnotatedMemberActual physical class in which this memmber was declared.- Specified by:
getDeclaringClassin classAnnotatedMember
-
getMember
public Method getMember()
- Specified by:
getMemberin classAnnotatedMember
-
setValue
public void setValue(Object pojo, Object value) throws IllegalArgumentException
Description 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:
IllegalArgumentException
-
getValue
public Object getValue(Object pojo) throws IllegalArgumentException
Description 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:
IllegalArgumentException
-
getFullName
public String getFullName()
- Overrides:
getFullNamein classAnnotatedMember
-
getRawParameterTypes
public Class<?>[] getRawParameterTypes()
-
getGenericParameterTypes
@Deprecated public Type[] getGenericParameterTypes()
Deprecated.
-
getRawReturnType
public Class<?> getRawReturnType()
-
hasReturnType
public boolean hasReturnType()
Helper 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
-
-