org.constretto.internal

Class MethodParameter

java.lang.Object

org.constretto.internal.MethodParameter

public class MethodParameter
extends Object

Helper class that encapsulates the specification of a method parameter, i.e. a Method or Constructor plus a parameter index and a nested type index for a declared generic type. Useful as a specification object to pass along.

Since:

2.0

Author:

Juergen Hoeller, Rob Harrop, Andy Clement

See Also:

GenericCollectionTypeResolver

Constructor Summary

Constructors

Constructor and Description
MethodParameter(Constructor constructor, int parameterIndex) Create a new MethodParameter for the given constructor, with nesting level 1.
MethodParameter(Constructor constructor, int parameterIndex, int nestingLevel) Create a new MethodParameter for the given constructor.
MethodParameter(Method method, int parameterIndex) Create a new MethodParameter for the given method, with nesting level 1.
MethodParameter(Method method, int parameterIndex, int nestingLevel) Create a new MethodParameter for the given method.

Method Summary

Modifier and Type	Method and Description
Constructor	getConstructor() Return the wrapped Constructor, if any.
Class	getDeclaringClass() Return the class that declares the underlying Method or Constructor.
Method	getMethod() Return the wrapped Method, if any.
Annotation[]	getMethodAnnotations() Return the annotations associated with the target method/constructor itself.
int	getNestingLevel() Return the nesting level of the target type (typically 1; e.g. in case of a List of Lists, 1 would indicate the nested List, whereas 2 would indicate the element of the nested List).
Annotation[]	getParameterAnnotations() Return the annotations associated with the specific method/constructor parameter.
int	getParameterIndex() Return the index of the method/constructor parameter.
Class<?>	getParameterType() Return the type of the method/constructor parameter.
Integer	getTypeIndexForLevel(int nestingLevel) Return the type index for the specified nesting level.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodParameter

public MethodParameter(Method method,
                       int parameterIndex)

Create a new MethodParameter for the given method, with nesting level 1.

Parameters:

method - the Method to specify a parameter for

parameterIndex - the index of the parameter

MethodParameter

public MethodParameter(Method method,
                       int parameterIndex,
                       int nestingLevel)

Create a new MethodParameter for the given method.

Parameters:

method - the Method to specify a parameter for

parameterIndex - the index of the parameter (-1 for the method return type; 0 for the first method parameter, 1 for the second method parameter, etc)

nestingLevel - the nesting level of the target type (typically 1; e.g. in case of a List of Lists, 1 would indicate the nested List, whereas 2 would indicate the element of the nested List)

MethodParameter

public MethodParameter(Constructor constructor,
                       int parameterIndex)

Create a new MethodParameter for the given constructor, with nesting level 1.

Parameters:

constructor - the Constructor to specify a parameter for

parameterIndex - the index of the parameter

MethodParameter

public MethodParameter(Constructor constructor,
                       int parameterIndex,
                       int nestingLevel)

Create a new MethodParameter for the given constructor.

Parameters:

constructor - the Constructor to specify a parameter for

parameterIndex - the index of the parameter

nestingLevel - the nesting level of the target type (typically 1; e.g. in case of a List of Lists, 1 would indicate the nested List, whereas 2 would indicate the element of the nested List)

Method Detail

getMethod

public Method getMethod()

Return the wrapped Method, if any.

Note: Either Method or Constructor is available.

Returns:

the Method, or null if none

getConstructor

public Constructor getConstructor()

Return the wrapped Constructor, if any.

Note: Either Method or Constructor is available.

Returns:

the Constructor, or null if none

getDeclaringClass

public Class getDeclaringClass()

Return the class that declares the underlying Method or Constructor.

getParameterIndex

public int getParameterIndex()

Return the index of the method/constructor parameter.

Returns:

the parameter index (never negative)

getParameterType

public Class<?> getParameterType()

Return the type of the method/constructor parameter.

Returns:

the parameter type (never null)

getMethodAnnotations

public Annotation[] getMethodAnnotations()

Return the annotations associated with the target method/constructor itself.

getParameterAnnotations

public Annotation[] getParameterAnnotations()

Return the annotations associated with the specific method/constructor parameter.

getNestingLevel

public int getNestingLevel()

Return the nesting level of the target type (typically 1; e.g. in case of a List of Lists, 1 would indicate the nested List, whereas 2 would indicate the element of the nested List).

getTypeIndexForLevel

public Integer getTypeIndexForLevel(int nestingLevel)

Return the type index for the specified nesting level.

Parameters:

nestingLevel - the nesting level to check

Returns:

the corresponding type index, or null if none specified (indicating the default type index)