org.jboss.jandex

Class MethodParameterInfo

java.lang.Object

org.jboss.jandex.MethodParameterInfo

All Implemented Interfaces:

AnnotationTarget

public final class MethodParameterInfo
extends Object
implements AnnotationTarget

Represents an individual Java method parameter that was annotated.

Thread-Safety

This class is immutable and can be shared between threads without safe publication.

Author:

Jason T. Greene

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.jandex.AnnotationTarget

AnnotationTarget.Kind

Method Summary

Modifier and Type	Method and Description
ClassInfo	asClass() Casts and returns this target as a ClassInfo if it is of kind CLASS
FieldInfo	asField() Casts and returns this target as a FieldInfo if it is of kind FIELD
MethodInfo	asMethod() Casts and returns this target as a MethodInfo if it is of kind METHOD
MethodParameterInfo	asMethodParameter() Casts and returns this target as a MethodParameterInfo if it is of kind METHOD_PARAMETER
TypeTarget	asType() Casts and returns this target as a TypeTarget if it is of kind TYPE
static MethodParameterInfo	create(MethodInfo method, short parameter) Constructs a new mock method parameter info
AnnotationTarget.Kind	kind() Returns the kind of object this target represents.
MethodInfo	method() Returns the method this parameter belongs to.
short	position() Returns the 0 based position of this parameter.
String	toString() Returns a string representation describing this method parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static MethodParameterInfo create(MethodInfo method,
                                         short parameter)

Constructs a new mock method parameter info

Parameters:

method - the method containing this parameter.

parameter - the zero based index of this parameter

Returns:

the new mock parameter info

method

public final MethodInfo method()

Returns the method this parameter belongs to.

Returns:

the declaring Java method

position

public final short position()

Returns the 0 based position of this parameter.

Returns:

the position of this parameter

toString

public String toString()

Returns a string representation describing this method parameter

Overrides:

toString in class Object

Returns:

a string representation of this parameter

asClass

public final ClassInfo asClass()

Description copied from interface: AnnotationTarget

Casts and returns this target as a ClassInfo if it is of kind CLASS

Specified by:

asClass in interface AnnotationTarget

Returns:

this instance cast to a class

asField

public final FieldInfo asField()

Description copied from interface: AnnotationTarget

Casts and returns this target as a FieldInfo if it is of kind FIELD

Specified by:

asField in interface AnnotationTarget

Returns:

this instance cast to a field

asMethod

public final MethodInfo asMethod()

Description copied from interface: AnnotationTarget

Casts and returns this target as a MethodInfo if it is of kind METHOD

Specified by:

asMethod in interface AnnotationTarget

Returns:

this instance cast to a method

asMethodParameter

public final MethodParameterInfo asMethodParameter()

Description copied from interface: AnnotationTarget

Casts and returns this target as a MethodParameterInfo if it is of kind METHOD_PARAMETER

Specified by:

asMethodParameter in interface AnnotationTarget

Returns:

this instance cast to a method parameter

asType

public final TypeTarget asType()

Description copied from interface: AnnotationTarget

Casts and returns this target as a TypeTarget if it is of kind TYPE

Specified by:

asType in interface AnnotationTarget

Returns:

this instance cast to a type target

kind

public AnnotationTarget.Kind kind()

Description copied from interface: AnnotationTarget

Returns the kind of object this target represents.

Specified by:

kind in interface AnnotationTarget

Returns:

the target kind.