com.github.misberner.apcommons.util.methods

Class ParameterInfo

java.lang.Object

com.github.misberner.apcommons.util.methods.ParameterInfo

public class ParameterInfo
extends Object

Represents parameters of a method, as a replacement for VariableElement.

This class offers the following benefits compared to VariableElement:

• it provides access to both the parameter type as well as the parameter name through appropriately named getters and setters
• it has a String representation suitable for representing the parameter in a parameter list
• it provides local (i.e., per-parameter) access to the information whether the respective parameter is a varargs parameter)

Author:

Malte Isberner

Constructor Summary

Constructors

Constructor and Description
ParameterInfo(TypeMirror type, CharSequence name, boolean varArgs) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Retrieves the name of this parameter.
TypeMirror	getType() Retrieves the type of this parameter.
boolean	isVarArgs() Retrieves whether this parameter is a varargs parameter.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterInfo

public ParameterInfo(TypeMirror type,
             CharSequence name,
             boolean varArgs)

Constructor.

Parameters:

type - the type of the parameter

name - the name of the parameter

varArgs - whether or not this parameter is a varargs parameter

Method Detail

getType

public TypeMirror getType()

Retrieves the type of this parameter.

Returns:

the type of this parameter

getName

public String getName()

Retrieves the name of this parameter.

Returns:

the name of this parameter

isVarArgs

public boolean isVarArgs()

Retrieves whether this parameter is a varargs parameter.

Returns:

true if this parameter is a varargs parameter, false otherwise.

toString

public String toString()

Overrides:

toString in class Object