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

Class PackageDocImpl

java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
gw.gosudoc.com.sun.tools.javadoc.main.PackageDocImpl
All Implemented Interfaces:
Doc, PackageDoc, Comparable<Object>
@Deprecated public class PackageDocImpl extends DocImpl implements PackageDoc
Deprecated.
Represents a java package. Provides access to information about the package, the package's comment and tags, and the classes in the package.

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:
Kaiyang Liu (original), Robert Field (rewrite), Neal Gafter (rewrite), Scott Seligman (package-info.java)

  • Field Details

    • sym

      public final com.sun.tools.javac.code.Symbol.PackageSymbol sym
      Deprecated.

    • docPath

      public FileObject docPath
      Deprecated.

    • setDocPath

      public boolean setDocPath
      Deprecated.

  • Constructor Details

    • PackageDocImpl

      public PackageDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.PackageSymbol sym)
      Deprecated.
      Constructor

    • PackageDocImpl

      public PackageDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.PackageSymbol sym, com.sun.source.util.TreePath treePath)
      Deprecated.
      Constructor

  • Method Details

    • setTreePath

      public void setTreePath(com.sun.source.util.TreePath treePath)
      Deprecated.

    • documentation

      protected String documentation()
      Deprecated.
      Do lazy initialization of "documentation" string.
      Overrides:
      documentation in class DocImpl

    • addAllClassesTo

      public void addAllClassesTo(com.sun.tools.javac.util.ListBuffer<ClassDocImpl> list)
      Deprecated.
      Add all included classes (including Exceptions and Errors) and interfaces.

    • allClasses

      public ClassDoc[] allClasses(boolean filter)
      Deprecated.
      Get all classes (including Exceptions and Errors) and interfaces.
      Specified by:
      allClasses in interface PackageDoc
      Parameters:
      filter - Specifying true filters according to the specified access modifier option. Specifying false includes all classes and interfaces regardless of access modifier option.
      Returns:
      all classes and interfaces in this package, filtered to include only the included classes if filter==true.
      Since:
      J2SE1.4.

    • allClasses

      public ClassDoc[] allClasses()
      Deprecated.
      Get all included classes (including Exceptions and Errors) and interfaces. Same as allClasses(true).
      Specified by:
      allClasses in interface PackageDoc
      Returns:
      all included classes and interfaces in this package.

    • ordinaryClasses

      public ClassDoc[] ordinaryClasses()
      Deprecated.
      Get ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package.
      Specified by:
      ordinaryClasses in interface PackageDoc
      Returns:
      included ordinary classes in this package.

    • exceptions

      public ClassDoc[] exceptions()
      Deprecated.
      Get Exception classes in this package.
      Specified by:
      exceptions in interface PackageDoc
      Returns:
      included Exceptions in this package.

    • errors

      public ClassDoc[] errors()
      Deprecated.
      Get Error classes in this package.
      Specified by:
      errors in interface PackageDoc
      Returns:
      included Errors in this package.

    • enums

      public ClassDoc[] enums()
      Deprecated.
      Get included enum types in this package.
      Specified by:
      enums in interface PackageDoc
      Returns:
      included enum types in this package.

    • interfaces

      public ClassDoc[] interfaces()
      Deprecated.
      Get included interfaces in this package, omitting annotation types.
      Specified by:
      interfaces in interface PackageDoc
      Returns:
      included interfaces in this package.

    • annotationTypes

      public AnnotationTypeDoc[] annotationTypes()
      Deprecated.
      Get included annotation types in this package.
      Specified by:
      annotationTypes in interface PackageDoc
      Returns:
      included annotation types in this package.

    • annotations

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

    • findClass

      public ClassDoc findClass(String className)
      Deprecated.
      Lookup for a class within this package.
      Specified by:
      findClass in interface PackageDoc
      Parameters:
      className - A String containing the name of the class to look up.
      Returns:
      ClassDocImpl of found class, or null if not found.

    • isIncluded

      public boolean isIncluded()
      Deprecated.
      Return true if this package is included 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.

    • name

      public String name()
      Deprecated.
      Get package name. Note that we do not provide a means of obtaining the simple name of a package -- package names are always returned in their uniquely qualified form.
      Specified by:
      name in interface Doc
      Specified by:
      name in class DocImpl
      Returns:
      the name

    • qualifiedName

      public String qualifiedName()
      Deprecated.
      Get package name.
      Specified by:
      qualifiedName in class DocImpl
      Returns:
      the name

    • setDocPath

      public void setDocPath(FileObject path)
      Deprecated.
      set doc path for an unzipped directory

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