org.codehaus.mojo.servicedocgen.introspection

Class JParameter

java.lang.Object

org.codehaus.mojo.servicedocgen.introspection.JElement

org.codehaus.mojo.servicedocgen.introspection.JParameter

public class JParameter
extends JElement

A parameter declaration of a JMethod.

Author:

hohwille

See Also:

JMethod.getParameters()

Constructor Summary

Constructors

Constructor and Description
JParameter(net.sf.mmm.util.reflect.api.GenericType<?> byteType, Annotation[] byteAnnotations, com.thoughtworks.qdox.model.JavaParameter parameter, String comment, int index) The constructor.

Method Summary

Modifier and Type	Method and Description
Annotation[]	getByteAnnotations()
String	getName()
com.thoughtworks.qdox.model.JavaParameter	getParameter()
String	toString()

Methods inherited from class org.codehaus.mojo.servicedocgen.introspection.JElement

getByteType, getByteTypeString, getComment, getSourceType

Methods inherited from class java.lang.Object

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

Constructor Detail

JParameter

public JParameter(net.sf.mmm.util.reflect.api.GenericType<?> byteType,
                  Annotation[] byteAnnotations,
                  com.thoughtworks.qdox.model.JavaParameter parameter,
                  String comment,
                  int index)

The constructor.

Parameters:

byteType - - see JElement.getByteType().

byteAnnotations - - see getByteAnnotations().

parameter - - see getParameter().

comment - - see JElement.getComment().

index - the index of the parameter in the method arguments.

Method Detail

getParameter

public com.thoughtworks.qdox.model.JavaParameter getParameter()

Returns:

the JavaParameter from source-code analysis. May be null.

getByteAnnotations

public Annotation[] getByteAnnotations()

Returns:

the array of Annotations from byte-code analysis. Do not modify.

getName

public String getName()

Returns:

the name of the parameter (from source-code if available).

toString

public String toString()

Overrides:

toString in class Object