FileDocCategorySizeDatePackage
ExecutableMemberDoc.javaAPI DocJava SE 5 API3540Fri Aug 26 14:54:54 BST 2005com.sun.javadoc

ExecutableMemberDoc

public interface ExecutableMemberDoc implements MemberDoc
Represents a method or constructor of a java class.
since
JDK1.2
author
Robert Field

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringflatSignature()
get flat signature. all types are not qualified. return a String, which is the flat signiture of this member. It is the parameter list, type is not qualified. For instance, for a method mymethod(String x, int y), it will return (String, int).

public booleanisNative()
Return true if this method is native

public booleanisSynchronized()
Return true if this method is synchronized

public booleanisVarArgs()
Return true if this method was declared to take a variable number of arguments.

since
1.5

public com.sun.javadoc.ParamTag[]paramTags()
Return the param tags in this method, excluding the type parameter tags.

return
an array of ParamTag containing all @param tags corresponding to the parameters of this method.

public com.sun.javadoc.Parameter[]parameters()
Get argument information.

see
Parameter
return
an array of Parameter, one element per argument in the order the arguments are present.

public java.lang.Stringsignature()
Get the signature. It is the parameter list, type is qualified. For instance, for a method mymethod(String x, int y), it will return (java.lang.String,int).

public com.sun.javadoc.Type[]thrownExceptionTypes()
Return exceptions this method or constructor throws.

return
an array representing the exceptions thrown by this method. Each array element is either a ClassDoc or a TypeVariable.
since
1.5

public com.sun.javadoc.ClassDoc[]thrownExceptions()
Return exceptions this method or constructor throws. If the type of the exception is a type variable, return the ClassDoc of its erasure.

The thrownExceptions method cannot accommodate certain generic type constructs. The thrownExceptionTypes method should be used instead.

return
an array of ClassDoc[] representing the exceptions thrown by this method.
see
#thrownExceptionTypes

public com.sun.javadoc.ThrowsTag[]throwsTags()
Return the throws tags in this method.

return
an array of ThrowTag containing all @exception and @throws tags.

public com.sun.javadoc.ParamTag[]typeParamTags()
Return the type parameter tags in this method.

return
an array of ParamTag containing all @param tags corresponding to the type parameters of this method.
since
1.5

public com.sun.javadoc.TypeVariable[]typeParameters()
Return the formal type parameters of this method or constructor. Return an empty array if this method or constructor is not generic.

return
the formal type parameters of this method or constructor.
since
1.5