Class ClassDocCatalog
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.ClassDocCatalog
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 Summary
FieldsModifier and TypeFieldDescriptionDeprecated.Stores all classes for each packageDeprecated.Stores annotation types for each package.private Configuration
Deprecated.Deprecated.Stores enums for each package.Deprecated.Stores errors for each packageDeprecated.Stores exceptions for each packageDeprecated.Stores interfaces for each packageDeprecated.Stores ordinary classes (excluding Exceptions and Errors) for each packageDeprecated.Stores the set of packages that the classes specified on the command line belong to.private Utils
Deprecated. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Construct a new ClassDocCatalog.ClassDocCatalog
(ClassDoc[] classdocs, Configuration config) Deprecated.Construct a new ClassDocCatalog. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Deprecated.Add the given class to the given map.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[]
Deprecated.Return all of the enums specified on the command-line that belong to the given package.ClassDoc[]
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.private ClassDoc[]
Deprecated.private void
init()
Deprecated.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[]
Deprecated.Return the array of package names that this catalog stores ClassDocs for.
-
Field Details
-
packageSet
Deprecated.Stores the set of packages that the classes specified on the command line belong to. Note that the default package is "". -
allClasses
Deprecated.Stores all classes for each package -
ordinaryClasses
Deprecated.Stores ordinary classes (excluding Exceptions and Errors) for each package -
exceptions
Deprecated.Stores exceptions for each package -
enums
Deprecated.Stores enums for each package. -
annotationTypes
Deprecated.Stores annotation types for each package. -
errors
Deprecated.Stores errors for each package -
interfaces
Deprecated.Stores interfaces for each package -
configuration
Deprecated. -
utils
Deprecated.
-
-
Constructor Details
-
ClassDocCatalog
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
Deprecated.Add the given class to the catalog.- Parameters:
classdoc
- the ClassDoc to add to the catelog.
-
addClass
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
Deprecated. -
allClasses
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
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
Deprecated.Return the array of package names that this catalog stores ClassDocs for. -
isKnownPackage
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
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
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
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
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
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
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.
-