| java.lang.Object
 com.sun.tools.javadoc.DocImpl
com.sun.tools.javadoc.PackageDocImpl
| PackageDocImpl | | public class PackageDocImpl extends DocImpl implements PackageDoc(Code) | | Represents a java package. Provides access to information
about the package, the package's comment and tags, and the
classes in the package.
since:
1.2
author:
Kaiyang Liu (original)
author:
Robert Field (rewrite)
author:
Neal Gafter (rewrite)
author:
Scott Seligman (package-info.java) |
| Method Summary | |
| public void | addAllClassesTo(ListBuffer<ClassDocImpl> list)
Add all included classes (including Exceptions and Errors)
and interfaces. | | public ClassDoc[] | allClasses(boolean filter)
Get all classes (including Exceptions and Errors)
and interfaces.
since:
J2SE1.4. | | public ClassDoc[] | allClasses()
Get all included classes (including Exceptions and Errors)
and interfaces. | | public AnnotationTypeDoc[] | annotationTypes()
Get included annotation types in this package. | | public AnnotationDesc[] | annotations()
Get the annotations of this package. | | String | documentation()
Do lazy initialization of "documentation" string. | | public ClassDoc[] | enums()
Get included enum types in this package. | | public ClassDoc[] | errors()
Get Error classes in this package. | | public ClassDoc[] | exceptions()
Get Exception classes in this package. | | public ClassDoc | findClass(String className)
Lookup for a class within this package. | | public ClassDoc[] | interfaces()
Get included interfaces in this package, omitting annotation types. | | public boolean | isIncluded()
Return true if this package is included in the active set. | | public String | name()
Get package name. | | public ClassDoc[] | ordinaryClasses()
Get ordinary classes (that is, exclude exceptions, errors,
enums, interfaces, and annotation types) in this package. | | public SourcePosition | position()
Return the source position of the entity, or null if
no position is available. | | public String | qualifiedName()
Get package name. | | public void | setDocPath(String path)
| | public void | setDocPath(String path, String entry)
| | public void | setRawCommentText(String rawDocumentation)
| | void | setTree(JCTree tree)
|
| isIncluded | | boolean isIncluded(Code) | | |
| setDocPath | | public boolean setDocPath(Code) | | |
| sym | | protected PackageSymbol sym(Code) | | |
| PackageDocImpl | | public PackageDocImpl(DocEnv env, PackageSymbol sym)(Code) | | Constructor
|
| addAllClassesTo | | public void addAllClassesTo(ListBuffer<ClassDocImpl> list)(Code) | | Add all included classes (including Exceptions and Errors)
and interfaces.
|
| allClasses | | public ClassDoc[] allClasses(boolean filter)(Code) | | Get all classes (including Exceptions and Errors)
and interfaces.
since:
J2SE1.4. all classes and interfaces in this package, filtered to includeonly the included classes if filter==true. |
| allClasses | | public ClassDoc[] allClasses()(Code) | | Get all included classes (including Exceptions and Errors)
and interfaces. Same as allClasses(true).
all included classes and interfaces in this package. |
| annotationTypes | | public AnnotationTypeDoc[] annotationTypes()(Code) | | Get included annotation types in this package.
included annotation types in this package. |
| annotations | | public AnnotationDesc[] annotations()(Code) | | Get the annotations of this package.
Return an empty array if there are none.
|
| documentation | | String documentation()(Code) | | Do lazy initialization of "documentation" string.
|
| enums | | public ClassDoc[] enums()(Code) | | Get included enum types in this package.
included enum types in this package. |
| errors | | public ClassDoc[] errors()(Code) | | Get Error classes in this package.
included Errors in this package. |
| exceptions | | public ClassDoc[] exceptions()(Code) | | Get Exception classes in this package.
included Exceptions in this package. |
| findClass | | public ClassDoc findClass(String className)(Code) | | Lookup for a class within this package.
ClassDocImpl of found class, or null if not found. |
| interfaces | | public ClassDoc[] interfaces()(Code) | | Get included interfaces in this package, omitting annotation types.
included interfaces in this package. |
| isIncluded | | public boolean isIncluded()(Code) | | Return true if this package is included in the active set.
|
| name | | public String name()(Code) | | 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.
|
| ordinaryClasses | | public ClassDoc[] ordinaryClasses()(Code) | | Get ordinary classes (that is, exclude exceptions, errors,
enums, interfaces, and annotation types) in this package.
included ordinary classes in this package. |
| position | | public SourcePosition position()(Code) | | Return the source position of the entity, or null if
no position is available.
|
| qualifiedName | | public String qualifiedName()(Code) | | Get package name.
|
| setDocPath | | public void setDocPath(String path)(Code) | | set doc path for an unzipped directory
|
| setDocPath | | public void setDocPath(String path, String entry)(Code) | | set the doc path for zipped directory
|
| setRawCommentText | | public void setRawCommentText(String rawDocumentation)(Code) | | |
|
|