Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util

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
Author:
Jamie Ho

  • Constructor Summary

    Constructors
    Constructor
    Description
    ClassDocCatalog()
    Deprecated.
    Construct a new ClassDocCatalog.
    ClassDocCatalog(ClassDoc[] classdocs, Configuration config)
    Deprecated.
    Construct a new ClassDocCatalog.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addClassDoc(ClassDoc classdoc)
    Deprecated.
    Add the given class to the catalog.
    ClassDoc[]
    allClasses(PackageDoc pkgDoc)
    Deprecated.
    Return all of the classes specified on the command-line that belong to the given package.
    ClassDoc[]
    allClasses(String packageName)
    Deprecated.
    Return all of the classes specified on the command-line that belong to the given package.
    ClassDoc[]
    annotationTypes(String packageName)
    Deprecated.
    Return all of the annotation types specified on the command-line that belong to the given package.
    ClassDoc[]
    enums(String packageName)
    Deprecated.
    Return all of the enums specified on the command-line that belong to the given package.
    ClassDoc[]
    errors(String packageName)
    Deprecated.
    Return all of the errors specified on the command-line that belong to the given package.
    ClassDoc[]
    exceptions(String packageName)
    Deprecated.
    Return all of the exceptions specified on the command-line that belong to the given package.
    ClassDoc[]
    interfaces(String packageName)
    Deprecated.
    Return all of the interfaces specified on the command-line that belong to the given package.
    boolean
    isKnownPackage(String packageName)
    Deprecated.
    Return true if the given package is known to this catalog.
    ClassDoc[]
    ordinaryClasses(String packageName)
    Deprecated.
    Return all of the ordinary classes specified on the command-line that belong to the given package.
    String[]
    packageNames()
    Deprecated.
    Return the array of package names that this catalog stores ClassDocs for.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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

    • addClassDoc

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

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