Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.introspect

public final Class AnnotatedParameter

extends AnnotatedMember
Class Inheritance
Imports
java.lang.reflect.*, com.fasterxml.jackson.databind.JavaType, com.fasterxml.jackson.databind.util.ClassUtil

Object that represents method parameters, mostly so that associated annotations can be processed conveniently. Note that many of accessors cannot return meaningful values since parameters do not have stand-alone JDK objects associated; so access should mostly be limited to checking annotation values which are properly aggregated and included.

Field Summary

Modifier and TypeField and Description
protected final int
_index

Index of the parameter within argument list

protected final AnnotatedWithParams
_owner

Member (method, constructor) that this parameter belongs to

protected final JavaType
_type

JDK type of the parameter, possibly contains generic type information

private static final long
Inherited from com.fasterxml.jackson.databind.introspect.AnnotatedMember:
_annotations_typeContext

Constructor Summary

AccessConstructor and Description
public
AnnotatedParameter(AnnotatedWithParams owner, JavaType type, TypeResolutionContext typeContext, AnnotationMap annotations, int index)

Method Summary

Modifier and TypeMethod and Description
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 AnnotatedElement
getAnnotated()

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

Since there is no matching JDK element, this method will always return null
public Class<?>
getDeclaringClass()

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

Actual physical class in which this member was declared.
public int

Returns:

Index of this parameter within argument list
getIndex
()

Accessor for index of this parameter within argument list

public Member
public int
getModifiers()

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

Returns modifiers of the constructor, as parameters do not have independent modifiers.
public String
getName()

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

Parameters have no names in bytecode (unlike in source code), will always return empty String ("").
public AnnotatedWithParams

Returns:

Owner (member or creator) object of this parameter
getOwner
()

Accessor for 'owner' of this parameter; method or constructor that has this parameter as member of its argument list.

public Type
public Class<?>
getRawType()

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

"Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.
public JavaType
getType()

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

Full generic type of the annotated element; definition of what exactly this means depends on sub-class.
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 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 AnnotatedParameter
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.
Inherited from com.fasterxml.jackson.databind.introspect.AnnotatedMember:
annotationsfixAccessgetAllAnnotationsgetAnnotationgetFullNamegetTypeContexthasAnnotationhasOneOf

Field Detail

_indexback to summary
protected final int _index

Index of the parameter within argument list

_ownerback to summary
protected final AnnotatedWithParams _owner

Member (method, constructor) that this parameter belongs to

_typeback to summary
protected final JavaType _type

JDK type of the parameter, possibly contains generic type information

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.introspect.AnnotatedMember.serialVersionUID.

Constructor Detail

AnnotatedParameterback to summary
public AnnotatedParameter(AnnotatedWithParams owner, JavaType type, TypeResolutionContext typeContext, AnnotationMap annotations, int index)

Method Detail

equalsback 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
getAnnotatedback to summary
public AnnotatedElement getAnnotated()

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

Since there is no matching JDK element, this method will always return null

Annotations
@Override
getDeclaringClassback 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
getIndexback to summary
public int getIndex()

Accessor for index of this parameter within argument list

Returns:int

Index of this parameter within argument list

getMemberback to summary
public Member getMember()

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

Annotations
@Override
getModifiersback to summary
public int getModifiers()

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

Returns modifiers of the constructor, as parameters do not have independent modifiers.

Annotations
@Override
getNameback to summary
public String getName()

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

Parameters have no names in bytecode (unlike in source code), will always return empty String ("").

Annotations
@Override
getOwnerback to summary
public AnnotatedWithParams getOwner()

Accessor for 'owner' of this parameter; method or constructor that has this parameter as member of its argument list.

Returns:AnnotatedWithParams

Owner (member or creator) object of this parameter

getParameterTypeback to summary
public Type getParameterType()
getRawTypeback to summary
public Class<?> getRawType()

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

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

"Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.

Annotations
@Override
getTypeback to summary
public JavaType getType()

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

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

Full generic type of the annotated element; definition of what exactly this means depends on sub-class.

Annotations
@Override
getValueback to summary
public Object getValue(Object pojo) throws UnsupportedOperationException

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
hashCodeback 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
setValueback to summary
public void setValue(Object pojo, Object value) throws UnsupportedOperationException

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
toStringback 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
withAnnotationsback to summary
public AnnotatedParameter 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