Class 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
  • Field Details

    • sym

      protected final com.sun.tools.javac.code.Symbol.MethodSymbol sym
      Deprecated.
  • Constructor Details

    • 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 Details

    • getFlags

      protected long getFlags()
      Deprecated.
      Returns the flags in terms of javac's flags
      Specified by:
      getFlags in class ProgramElementDocImpl
    • getContainingClass

      protected com.sun.tools.javac.code.Symbol.ClassSymbol getContainingClass()
      Deprecated.
      Identify the containing class
      Specified by:
      getContainingClass in class ProgramElementDocImpl
    • isNative

      public boolean isNative()
      Deprecated.
      Return true if this method is native
      Specified by:
      isNative in interface ExecutableMemberDoc
      Returns:
      true if this method is native
    • isSynchronized

      public boolean isSynchronized()
      Deprecated.
      Return true if this method is synchronized
      Specified by:
      isSynchronized in interface ExecutableMemberDoc
      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 interface ExecutableMemberDoc
      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 interface MemberDoc
      Specified by:
      isSynthetic in class MemberDocImpl
      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 interface Doc
      Specified by:
      isIncluded in class DocImpl
      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 interface ExecutableMemberDoc
      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 interface ExecutableMemberDoc
      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 interface ExecutableMemberDoc
      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 interface ExecutableMemberDoc
      Returns:
      an array of ClassDoc[] representing the exceptions thrown by this method.
      See Also:
    • thrownExceptionTypes

      public Type[] thrownExceptionTypes()
      Deprecated.
      Return exceptions this method or constructor throws. Each array element is either a ClassDoc or a TypeVariable.
      Specified by:
      thrownExceptionTypes in interface ExecutableMemberDoc
      Returns:
      an array representing the exceptions thrown by this method. Each array element is either a ClassDoc or a TypeVariable.
    • parameters

      public Parameter[] parameters()
      Deprecated.
      Get argument information.
      Specified by:
      parameters in interface ExecutableMemberDoc
      Returns:
      an array of ParameterImpl, one element per argument in the order the arguments are present.
      See Also:
    • receiverType

      public Type receiverType()
      Deprecated.
      Get the receiver type of this executable element.
      Specified by:
      receiverType in interface ExecutableMemberDoc
      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 interface ExecutableMemberDoc
      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 method mymethod(String x, int y), it will return (java.lang.String,int).
      Specified by:
      signature in interface ExecutableMemberDoc
      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 method mymethod(String x, int y), it will return (String, int).
      Specified by:
      flatSignature in interface ExecutableMemberDoc
      Returns:
      a String, which is the flat signiture of this member.
    • makeSignature

      private String makeSignature(boolean full)
      Deprecated.
    • typeParametersString

      protected String typeParametersString()
      Deprecated.
    • generateKey

      CollationKey generateKey()
      Deprecated.
      Generate a key for sorting.
      Overrides:
      generateKey in class ProgramElementDocImpl
    • position

      public SourcePosition position()
      Deprecated.
      Return the source position of the entity, or null if no position is available.
      Specified by:
      position in interface Doc
      Overrides:
      position in class DocImpl
      Returns:
      the source positino of the first line of the corresponding declaration, or null if no position is available. A default constructor returns null because it has no location in the source file.