net.cscott.sinjdoc

Interface ExecutableMemberDoc

public interface ExecutableMemberDoc extends MemberDoc

The ExecutableMemberDoc class represents a method or constructor of a java class.

Version: $Id: ExecutableMemberDoc.java,v 1.4 2003/05/08 03:54:25 cananian Exp $

Author: C. Scott Ananian (cscott@cscott.net)

See Also: com.sun.javadoc.ExecutableMemberDoc

Method Summary
boolean	isNative() Return true if this method is native.
boolean	isSynchronized() Return true if this method is synchronized.
List<Parameter>	parameters() Get argument information.
List<ParamTag>	paramTags() Return the @param tags in this method.
String	signature() Return the signature, which is the parameter list with all types qualified.
List<Type>	thrownExceptions() Return exceptions this method or constructor throws.
List<ThrowsTag>	throwsTags() Return the @throws and @exception tags in this method.
List<MethodTypeVariable>	typeParameters() Return the type variables declared by this method, if it is generic; otherwise return a zero-length list.

Method Detail

isNative

public boolean isNative()

Return true if this method is native.

isSynchronized

public boolean isSynchronized()

Return true if this method is synchronized.

parameters

public List<Parameter> parameters()

Get argument information.

Returns: a list of parameters in source file order.

paramTags

public List<ParamTag> paramTags()

Return the @param tags in this method.

signature

public String signature()

Return the signature, which is the parameter list with all types qualified. For a method foo(String x, int y) the signature is "(java.lang.String,int)".

thrownExceptions

public List<Type> thrownExceptions()

Return exceptions this method or constructor throws.

throwsTags

public List<ThrowsTag> throwsTags()

Return the @throws and @exception tags in this method.

typeParameters

public List<MethodTypeVariable> typeParameters()

Return the type variables declared by this method, if it is generic; otherwise return a zero-length list.