org.codehaus.mojo.servicedocgen.introspection

Class JMethod

java.lang.Object

org.codehaus.mojo.servicedocgen.introspection.JMethod

public class JMethod
extends Object

Rich representation of a Method with both byte-code and source-code analysis information.

Author:

hohwille

Constructor Summary

Constructors

Constructor and Description
JMethod(Method byteMethod, JType type) The constructor.
JMethod(Method byteMethod, JType type, Method annotatedParentMethod) The constructor.

Method Summary

Modifier and Type	Method and Description
Method	getByteMethod()
String	getComment()
List<JException>	getExceptions()
String	getName()
List<JParameter>	getParameters()
JReturn	getReturns()
com.thoughtworks.qdox.model.JavaMethod	getSourceMethod()
JType	getType()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JMethod

public JMethod(Method byteMethod,
               JType type)

The constructor.

Parameters:

byteMethod - - see getByteMethod().

type - - see getType().

JMethod

public JMethod(Method byteMethod,
               JType type,
               Method annotatedParentMethod)

The constructor.

Parameters:

byteMethod - - see getByteMethod().

type - - see getType().

annotatedParentMethod - the Method containing the JAX-RS annotation that may be a parent Method of byteMethod.

Method Detail

getType

public JType getType()

Returns:

the type

getSourceMethod

public com.thoughtworks.qdox.model.JavaMethod getSourceMethod()

Returns:

the sourceMethod

getByteMethod

public Method getByteMethod()

Returns:

the byteMethod

getParameters

public List<JParameter> getParameters()

Returns:

the parameters

getExceptions

public List<JException> getExceptions()

Returns:

the exceptions

getReturns

public JReturn getReturns()

Returns:

the returns

getComment

public String getComment()

Returns:

the comment

getName

public String getName()

Returns:

the name of the Method.

toString

public String toString()

Overrides:

toString in class Object