AnnotatedMethod (jackson-databind 2.9.5 API)

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`	`_method`
`protected Class<?>[]`	`_paramClasses`
`protected com.fasterxml.jackson.databind.introspect.AnnotatedMethod.Serialization`	`_serialization`	Field that is used to make JDK serialization work with this object.

Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember
_annotations, _typeContext

Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedWithParams
_paramAnnotations

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AnnotatedMethod(com.fasterxml.jackson.databind.introspect.AnnotatedMethod.Serialization ser)`	Method used for JDK serialization support
	`AnnotatedMethod(TypeResolutionContext ctxt, Method method, AnnotationMap classAnn, AnnotationMap[] paramAnnotations)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Object`	`call()`	Method that can be used to (try to) call this object without arguments.
`Object`	`call(Object[] args)`	Method that can be used to (try to) call this object with specified arguments.
`Object`	`call1(Object arg)`	Method that can be used to (try to) call this object with single arguments.
`Object`	`callOn(Object pojo)`
`Object`	`callOnWith(Object pojo, Object... args)`
`boolean`	`equals(Object o)`
`Method`	`getAnnotated()`	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.
`String`	`getFullName()`
`Type`	`getGenericParameterType(int index)`	Deprecated.
`Type[]`	`getGenericParameterTypes()`	Deprecated.
`Type`	`getGenericType()`	Deprecated.
`Method`	`getMember()`
`int`	`getModifiers()`
`String`	`getName()`
`int`	`getParameterCount()`
`JavaType`	`getParameterType(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)
`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)
`Object`	`getValue(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()`
`boolean`	`hasReturnType()`	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
`void`	`setValue(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.
`String`	`toString()`
`AnnotatedMethod`	`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
getType, isPublic

Methods inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember
annotations, fixAccess, getAllAnnotations, getAnnotation, getTypeContext, hasAnnotation, hasOneOf

Methods inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedWithParams
addOrOverrideParam, getAnnotationCount, getParameter, getParameterAnnotations, replaceParameterAnnotations

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 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: 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()
```
    Specified by:
    
    getModifiers in class Annotated
  - 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
  - getGenericType
```
@Deprecated
public Type getGenericType()
```
    Deprecated.
    
    Description copied from class: Annotated
    
    JDK 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 without TypeResolutionContext, and as a result use of this method was deprecated in Jackson 2.7: see Annotated.getType() for replacement.
    
    Overrides:
    
    getGenericType 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 memmber 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
```
public boolean hasReturnType()
```
    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

Class AnnotatedMethod

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember

Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedWithParams

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.databind.introspect.Annotated

Methods inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember

Methods inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedWithParams

Methods inherited from class java.lang.Object

Field Detail

_method

_paramClasses

_serialization

Constructor Detail

AnnotatedMethod

AnnotatedMethod

Method Detail

withAnnotations

getAnnotated

getModifiers

getName

getType

getRawType

getGenericType

call

call

call1

callOn

callOnWith

getParameterCount

getRawParameterType

getParameterType

getGenericParameterType

getDeclaringClass

getMember

setValue

getValue

getFullName

getRawParameterTypes

getGenericParameterTypes

getRawReturnType

hasReturnType

toString

hashCode

equals