Class AnnotatedParameter
java.lang.Object
org.codehaus.jackson.map.introspect.Annotated
org.codehaus.jackson.map.introspect.AnnotatedMember
org.codehaus.jackson.map.introspect.AnnotatedParameter
Object that represents method parameters, mostly so that associated
annotations can be processed conveniently. Note that many of accessors
can not 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.
Note: as of version 1.7, this type extends AnnotatedMember
, since
it behaves like a member for the most part, but earlier it just extended
Annotated
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final int
Index of the parameter within argument listprotected final AnnotatedWithParams
Member (method, constructor) that this parameter belongs toprotected final Type
JDK type of the parameter, possibly contains generic type informationFields inherited from class org.codehaus.jackson.map.introspect.AnnotatedMember
_annotations
-
Constructor Summary
ConstructorsConstructorDescriptionAnnotatedParameter
(AnnotatedWithParams owner, Type type, AnnotationMap annotations, int index) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Since there is no matching JDK element, this method will always return null<A extends Annotation>
AgetAnnotation
(Class<A> acls) Accessor for annotations; all annotations associated with parameters are properly passed and accessible.Class<?>
Full generic type of the annotated element; definition of what exactly this means depends on sub-class.int
getIndex()
Accessor for index of this parameter within argument listint
Returns modifiers of the constructor, as parameters do not have independent modifiers.getName()
Parameters have no names in bytecode (unlike in source code), will always return empty String ("").getOwner()
Accessor for 'owner' of this parameter; method or constructor that has this parameter as member of its argument list.Class<?>
"Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.void
Optional method that can be used to assign value of this member on given object, if this is a supported operation for member type.toString()
Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.Methods inherited from class org.codehaus.jackson.map.introspect.AnnotatedMember
fixAccess, getAllAnnotations
Methods inherited from class org.codehaus.jackson.map.introspect.Annotated
getType, hasAnnotation, isPublic, withFallBackAnnotationsFrom
-
Field Details
-
_owner
Member (method, constructor) that this parameter belongs to- Since:
- 1.7
-
_type
JDK type of the parameter, possibly contains generic type information -
_index
protected final int _indexIndex of the parameter within argument list- Since:
- 1.9
-
-
Constructor Details
-
AnnotatedParameter
public AnnotatedParameter(AnnotatedWithParams owner, Type type, AnnotationMap annotations, int index)
-
-
Method Details
-
withAnnotations
Description copied from class:Annotated
Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.- Specified by:
withAnnotations
in classAnnotated
-
addOrOverride
-
getAnnotated
Since there is no matching JDK element, this method will always return null- Specified by:
getAnnotated
in classAnnotated
-
getModifiers
public int getModifiers()Returns modifiers of the constructor, as parameters do not have independent modifiers.- Specified by:
getModifiers
in classAnnotated
-
getName
Parameters have no names in bytecode (unlike in source code), will always return empty String (""). -
getAnnotation
Accessor for annotations; all annotations associated with parameters are properly passed and accessible.- Specified by:
getAnnotation
in classAnnotated
-
getGenericType
Description copied from class:Annotated
Full generic type of the annotated element; definition of what exactly this means depends on sub-class.- Specified by:
getGenericType
in classAnnotated
-
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:
getRawType
in classAnnotated
-
getDeclaringClass
- Specified by:
getDeclaringClass
in classAnnotatedMember
-
getMember
- Specified by:
getMember
in classAnnotatedMember
-
setValue
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 fiedlds and single-argument methods; but not for constructor parameters or other types of methods.
- Specified by:
setValue
in classAnnotatedMember
- Throws:
UnsupportedOperationException
-
getParameterType
-
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
- Since:
- 1.9
-
getIndex
public int getIndex()Accessor for index of this parameter within argument list- Returns:
- Index of this parameter within argument list
- Since:
- 1.9
-
toString
-