Class ClassDocCatalog

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.ClassDocCatalog
@Deprecated public class ClassDocCatalog extends Object
Deprecated.
This class acts as an artificial PackageDoc for classes specified on the command line when running Javadoc. For example, if you specify several classes from package java.lang, this class will catalog those classes so that we can retrieve all of the classes from a particular package later.

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

  • Field Details

    • packageSet

      private Set<String> packageSet
      Deprecated.
      Stores the set of packages that the classes specified on the command line belong to. Note that the default package is "".

    • allClasses

      private Map<String, Set<ClassDoc>> allClasses
      Deprecated.
      Stores all classes for each package

    • ordinaryClasses

      private Map<String, Set<ClassDoc>> ordinaryClasses
      Deprecated.
      Stores ordinary classes (excluding Exceptions and Errors) for each package

    • exceptions

      private Map<String, Set<ClassDoc>> exceptions
      Deprecated.
      Stores exceptions for each package

    • enums

      private Map<String, Set<ClassDoc>> enums
      Deprecated.
      Stores enums for each package.

    • annotationTypes

      private Map<String, Set<ClassDoc>> annotationTypes
      Deprecated.
      Stores annotation types for each package.

    • errors

      private Map<String, Set<ClassDoc>> errors
      Deprecated.
      Stores errors for each package

    • interfaces

      private Map<String, Set<ClassDoc>> interfaces
      Deprecated.
      Stores interfaces for each package

    • configuration

      private Configuration configuration
      Deprecated.

    • utils

      private Utils utils
      Deprecated.

  • Constructor Details

    • ClassDocCatalog

      public ClassDocCatalog(ClassDoc[] classdocs, Configuration config)
      Deprecated.
      Construct a new ClassDocCatalog.
      Parameters:
      classdocs - the array of ClassDocs to catalog

    • ClassDocCatalog

      public ClassDocCatalog()
      Deprecated.
      Construct a new ClassDocCatalog.

  • Method Details

    • init

      private void init()
      Deprecated.

    • addClassDoc

      public void addClassDoc(ClassDoc classdoc)
      Deprecated.
      Add the given class to the catalog.
      Parameters:
      classdoc - the ClassDoc to add to the catelog.

    • addClass

      private void addClass(ClassDoc classdoc, Map<String, Set<ClassDoc>> map)
      Deprecated.
      Add the given class to the given map.
      Parameters:
      classdoc - the ClassDoc to add to the catelog.
      map - the Map to add the ClassDoc to.

    • getArray

      private ClassDoc[] getArray(Map<String, Set<ClassDoc>> m, String key)
      Deprecated.

    • allClasses

      public ClassDoc[] allClasses(PackageDoc pkgDoc)
      Deprecated.
      Return all of the classes specified on the command-line that belong to the given package.
      Parameters:
      pkgDoc - the package to return the classes for.

    • allClasses

      public ClassDoc[] allClasses(String packageName)
      Deprecated.
      Return all of the classes specified on the command-line that belong to the given package.
      Parameters:
      packageName - the name of the package specified on the command-line.

    • packageNames

      public String[] packageNames()
      Deprecated.
      Return the array of package names that this catalog stores ClassDocs for.

    • isKnownPackage

      public boolean isKnownPackage(String packageName)
      Deprecated.
      Return true if the given package is known to this catalog.
      Parameters:
      packageName - the name to check.
      Returns:
      true if this catalog has any information about classes in the given package.

    • errors

      public ClassDoc[] errors(String packageName)
      Deprecated.
      Return all of the errors specified on the command-line that belong to the given package.
      Parameters:
      packageName - the name of the package specified on the command-line.

    • exceptions

      public ClassDoc[] exceptions(String packageName)
      Deprecated.
      Return all of the exceptions specified on the command-line that belong to the given package.
      Parameters:
      packageName - the name of the package specified on the command-line.

    • enums

      public ClassDoc[] enums(String packageName)
      Deprecated.
      Return all of the enums specified on the command-line that belong to the given package.
      Parameters:
      packageName - the name of the package specified on the command-line.

    • annotationTypes

      public ClassDoc[] annotationTypes(String packageName)
      Deprecated.
      Return all of the annotation types specified on the command-line that belong to the given package.
      Parameters:
      packageName - the name of the package specified on the command-line.

    • interfaces

      public ClassDoc[] interfaces(String packageName)
      Deprecated.
      Return all of the interfaces specified on the command-line that belong to the given package.
      Parameters:
      packageName - the name of the package specified on the command-line.

    • ordinaryClasses

      public ClassDoc[] ordinaryClasses(String packageName)
      Deprecated.
      Return all of the ordinary classes specified on the command-line that belong to the given package.
      Parameters:
      packageName - the name of the package specified on the command-line.