|
Doclet API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PackageDoc
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.
Method Summary | |
---|---|
ClassDoc[] |
allClasses()
Get all included classes and interfaces in the package. |
ClassDoc[] |
allClasses(boolean filter)
Get all classes and interfaces in the package, filtered to the specified access modifier option. |
AnnotationDesc[] |
annotations()
Get the annotations of this package. |
AnnotationTypeDoc[] |
annotationTypes()
Get included annotation types in this package. |
ClassDoc[] |
enums()
Get included enum types in this package. |
ClassDoc[] |
errors()
Get included Error classes in this package. |
ClassDoc[] |
exceptions()
Get included Exception classes in this package. |
ClassDoc |
findClass(String className)
Lookup a class or interface within this package. |
ClassDoc[] |
interfaces()
Get included interfaces in this package, omitting annotation types. |
ClassDoc[] |
ordinaryClasses()
Get included ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package. |
Methods inherited from interface com.sun.javadoc.Doc |
---|
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags |
Method Detail |
---|
ClassDoc[] allClasses(boolean filter)
filter
- Specifying true filters according to the specified access
modifier option.
Specifying false includes all classes and interfaces
regardless of access modifier option.
ClassDoc[] allClasses()
ClassDoc[] ordinaryClasses()
ClassDoc[] exceptions()
ClassDoc[] errors()
ClassDoc[] enums()
ClassDoc[] interfaces()
AnnotationTypeDoc[] annotationTypes()
AnnotationDesc[] annotations()
ClassDoc findClass(String className)
|
Doclet API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |