jackson-databind 2.16.0 · com.fasterxml.jackson.databind.introspect.AnnotatedMethod

Modifier and Type	Class and Description
private static class	AnnotatedMethod.Serialization Helper class that is used as the workaround to persist Field references.

Modifier and Type	Field and Description
protected final transient Method	_method
protected Class<?>[]	_paramClasses
protected AnnotatedMethod.Serialization	_serialization Field that is used to make JDK serialization work with this object.
private static final long	serialVersionUID Hides com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.serialVersionUID.

Access	Constructor and Description
public	AnnotatedMethod(TypeResolutionContext ctxt, Method method, AnnotationMap classAnn, AnnotationMap[] paramAnnotations)
protected	AnnotatedMethod(AnnotatedMethod.Serialization ser) Method used for JDK serialization support

Method Summary

Modifier and Type	Method and Description
public final Object	call() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call. Method that can be used to (try to) call this object without arguments.
public final Object	call(Object[] args) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call. Method that can be used to (try to) call this object with specified arguments.
public final Object	call1(Object arg) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call1. Method that can be used to (try to) call this object with single arguments.
public final Object	callOn(Object pojo)
public final Object	callOnWith(Object pojo, Object... args)
public boolean	equals(Object the reference object with which to compare. o) Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.equals. Indicates whether some other object is "equal to" this one.
public Method	getAnnotated() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated. Method that can be used to find actual JDK element that this instance represents.
public Class<?>	getDeclaringClass() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass. Actual physical class in which this member was declared.
public String	getFullName() Overrides com.fasterxml.jackson.databind.introspect.AnnotatedMember.getFullName.
public Type	getGenericParameterType(int index) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getGenericParameterType. Deprecated
public Type[]	getGenericParameterTypes() Deprecated
public Method	getMember() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getMember.
public int	getModifiers() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getModifiers.
public String	getName() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getName.
public int	getParameterCount() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getParameterCount.
public JavaType	getParameterType(int index) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getParameterType.
public Class<?>	getRawParameterType(int index) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getRawParameterType.
public Class<?>[]	getRawParameterTypes()
public Class<?>	getRawReturnType()
public Class<?>	getRawType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.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)
public JavaType	getType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.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)
public Object	getValue(Object pojo) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue. 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.
public int	hashCode() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.hashCode. Returns a hash code value for the object.
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
pack-priv Object	readResolve()
public void	setValue(Object pojo, Object value) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue. Optional method that can be used to assign value of this member on given object, if this is a supported operation for member type.
public String	toString() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.toString. Returns a string representation of the object.
public AnnotatedMethod	withAnnotations(AnnotationMap ann) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations. Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.
pack-priv Object	writeReplace()

Inherited from com.fasterxml.jackson.databind.introspect.AnnotatedWithParams:: addOrOverrideParam getAnnotationCount getParameter getParameterAnnotations replaceParameterAnnotations

_method	back to summary
protected final transient Method _method

_paramClasses	back to summary
protected Class<?>[] _paramClasses

_serialization	back to summary
protected AnnotatedMethod.Serialization _serialization Field that is used to make JDK serialization work with this object. Since 2.1

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.serialVersionUID.

AnnotatedMethod	back to summary
public AnnotatedMethod(TypeResolutionContext ctxt, Method method, AnnotationMap classAnn, AnnotationMap[] paramAnnotations)

AnnotatedMethod	back to summary
protected AnnotatedMethod(AnnotatedMethod.Serialization ser) Method used for JDK serialization support Since 2.1

Method Detail

call	back to summary
public final Object call() throws Exception Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call. 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. Annotations @Override

call

back to summary

public final Object call() throws Exception

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call.

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.

Annotations

@Override

call	back to summary
public final Object call(Object[] args) throws Exception Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call. 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. Annotations @Override

call

back to summary

public final Object call(Object[] args) throws Exception

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call.

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.

Annotations

@Override

call1	back to summary
public final Object call1(Object arg) throws Exception Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call1. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call1. 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. Annotations @Override

call1

back to summary

public final Object call1(Object arg) throws Exception

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call1.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.call1.

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.

Annotations

@Override

callOn	back to summary
public final Object callOn(Object pojo) throws Exception

callOnWith	back to summary
public final Object callOnWith(Object pojo, Object... args) throws Exception

equals back to summary

equals	back to summary
public boolean equals(Object o) Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAnnotated	back to summary
public Method getAnnotated() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated. Doc from com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated. 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. Annotations @Override

getAnnotated

back to summary

public Method getAnnotated()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated.

Doc from com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated.

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.

Annotations

@Override

getDeclaringClass	back to summary
public Class<?> getDeclaringClass() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass. Actual physical class in which this member was declared. Annotations @Override

getDeclaringClass

back to summary

public Class<?> getDeclaringClass()

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass.

Actual physical class in which this member was declared.

Annotations

@Override

getFullName	back to summary
public String getFullName() Overrides com.fasterxml.jackson.databind.introspect.AnnotatedMember.getFullName. Annotations @Override

getFullName

back to summary

public String getFullName()

Overrides com.fasterxml.jackson.databind.introspect.AnnotatedMember.getFullName.

Annotations

@Override

getGenericParameterType	back to summary
public Type getGenericParameterType(int index) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getGenericParameterType. Deprecated Annotations @Override @Deprecated

getGenericParameterType

back to summary

public Type getGenericParameterType(int index)

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getGenericParameterType.

Deprecated

Annotations

@Override
@Deprecated

getGenericParameterTypes	back to summary
public Type[] getGenericParameterTypes() Deprecated Annotations @Deprecated

getMember	back to summary
public Method getMember() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getMember. Annotations @Override

getMember

back to summary

public Method getMember()

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getMember.

Annotations

@Override

getModifiers	back to summary
public int getModifiers() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getModifiers. Annotations @Override

getModifiers

back to summary

public int getModifiers()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getModifiers.

Annotations

@Override

getName	back to summary
public String getName() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getName. Annotations @Override

getName

back to summary

public String getName()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getName.

Annotations

@Override

getParameterCount	back to summary
public int getParameterCount() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getParameterCount. Annotations @Override

getParameterCount

back to summary

public int getParameterCount()

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getParameterCount.

Annotations

@Override

getParameterType	back to summary
public JavaType getParameterType(int index) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getParameterType. Annotations @Override

getParameterType

back to summary

public JavaType getParameterType(int index)

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getParameterType.

Annotations

@Override

getRawParameterType	back to summary
public Class<?> getRawParameterType(int index) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getRawParameterType. Annotations @Override

getRawParameterType

back to summary

public Class<?> getRawParameterType(int index)

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedWithParams.getRawParameterType.

Annotations

@Override

getRawParameterTypes	back to summary
public Class<?>[] getRawParameterTypes()

getRawReturnType	back to summary
public Class<?> getRawReturnType()

getRawType	back to summary
public Class<?> getRawType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.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) Annotations @Override

getRawType

back to summary

public Class<?> getRawType()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.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)

Annotations

@Override

getType	back to summary
public JavaType getType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.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) Annotations @Override

getType

back to summary

public JavaType getType()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.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)

Annotations

@Override

getValue	back to summary
public Object getValue(Object pojo) throws IllegalArgumentException Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue. 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) Annotations @Override

getValue

back to summary

public Object getValue(Object pojo) throws IllegalArgumentException

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue.

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)

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasReturnType back to summary

hasReturnType	back to summary
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 Annotations @Deprecated Since 2.4

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

Annotations

@Deprecated

Since

2.4

readResolve	back to summary
pack-priv Object readResolve()

setValue	back to summary
public void setValue(Object pojo, Object value) throws IllegalArgumentException Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue. 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) Annotations @Override

setValue

back to summary

public void setValue(Object pojo, Object value) throws IllegalArgumentException

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue.

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)

Annotations

@Override

toString	back to summary
public String toString() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

withAnnotations	back to summary
public AnnotatedMethod withAnnotations(AnnotationMap ann) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations. Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones. Annotations @Override

withAnnotations

back to summary

public AnnotatedMethod withAnnotations(AnnotationMap ann)

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations.

Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.

Annotations

@Override

writeReplace	back to summary
pack-priv Object writeReplace()

public final Class AnnotatedMethod

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class AnnotatedMethod.Serialization

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
protected Class<?>[]	args
protected Class<?>	clazz
protected String	name
private static final long	serialVersionUID