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

Class sun.tools.javadoc.MethodDoc

java.lang.Object
    |
    +----sun.tools.javadoc.Doc
            |
            +----sun.tools.javadoc.ProgramElementDoc
                    |
                    +----sun.tools.javadoc.MemberDoc
                            |
                            +----sun.tools.javadoc.ExecutableMemberDoc
                                    |
                                    +----sun.tools.javadoc.MethodDoc

public class MethodDoc
extends ExecutableMemberDoc
Represents a method of a java class.

Since:
JDK1.2

Method Summary
boolean  isAbstract()
Return true if this method is abstract
boolean  isMethod()
Return true if it is a method, which it is.
ClassDoc  overridenClass(sun.tools.javadoc.Env env, sun.tools.java.MemberDefinition f)
Constructor assist Return the class that overrides this method.
ClassDoc  overridenClass()
Return the class that overrides this method.
Type  returnType()
Get return type.
 
Methods inherited from class sun.tools.javadoc.ExecutableMemberDoc
 flatSignature, isNative, isSynchronized, parameters, paramTags, signature, thrownExceptions, throwsTags
 
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

overridenClass

public ClassDoc overridenClass(sun.tools.javadoc.Env env,
                               sun.tools.java.MemberDefinition f)
Constructor assist Return the class that overrides this method.
Returns:
a Type representing the superclass that overrides this method, null if this method is not overriden.

isMethod

public boolean isMethod()
Return true if it is a method, which it is. Note: constructors are not methods.
Returns:
tree
Overrides:
isMethod in class Doc

isAbstract

public boolean isAbstract()
Return true if this method is abstract

returnType

public Type returnType()
Get return type.
Returns:
the return type of this method, null if it is a constructor.

overridenClass

public ClassDoc overridenClass()
Return the class that overrides this method.
Returns:
a ClassDoc representing the superclass that overrides this method, null if this method is not overriden.

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