FileDocCategorySizeDatePackage
PackageDoc.javaAPI DocJava SE 5 API3143Fri Aug 26 14:54:54 BST 2005com.sun.javadoc

PackageDoc

public interface PackageDoc implements Doc
Represents a java package. Provides access to information about the package, the package's comment and tags, and the classes in the package.

Each method whose return type is an array will return an empty array (never null) when there are no objects in the result.

since
JDK1.2
author
Kaiyang Liu (original)
author
Robert Field (rewrite)

Fields Summary
Constructors Summary
Methods Summary
public ClassDoc[]allClasses(boolean filter)
Get all classes and interfaces in the package, filtered to the specified access modifier option.

return
filtered classes and interfaces in this package
param
filter Specifying true filters according to the specified access modifier option. Specifying false includes all classes and interfaces regardless of access modifier option.
since
1.4

public ClassDoc[]allClasses()
Get all included classes and interfaces in the package. Same as allClasses(true).

return
all included classes and interfaces in this package.

public AnnotationTypeDoc[]annotationTypes()
Get included annotation types in this package.

return
included annotation types in this package.
since
1.5

public AnnotationDesc[]annotations()
Get the annotations of this package. Return an empty array if there are none.

return
the annotations of this package.
since
1.5

public ClassDoc[]enums()
Get included enum types in this package.

return
included enum types in this package.
since
1.5

public ClassDoc[]errors()
Get included Error classes in this package.

return
included Errors in this package.

public ClassDoc[]exceptions()
Get included Exception classes in this package.

return
included Exceptions in this package.

public ClassDocfindClass(java.lang.String className)
Lookup a class or interface within this package.

return
ClassDoc of found class or interface, or null if not found.

public ClassDoc[]interfaces()
Get included interfaces in this package, omitting annotation types.

return
included interfaces in this package.

public ClassDoc[]ordinaryClasses()
Get included ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package.

return
included ordinary classes in this package.