org.apache.juneau.reflect

Class ParamInfo

java.lang.Object

org.apache.juneau.reflect.ParamInfo

@BeanIgnore
public final class ParamInfo
extends Object

Lightweight utility class for introspecting information about a method parameter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParamInfo(ExecutableInfo eInfo, Parameter p, int index) Constructor.

Method Summary

Modifier and Type	Method and Description
<T extends Annotation> T	getAnnotation(Class<T> a) Finds the annotation of the specified type defined on this method parameter.
<T extends Annotation> List<T>	getAnnotations(Class<T> a) Returns all annotations of the specified type defined on this method parameter.
<T extends Annotation> List<T>	getAnnotationsParentFirst(Class<T> a) Identical to getAnnotations(Class) but returns the list in reverse (parent-to-child) order.
ConstructorInfo	getConstructor() Returns the constructor that this parameter belongs to.
<T extends Annotation> T	getDeclaredAnnotation(Class<T> a) Returns the specified parameter annotation declared on this parameter.
Annotation[]	getDeclaredAnnotations() Returns the parameter annotations declared on this parameter.
int	getIndex() Returns the index position of this parameter.
MethodInfo	getMethod() Returns the method that this parameter belongs to.
String	getName() Returns the name of the parameter.
ClassInfo	getParameterType() Returns the class type of this parameter.
boolean	hasAnnotation(Class<? extends Annotation> a) Returns true if this parameter has the specified annotation.
boolean	hasName() Returns true if the parameter has a name provided by the class file.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamInfo

protected ParamInfo(ExecutableInfo eInfo,
                    Parameter p,
                    int index)

Constructor.

Parameters:

eInfo - The constructor or method wrapper.

p - The parameter being wrapped.

index - The parameter index.

Method Detail

getIndex

public int getIndex()

Returns the index position of this parameter.

Returns:

The index position of this parameter.

getMethod

public MethodInfo getMethod()

Returns the method that this parameter belongs to.

Returns:

The method that this parameter belongs to, or null if it belongs to a constructor.

getConstructor

public ConstructorInfo getConstructor()

Returns the constructor that this parameter belongs to.

Returns:

The constructor that this parameter belongs to, or null if it belongs to a method.

getParameterType

public ClassInfo getParameterType()

Returns the class type of this parameter.

Returns:

The class type of this parameter.

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

Returns the parameter annotations declared on this parameter.

Returns:

The parameter annotations declared on this parameter, or an empty array if none found.

getDeclaredAnnotation

public <T extends Annotation> T getDeclaredAnnotation(Class<T> a)

Returns the specified parameter annotation declared on this parameter.

Type Parameters:

T - The annotation type.

Parameters:

a - The annotation to search for.

Returns:

The specified parameter annotation declared on this parameter, or null if not found.

getAnnotation

public <T extends Annotation> T getAnnotation(Class<T> a)

Finds the annotation of the specified type defined on this method parameter.

If the annotation cannot be found on the immediate method, searches methods with the same signature on the parent classes or interfaces.
The search is performed in child-to-parent order.

If still not found, searches for the annotation on the return type of the method.

Parameters:

a - The annotation to search for.

Returns:

The annotation if found, or null if not.

hasAnnotation

public boolean hasAnnotation(Class<? extends Annotation> a)

Returns true if this parameter has the specified annotation.

Parameters:

a - The annotation to search for.

Returns:

The true if annotation if found.

getAnnotations

public <T extends Annotation> List<T> getAnnotations(Class<T> a)

Returns all annotations of the specified type defined on this method parameter.

Searches all methods with the same signature on the parent classes or interfaces and the return type on the method.

Parameters:

a - The annotation to search for.

Returns:

A list of all matching annotations found in child-to-parent order, or an empty list if none found.

getAnnotationsParentFirst

public <T extends Annotation> List<T> getAnnotationsParentFirst(Class<T> a)

Identical to getAnnotations(Class) but returns the list in reverse (parent-to-child) order.

Parameters:

a - The annotation to search for.

Returns:

A list of all matching annotations found or an empty list if none found.

hasName

public boolean hasName()

Returns true if the parameter has a name provided by the class file.

Returns:

true if the parameter has a name provided by the class file.

getName

public String getName()

Returns the name of the parameter.

If the parameter's name is present, then this method returns the name provided by the class file. Otherwise, this method synthesizes a name of the form argN, where N is the index of the parameter in the descriptor of the method which declares the parameter.

Returns:

The name of the parameter.

See Also:

Parameter.getName()

toString

public String toString()

Overrides:

toString in class Object