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

Class ProgramElementDocImpl

java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
gw.gosudoc.com.sun.tools.javadoc.main.ProgramElementDocImpl
All Implemented Interfaces:
Doc, ProgramElementDoc, Comparable<Object>
Direct Known Subclasses:
ClassDocImpl, MemberDocImpl
@Deprecated public abstract class ProgramElementDocImpl extends DocImpl implements ProgramElementDoc
Deprecated.
Represents a java program element: class, interface, field, constructor, or method. This is an abstract class dealing with information common to these elements.

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.

See Also:

  • Field Details

    • sym

      private final com.sun.tools.javac.code.Symbol sym
      Deprecated.

    • tree

      com.sun.tools.javac.tree.JCTree tree
      Deprecated.

    • lineMap

      com.sun.tools.javac.util.Position.LineMap lineMap
      Deprecated.

    • modifiers

      private int modifiers
      Deprecated.

  • Constructor Details

    • ProgramElementDocImpl

      protected ProgramElementDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol sym, com.sun.source.util.TreePath treePath)
      Deprecated.

  • Method Details

    • setTreePath

      void setTreePath(com.sun.source.util.TreePath treePath)
      Deprecated.
      Description copied from class: DocImpl
      Set the full unprocessed text of the comment and tree path.
      Overrides:
      setTreePath in class DocImpl

    • getContainingClass

      protected abstract com.sun.tools.javac.code.Symbol.ClassSymbol getContainingClass()
      Deprecated.
      Subclasses override to identify the containing class

    • getFlags

      protected abstract long getFlags()
      Deprecated.
      Returns the flags in terms of javac's flags

    • getModifiers

      protected int getModifiers()
      Deprecated.
      Returns the modifier flags in terms of java.lang.reflect.Modifier.

    • containingClass

      public ClassDoc containingClass()
      Deprecated.
      Get the containing class of this program element.
      Specified by:
      containingClass in interface ProgramElementDoc
      Returns:
      a ClassDocImpl for this element's containing class. If this is a class with no outer class, return null.

    • containingPackage

      public PackageDoc containingPackage()
      Deprecated.
      Return the package that this member is contained in. Return "" if in unnamed package.
      Specified by:
      containingPackage in interface ProgramElementDoc
      Returns:
      a PackageDoc for this element containing package. If in the unnamed package, this PackageDoc will have the name "".

    • modifierSpecifier

      public int modifierSpecifier()
      Deprecated.
      Get the modifier specifier integer.
      Specified by:
      modifierSpecifier in interface ProgramElementDoc
      Returns:
      Get the modifier specifier integer.
      See Also:

    • modifiers

      public String modifiers()
      Deprecated.
      Get modifiers string. 
       Example, for:
   public abstract int foo() { ... }
 modifiers() would return:
   'public abstract'
      Annotations are not included.
      Specified by:
      modifiers in interface ProgramElementDoc
      Returns:
      "public abstract".

    • annotations

      public AnnotationDesc[] annotations()
      Deprecated.
      Get the annotations of this program element. Return an empty array if there are none.
      Specified by:
      annotations in interface ProgramElementDoc
      Returns:
      the annotations of this program element.

    • isPublic

      public boolean isPublic()
      Deprecated.
      Return true if this program element is public
      Specified by:
      isPublic in interface ProgramElementDoc
      Returns:
      true if this program element is public.

    • isProtected

      public boolean isProtected()
      Deprecated.
      Return true if this program element is protected
      Specified by:
      isProtected in interface ProgramElementDoc
      Returns:
      true if this program element is protected.

    • isPrivate

      public boolean isPrivate()
      Deprecated.
      Return true if this program element is private
      Specified by:
      isPrivate in interface ProgramElementDoc
      Returns:
      true if this program element is private.

    • isPackagePrivate

      public boolean isPackagePrivate()
      Deprecated.
      Return true if this program element is package private
      Specified by:
      isPackagePrivate in interface ProgramElementDoc
      Returns:
      true if this program element is package private.

    • isStatic

      public boolean isStatic()
      Deprecated.
      Return true if this program element is static
      Specified by:
      isStatic in interface ProgramElementDoc
      Returns:
      true if this program element is static.

    • isFinal

      public boolean isFinal()
      Deprecated.
      Return true if this program element is final
      Specified by:
      isFinal in interface ProgramElementDoc
      Returns:
      true if this program element is final.

    • generateKey

      CollationKey generateKey()
      Deprecated.
      Generate a key for sorting.
      Overrides:
      generateKey in class DocImpl