Class AnnotatedParameter
- java.lang.Object
-
- com.fasterxml.jackson.databind.introspect.Annotated
-
- com.fasterxml.jackson.databind.introspect.AnnotatedMember
-
- com.fasterxml.jackson.databind.introspect.AnnotatedParameter
-
- All Implemented Interfaces:
Serializable
public final class AnnotatedParameter extends AnnotatedMember
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.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected int_indexIndex of the parameter within argument listprotected AnnotatedWithParams_ownerMember (method, constructor) that this parameter belongs toprotected JavaType_typeJDK type of the parameter, possibly contains generic type information-
Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember
_annotations, _typeContext
-
-
Constructor Summary
Constructors Constructor Description AnnotatedParameter(AnnotatedWithParams owner, JavaType type, TypeResolutionContext typeContext, AnnotationMap annotations, int index)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleanequals(Object o)AnnotatedElementgetAnnotated()Since there is no matching JDK element, this method will always return nullClass<?>getDeclaringClass()Actual physical class in which this memmber was declared.TypegetGenericType()Deprecated.intgetIndex()Accessor for index of this parameter within argument listMembergetMember()intgetModifiers()Returns modifiers of the constructor, as parameters do not have independent modifiers.StringgetName()Parameters have no names in bytecode (unlike in source code), will always return empty String ("").AnnotatedWithParamsgetOwner()Accessor for 'owner' of this parameter; method or constructor that has this parameter as member of its argument list.TypegetParameterType()Class<?>getRawType()"Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.JavaTypegetType()Full generic type of the annotated element; definition of what exactly this means depends on sub-class.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()voidsetValue(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()AnnotatedParameterwithAnnotations(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.AnnotatedMember
annotations, fixAccess, getAllAnnotations, getAnnotation, getFullName, getTypeContext, hasAnnotation, hasOneOf
-
-
-
-
Field Detail
-
_owner
protected final AnnotatedWithParams _owner
Member (method, constructor) that this parameter belongs to
-
_type
protected final JavaType _type
JDK type of the parameter, possibly contains generic type information
-
_index
protected final int _index
Index of the parameter within argument list
-
-
Constructor Detail
-
AnnotatedParameter
public AnnotatedParameter(AnnotatedWithParams owner, JavaType type, TypeResolutionContext typeContext, AnnotationMap annotations, int index)
-
-
Method Detail
-
withAnnotations
public AnnotatedParameter 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 AnnotatedElement getAnnotated()
Since there is no matching JDK element, this method will always return null- Specified by:
getAnnotatedin classAnnotated
-
getModifiers
public int getModifiers()
Returns modifiers of the constructor, as parameters do not have independent modifiers.- Specified by:
getModifiersin classAnnotated
-
getName
public String getName()
Parameters have no names in bytecode (unlike in source code), will always return empty String ("").
-
getRawType
public Class<?> getRawType()
Description copied from class:Annotated"Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.- Specified by:
getRawTypein classAnnotated
-
getType
public JavaType getType()
Description copied from class:AnnotatedFull generic type of the annotated element; definition of what exactly this means depends on sub-class.
-
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
-
getDeclaringClass
public Class<?> getDeclaringClass()
Description copied from class:AnnotatedMemberActual physical class in which this memmber was declared.- Specified by:
getDeclaringClassin classAnnotatedMember
-
getMember
public Member getMember()
- Specified by:
getMemberin classAnnotatedMember
-
setValue
public void setValue(Object pojo, Object value) throws UnsupportedOperationException
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:
UnsupportedOperationException
-
getValue
public Object getValue(Object pojo) throws UnsupportedOperationException
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:
UnsupportedOperationException
-
getParameterType
public Type getParameterType()
-
getOwner
public AnnotatedWithParams getOwner()
Accessor for 'owner' of this parameter; method or constructor that has this parameter as member of its argument list.- Returns:
- Owner (member or creator) object of this parameter
-
getIndex
public int getIndex()
Accessor for index of this parameter within argument list- Returns:
- Index of this parameter within argument list
-
-