Package gw.gosudoc.com.sun.javadoc
Interface PackageDoc
- All Superinterfaces:
Comparable<Object>
,Doc
- All Known Implementing Classes:
PackageDocImpl
Deprecated.
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:
- 1.2
-
Method Summary
Modifier and TypeMethodDescriptionClassDoc[]
Deprecated.Get all included classes and interfaces in the package.ClassDoc[]
allClasses
(boolean filter) Deprecated.Get all classes and interfaces in the package, filtered to the specified access modifier option.Deprecated.Get the annotations of this package.Deprecated.Get included annotation types in this package.ClassDoc[]
enums()
Deprecated.Get included enum types in this package.ClassDoc[]
errors()
Deprecated.Get included Error classes in this package.ClassDoc[]
Deprecated.Get included Exception classes in this package.Deprecated.Lookup a class or interface within this package.ClassDoc[]
Deprecated.Get included interfaces in this package, omitting annotation types.ClassDoc[]
Deprecated.Get included ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package.Methods inherited from interface gw.gosudoc.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 Details
-
allClasses
Deprecated.Get all classes and interfaces in the package, filtered to the specified access modifier option.- Parameters:
filter
- Specifying true filters according to the specified access modifier option. Specifying false includes all classes and interfaces regardless of access modifier option.- Returns:
- filtered classes and interfaces in this package
- Since:
- 1.4
-
allClasses
ClassDoc[] allClasses()Deprecated.Get all included classes and interfaces in the package. Same as allClasses(true).- Returns:
- all included classes and interfaces in this package.
-
ordinaryClasses
ClassDoc[] ordinaryClasses()Deprecated.Get included ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package.- Returns:
- included ordinary classes in this package.
-
exceptions
ClassDoc[] exceptions()Deprecated.Get included Exception classes in this package.- Returns:
- included Exceptions in this package.
-
errors
ClassDoc[] errors()Deprecated.Get included Error classes in this package.- Returns:
- included Errors in this package.
-
enums
ClassDoc[] enums()Deprecated.Get included enum types in this package.- Returns:
- included enum types in this package.
- Since:
- 1.5
-
interfaces
ClassDoc[] interfaces()Deprecated.Get included interfaces in this package, omitting annotation types.- Returns:
- included interfaces in this package.
-
annotationTypes
AnnotationTypeDoc[] annotationTypes()Deprecated.Get included annotation types in this package.- Returns:
- included annotation types in this package.
- Since:
- 1.5
-
annotations
AnnotationDesc[] annotations()Deprecated.Get the annotations of this package. Return an empty array if there are none.- Returns:
- the annotations of this package.
- Since:
- 1.5
-
findClass
Deprecated.Lookup a class or interface within this package.- Parameters:
className
- A String containing the name of the class to look up.- Returns:
- ClassDoc of found class or interface, or null if not found.
-
jdk.javadoc.doclet
. For more information, see the Migration Guide in the documentation for that package.