public interface PackageDoc extends Doc
Each method whose return type is an array will return an empty array (never null) when there are no objects in the result.
| Modifier and Type | Method | Description |
|---|---|---|
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.
|
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tagsClassDoc[] 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()
Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.