com.github.therapi.runtimejavadoc

Class MethodJavadoc

java.lang.Object

com.github.therapi.runtimejavadoc.BaseJavadoc

com.github.therapi.runtimejavadoc.MethodJavadoc

public class MethodJavadoc
extends BaseJavadoc

Constructor Summary

Constructors

Constructor and Description
MethodJavadoc(java.lang.String name, java.util.List<java.lang.String> paramTypes, Comment comment, java.util.List<ParamJavadoc> params, java.util.List<ThrowsJavadoc> exceptions, java.util.List<OtherJavadoc> other, Comment returns, java.util.List<SeeAlsoJavadoc> seeAlso)

Method Summary

Modifier and Type	Method and Description
static MethodJavadoc	createEmpty(java.lang.reflect.Executable executable)
java.util.List<ParamJavadoc>	getParams()
java.util.List<java.lang.String>	getParamTypes()
Comment	getReturns()
java.util.List<ThrowsJavadoc>	getThrows()
boolean	isConstructor()
boolean	matches(java.lang.reflect.Constructor<?> method)
boolean	matches(java.lang.reflect.Executable executable)
boolean	matches(java.lang.reflect.Method method)
java.lang.String	toString()

Methods inherited from class com.github.therapi.runtimejavadoc.BaseJavadoc

getComment, getName, getOther, getSeeAlso, isEmpty, isPresent

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodJavadoc

public MethodJavadoc(java.lang.String name,
                     java.util.List<java.lang.String> paramTypes,
                     Comment comment,
                     java.util.List<ParamJavadoc> params,
                     java.util.List<ThrowsJavadoc> exceptions,
                     java.util.List<OtherJavadoc> other,
                     Comment returns,
                     java.util.List<SeeAlsoJavadoc> seeAlso)

Method Detail

createEmpty

public static MethodJavadoc createEmpty(java.lang.reflect.Executable executable)

isConstructor

public boolean isConstructor()

matches

public boolean matches(java.lang.reflect.Executable executable)

matches

public boolean matches(java.lang.reflect.Method method)

matches

public boolean matches(java.lang.reflect.Constructor<?> method)

getParamTypes

public java.util.List<java.lang.String> getParamTypes()

getParams

public java.util.List<ParamJavadoc> getParams()

getThrows

public java.util.List<ThrowsJavadoc> getThrows()

getReturns

public Comment getReturns()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object