Package gw.gosudoc.com.sun.tools.javadoc.main

Class MethodDocImpl

java.lang.Object

gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

gw.gosudoc.com.sun.tools.javadoc.main.ProgramElementDocImpl

gw.gosudoc.com.sun.tools.javadoc.main.MemberDocImpl

gw.gosudoc.com.sun.tools.javadoc.main.ExecutableMemberDocImpl

gw.gosudoc.com.sun.tools.javadoc.main.MethodDocImpl

All Implemented Interfaces:

Doc, ExecutableMemberDoc, MemberDoc, MethodDoc, ProgramElementDoc, Comparable<Object>

Direct Known Subclasses:

AnnotationTypeElementDocImpl

@Deprecated
public class MethodDocImpl
extends ExecutableMemberDocImpl
implements MethodDoc

Deprecated.

Represents a method of a java class.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:

1.2

Author:

Robert Field, Neal Gafter (rewrite)

Field Summary

Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.ExecutableMemberDocImpl

sym

Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

documentation, env, treePath

Constructor Summary

Constructors

Constructor	Description
MethodDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.MethodSymbol sym)	Deprecated. constructor.
MethodDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.MethodSymbol sym, TreePath treePath)	Deprecated. constructor.

Method Summary

Modifier and Type	Method	Description
boolean	isAbstract()	Deprecated. Return true if this method is abstract
boolean	isDefault()	Deprecated. Return true if this method is default
boolean	isMethod()	Deprecated. Return true if it is a method, which it is.
String	name()	Deprecated. Returns the name of this Doc item.
ClassDoc	overriddenClass()	Deprecated. Return the class that originally defined the method that is overridden by the current definition, or null if no such class exists.
MethodDoc	overriddenMethod()	Deprecated. Return the method that this method overrides.
Type	overriddenType()	Deprecated. Return the type containing the method that this method overrides.
boolean	overrides(MethodDoc meth)	Deprecated. Tests whether this method overrides another.
String	qualifiedName()	Deprecated. Returns the qualified name of this Doc item.
Type	returnType()	Deprecated. Get return type.
String	toString()	Deprecated. Returns a string representation of this method.

Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.ExecutableMemberDocImpl

flatSignature, getContainingClass, getFlags, isIncluded, isNative, isSynchronized, isSynthetic, isVarArgs, parameters, paramTags, position, receiverType, signature, thrownExceptions, thrownExceptionTypes, throwsTags, typeParameters, typeParametersString, typeParamTags

Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.ProgramElementDocImpl

annotations, containingClass, containingPackage, getModifiers, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier

Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

commentText, compareTo, documentation, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isInterface, isOrdinaryClass, seeTags, setRawCommentText, tags, tags

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.gosudoc.com.sun.javadoc.Doc

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isOrdinaryClass, position, seeTags, setRawCommentText, tags, tags

Methods inherited from interface gw.gosudoc.com.sun.javadoc.ExecutableMemberDoc

flatSignature, isNative, isSynchronized, isVarArgs, parameters, paramTags, receiverType, signature, thrownExceptions, thrownExceptionTypes, throwsTags, typeParameters, typeParamTags

Methods inherited from interface gw.gosudoc.com.sun.javadoc.MemberDoc

isSynthetic

Methods inherited from interface gw.gosudoc.com.sun.javadoc.ProgramElementDoc

annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier

Constructor Detail

MethodDocImpl

public MethodDocImpl(DocEnv env,
                     com.sun.tools.javac.code.Symbol.MethodSymbol sym)

Deprecated.

constructor.

MethodDocImpl

public MethodDocImpl(DocEnv env,
                     com.sun.tools.javac.code.Symbol.MethodSymbol sym,
                     TreePath treePath)

Deprecated.

constructor.

Method Detail

isMethod

public boolean isMethod()

Deprecated.

Return true if it is a method, which it is. Note: constructors are not methods. This method is overridden by AnnotationTypeElementDocImpl.

Specified by:

isMethod in interface Doc

Overrides:

isMethod in class DocImpl

Returns:

true

isDefault

public boolean isDefault()

Deprecated.

Return true if this method is default

Specified by:

isDefault in interface MethodDoc

Returns:

true if this method is default

isAbstract

public boolean isAbstract()

Deprecated.

Return true if this method is abstract

Specified by:

isAbstract in interface MethodDoc

Returns:

true if this method is abstract

returnType

public Type returnType()

Deprecated.

Get return type.

Specified by:

returnType in interface MethodDoc

Returns:

the return type of this method, null if it is a constructor.

overriddenClass

public ClassDoc overriddenClass()

Deprecated.

Return the class that originally defined the method that is overridden by the current definition, or null if no such class exists.

Specified by:

overriddenClass in interface MethodDoc

Returns:

a ClassDocImpl representing the superclass that originally defined this method, null if this method does not override a definition in a superclass.

overriddenType

public Type overriddenType()

Deprecated.

Return the type containing the method that this method overrides. It may be a ClassDoc or a ParameterizedType.

Specified by:

overriddenType in interface MethodDoc

Returns:

the supertype whose method is overridden, or null if this method does not override another in a superclass

overriddenMethod

public MethodDoc overriddenMethod()

Deprecated.

Return the method that this method overrides.

Specified by:

overriddenMethod in interface MethodDoc

Returns:

a MethodDoc representing a method definition in a superclass this method overrides, null if this method does not override.

overrides

public boolean overrides(MethodDoc meth)

Deprecated.

Tests whether this method overrides another. The overridden method may be one declared in a superclass or a superinterface (unlike overriddenMethod()).

When a non-abstract method overrides an abstract one, it is also said to implement the other.

Specified by:

overrides in interface MethodDoc

Parameters:

meth - the other method to examine

Returns:

true if this method overrides the other

name

public String name()

Deprecated.

Description copied from class: DocImpl

Returns the name of this Doc item.

Specified by:

name in interface Doc

Specified by:

name in class DocImpl

Returns:

the name

qualifiedName

public String qualifiedName()

Deprecated.

Description copied from class: DocImpl

Returns the qualified name of this Doc item.

Specified by:

qualifiedName in interface ProgramElementDoc

Specified by:

qualifiedName in class DocImpl

Returns:

the name

toString

public String toString()

Deprecated.

Returns a string representation of this method. Includes the qualified signature, the qualified method name, and any type parameters. Type parameters follow the class name, as they do in the syntax for invoking methods with explicit type parameters.

Overrides:

toString in class DocImpl