Class ExecutableMemberDocImpl
- 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
-
- All Implemented Interfaces:
Doc
,ExecutableMemberDoc
,MemberDoc
,ProgramElementDoc
,Comparable<Object>
- Direct Known Subclasses:
ConstructorDocImpl
,MethodDocImpl
@Deprecated public abstract class ExecutableMemberDocImpl extends MemberDocImpl implements ExecutableMemberDoc
Deprecated.Represents a method or constructor 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), Scott Seligman (generics, annotations)
-
-
Field Summary
Fields Modifier and Type Field Description protected com.sun.tools.javac.code.Symbol.MethodSymbol
sym
Deprecated.-
Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
documentation, env, treePath
-
-
Constructor Summary
Constructors Constructor Description ExecutableMemberDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.MethodSymbol sym)
Deprecated.Constructor.ExecutableMemberDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.MethodSymbol sym, com.sun.source.util.TreePath treePath)
Deprecated.Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
flatSignature()
Deprecated.Get flat signature.protected com.sun.tools.javac.code.Symbol.ClassSymbol
getContainingClass()
Deprecated.Identify the containing classprotected long
getFlags()
Deprecated.Returns the flags in terms of javac's flagsboolean
isIncluded()
Deprecated.return true if this Doc is include in the active set.boolean
isNative()
Deprecated.Return true if this method is nativeboolean
isSynchronized()
Deprecated.Return true if this method is synchronizedboolean
isSynthetic()
Deprecated.Returns true if this field was synthesized by the compiler.boolean
isVarArgs()
Deprecated.Return true if this method was declared to take a variable number of arguments.Parameter[]
parameters()
Deprecated.Get argument information.ParamTag[]
paramTags()
Deprecated.Return the param tags in this method, excluding the type parameter tags.SourcePosition
position()
Deprecated.Return the source position of the entity, or null if no position is available.Type
receiverType()
Deprecated.Get the receiver type of this executable element.String
signature()
Deprecated.Get the signature.ClassDoc[]
thrownExceptions()
Deprecated.Return exceptions this method or constructor throws.Type[]
thrownExceptionTypes()
Deprecated.Return exceptions this method or constructor throws.ThrowsTag[]
throwsTags()
Deprecated.Return the throws tags in this method.TypeVariable[]
typeParameters()
Deprecated.Return the formal type parameters of this method or constructor.protected String
typeParametersString()
Deprecated.ParamTag[]
typeParamTags()
Deprecated.Return the type parameter tags in this method.-
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, isMethod, isOrdinaryClass, name, qualifiedName, seeTags, setRawCommentText, tags, tags, toString
-
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, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags
-
Methods inherited from interface gw.gosudoc.com.sun.javadoc.ProgramElementDoc
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
-
-
-
-
Constructor Detail
-
ExecutableMemberDocImpl
public ExecutableMemberDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.MethodSymbol sym, com.sun.source.util.TreePath treePath)
Deprecated.Constructor.
-
ExecutableMemberDocImpl
public ExecutableMemberDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.MethodSymbol sym)
Deprecated.Constructor.
-
-
Method Detail
-
getFlags
protected long getFlags()
Deprecated.Returns the flags in terms of javac's flags- Specified by:
getFlags
in classProgramElementDocImpl
-
getContainingClass
protected com.sun.tools.javac.code.Symbol.ClassSymbol getContainingClass()
Deprecated.Identify the containing class- Specified by:
getContainingClass
in classProgramElementDocImpl
-
isNative
public boolean isNative()
Deprecated.Return true if this method is native- Specified by:
isNative
in interfaceExecutableMemberDoc
- Returns:
- true if this method is native
-
isSynchronized
public boolean isSynchronized()
Deprecated.Return true if this method is synchronized- Specified by:
isSynchronized
in interfaceExecutableMemberDoc
- Returns:
- true if this method is synchronized
-
isVarArgs
public boolean isVarArgs()
Deprecated.Return true if this method was declared to take a variable number of arguments.- Specified by:
isVarArgs
in interfaceExecutableMemberDoc
- Returns:
- true if this method was declared to take a variable number of arguments.
-
isSynthetic
public boolean isSynthetic()
Deprecated.Returns true if this field was synthesized by the compiler.- Specified by:
isSynthetic
in interfaceMemberDoc
- Specified by:
isSynthetic
in classMemberDocImpl
- Returns:
- true if this member was synthesized by the compiler.
-
isIncluded
public boolean isIncluded()
Deprecated.Description copied from class:DocImpl
return true if this Doc is include in the active set.- Specified by:
isIncluded
in interfaceDoc
- Specified by:
isIncluded
in classDocImpl
- Returns:
- true if this Doc item is included in the result set.
-
throwsTags
public ThrowsTag[] throwsTags()
Deprecated.Return the throws tags in this method.- Specified by:
throwsTags
in interfaceExecutableMemberDoc
- Returns:
- an array of ThrowTagImpl containing all
@exception
and@throws
tags.
-
paramTags
public ParamTag[] paramTags()
Deprecated.Return the param tags in this method, excluding the type parameter tags.- Specified by:
paramTags
in interfaceExecutableMemberDoc
- Returns:
- an array of ParamTagImpl containing all
@param
tags.
-
typeParamTags
public ParamTag[] typeParamTags()
Deprecated.Return the type parameter tags in this method.- Specified by:
typeParamTags
in interfaceExecutableMemberDoc
- Returns:
- an array of ParamTag containing all
@param
tags corresponding to the type parameters of this method.
-
thrownExceptions
public ClassDoc[] thrownExceptions()
Deprecated.Return exceptions this method or constructor throws.- Specified by:
thrownExceptions
in interfaceExecutableMemberDoc
- Returns:
- an array of ClassDoc[] representing the exceptions thrown by this method.
- See Also:
ExecutableMemberDoc.thrownExceptionTypes()
-
thrownExceptionTypes
public Type[] thrownExceptionTypes()
Deprecated.Return exceptions this method or constructor throws. Each array element is either aClassDoc
or aTypeVariable
.- Specified by:
thrownExceptionTypes
in interfaceExecutableMemberDoc
- Returns:
- an array representing the exceptions thrown by this method.
Each array element is either a
ClassDoc
or aTypeVariable
.
-
parameters
public Parameter[] parameters()
Deprecated.Get argument information.- Specified by:
parameters
in interfaceExecutableMemberDoc
- Returns:
- an array of ParameterImpl, one element per argument in the order the arguments are present.
- See Also:
ParameterImpl
-
receiverType
public Type receiverType()
Deprecated.Get the receiver type of this executable element.- Specified by:
receiverType
in interfaceExecutableMemberDoc
- Returns:
- the receiver type of this executable element.
- Since:
- 1.8
-
typeParameters
public TypeVariable[] typeParameters()
Deprecated.Return the formal type parameters of this method or constructor. Return an empty array if there are none.- Specified by:
typeParameters
in interfaceExecutableMemberDoc
- Returns:
- the formal type parameters of this method or constructor.
-
signature
public String signature()
Deprecated.Get the signature. It is the parameter list, type is qualified. For instance, for a methodmymethod(String x, int y)
, it will return(java.lang.String,int)
.- Specified by:
signature
in interfaceExecutableMemberDoc
- Returns:
- the parameter list where type is qualified.
-
flatSignature
public String flatSignature()
Deprecated.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 methodmymethod(String x, int y)
, it will return(String, int)
.- Specified by:
flatSignature
in interfaceExecutableMemberDoc
- Returns:
- a String, which is the flat signiture of this member.
-
typeParametersString
protected String typeParametersString()
Deprecated.
-
position
public SourcePosition position()
Deprecated.Return the source position of the entity, or null if no position is available.
-
-