PackageDoc (Java SE 11 & JDK 11 ) (original) (raw)
- All Superinterfaces:
[Comparable](../../../../java.base/java/lang/Comparable.html "interface in java.lang")<[Object](../../../../java.base/java/lang/Object.html "class in java.lang")>,[Doc](Doc.html "interface in com.sun.javadoc")
@Deprecated(since="9",
forRemoval=true)
public interface PackageDoc
extends Doc
Deprecated, for removal: This API element is subject to removal in a future version.
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
All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type Method Description ClassDoc[] allClasses() Deprecated, for removal: This API element is subject to removal in a future version. Get allincluded classes and interfaces in the package. ClassDoc[] allClasses(boolean filter) Deprecated, for removal: This API element is subject to removal in a future version. Get all classes and interfaces in the package, filtered to the specifiedaccess modifier option. AnnotationDesc[] annotations() Deprecated, for removal: This API element is subject to removal in a future version. Get the annotations of this package. AnnotationTypeDoc[] annotationTypes() Deprecated, for removal: This API element is subject to removal in a future version. Get included annotation types in this package. ClassDoc[] enums() Deprecated, for removal: This API element is subject to removal in a future version. Get included enum types in this package. ClassDoc[] errors() Deprecated, for removal: This API element is subject to removal in a future version. Get included Error classes in this package. ClassDoc[] exceptions() Deprecated, for removal: This API element is subject to removal in a future version. Get included Exception classes in this package. ClassDoc findClass(String className) Deprecated, for removal: This API element is subject to removal in a future version. Lookup a class or interface within this package. ClassDoc[] interfaces() Deprecated, for removal: This API element is subject to removal in a future version. Get included interfaces in this package, omitting annotation types. ClassDoc[] ordinaryClasses() Deprecated, for removal: This API element is subject to removal in a future version. Get includedordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package. * ### Methods declared in interface com.sun.javadoc.[Doc](Doc.html "interface in com.sun.javadoc") `[commentText](Doc.html#commentText%28%29), [compareTo](Doc.html#compareTo%28java.lang.Object%29), [firstSentenceTags](Doc.html#firstSentenceTags%28%29), [getRawCommentText](Doc.html#getRawCommentText%28%29), [inlineTags](Doc.html#inlineTags%28%29), [isAnnotationType](Doc.html#isAnnotationType%28%29), [isAnnotationTypeElement](Doc.html#isAnnotationTypeElement%28%29), [isClass](Doc.html#isClass%28%29), [isConstructor](Doc.html#isConstructor%28%29), [isEnum](Doc.html#isEnum%28%29), [isEnumConstant](Doc.html#isEnumConstant%28%29), [isError](Doc.html#isError%28%29), [isException](Doc.html#isException%28%29), [isField](Doc.html#isField%28%29), [isIncluded](Doc.html#isIncluded%28%29), [isInterface](Doc.html#isInterface%28%29), [isMethod](Doc.html#isMethod%28%29), [isOrdinaryClass](Doc.html#isOrdinaryClass%28%29), [name](Doc.html#name%28%29), [position](Doc.html#position%28%29), [seeTags](Doc.html#seeTags%28%29), [setRawCommentText](Doc.html#setRawCommentText%28java.lang.String%29), [tags](Doc.html#tags%28%29), [tags](Doc.html#tags%28java.lang.String%29)`Method Detail
* #### allClasses [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] allClasses(boolean filter) Deprecated, for removal: This API element is subject to removal in a future version. Get all classes and interfaces in the package, filtered to the specified[access modifier option](../../../../jdk.javadoc/com/sun/javadoc/package-summary.html#included). 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](ClassDoc.html "interface in com.sun.javadoc")[] allClasses() Deprecated, for removal: This API element is subject to removal in a future version. Get all[included](../../../../jdk.javadoc/com/sun/javadoc/package-summary.html#included) classes and interfaces in the package. Same as allClasses(true). Returns: all included classes and interfaces in this package. * #### ordinaryClasses [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] ordinaryClasses() Deprecated, for removal: This API element is subject to removal in a future version. Get included[ordinary](../../../../jdk.javadoc/com/sun/javadoc/package-summary.html#class) classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package. Returns: included ordinary classes in this package. * #### exceptions [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] exceptions() Deprecated, for removal: This API element is subject to removal in a future version. Get included Exception classes in this package. Returns: included Exceptions in this package. * #### errors [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] errors() Deprecated, for removal: This API element is subject to removal in a future version. Get included Error classes in this package. Returns: included Errors in this package. * #### enums [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] enums() Deprecated, for removal: This API element is subject to removal in a future version. Get included enum types in this package. Returns: included enum types in this package. Since: 1.5 * #### interfaces [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] interfaces() Deprecated, for removal: This API element is subject to removal in a future version. Get included interfaces in this package, omitting annotation types. Returns: included interfaces in this package. * #### annotationTypes [AnnotationTypeDoc](AnnotationTypeDoc.html "interface in com.sun.javadoc")[] annotationTypes() Deprecated, for removal: This API element is subject to removal in a future version. Get included annotation types in this package. Returns: included annotation types in this package. Since: 1.5 * #### annotations [AnnotationDesc](AnnotationDesc.html "interface in com.sun.javadoc")[] annotations() Deprecated, for removal: This API element is subject to removal in a future version. Get the annotations of this package. Return an empty array if there are none. Returns: the annotations of this package. Since: 1.5 * #### findClass [ClassDoc](ClassDoc.html "interface in com.sun.javadoc") findClass([String](../../../../java.base/java/lang/String.html "class in java.lang") className) Deprecated, for removal: This API element is subject to removal in a future version. 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.
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
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. Use is subject to license terms and the documentation redistribution policy.