Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.ExecutableMemberDoc

java.lang.Object
    |
    +----sun.tools.javadoc.Doc
            |
            +----sun.tools.javadoc.ProgramElementDoc
                    |
                    +----sun.tools.javadoc.MemberDoc
                            |
                            +----sun.tools.javadoc.ExecutableMemberDoc
Subclasses:
ConstructorDoc, MethodDoc

public class ExecutableMemberDoc
extends MemberDoc
Represents a method or constructor of a java class.

Since:
JDK1.2

Method Summary
java.lang.String  flatSignature()
get flat signature.
boolean  isNative()
Return true if this method is native
boolean  isSynchronized()
Return true if this method is synchronized
Parameter[]  parameters()
Get argument information.
ParamTag[]  paramTags()
Return the param tags in this method.
java.lang.String  signature()
Get the signature.
ClassDoc[]  thrownExceptions()
Return exceptions this method or constructor throws.
ThrowsTag[]  throwsTags()
Return the throws tags in this method.
 
Methods inherited from class sun.tools.javadoc.MemberDoc
 containingPackage, isIncluded, name, qualifiedName, toString
 
Methods inherited from class sun.tools.javadoc.ProgramElementDoc
 containingClass, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier
 
Methods inherited from class sun.tools.javadoc.Doc
 commentText, compareTo, getRawCommentText, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags, toString
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

thrownExceptions

public ClassDoc[] thrownExceptions()
Return exceptions this method or constructor throws.
Returns:
an array of Type[] representing the exceptions thrown by this method.

isNative

public boolean isNative()
Return true if this method is native

isSynchronized

public boolean isSynchronized()
Return true if this method is synchronized

parameters

public Parameter[] parameters()
Get argument information.
Returns:
an array of Parameter, one element per argument in the order the arguments are present.
See Also:
Parameter

throwsTags

public ThrowsTag[] throwsTags()
Return the throws tags in this method.
Returns:
an array of ThrowTag containing all @exception and @throws tags.

paramTags

public ParamTag[] paramTags()
Return the param tags in this method.
Returns:
an array of ParamTag containing all @param tags.

signature

public java.lang.String signature()
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).

flatSignature

public java.lang.String flatSignature()
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).

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS