ProgramElementDoc (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")
All Known Subinterfaces:[AnnotationTypeDoc](AnnotationTypeDoc.html "interface in com.sun.javadoc"),[AnnotationTypeElementDoc](AnnotationTypeElementDoc.html "interface in com.sun.javadoc"),[ClassDoc](ClassDoc.html "interface in com.sun.javadoc"),[ConstructorDoc](ConstructorDoc.html "interface in com.sun.javadoc"),[ExecutableMemberDoc](ExecutableMemberDoc.html "interface in com.sun.javadoc"),[FieldDoc](FieldDoc.html "interface in com.sun.javadoc"),[MemberDoc](MemberDoc.html "interface in com.sun.javadoc"),[MethodDoc](MethodDoc.html "interface in com.sun.javadoc")
@Deprecated(since="9",
forRemoval=true)
public interface ProgramElementDoc
extends Doc
Deprecated, for removal: This API element is subject to removal in a future version.
Represents a java program element: class, interface, field, constructor, or method. This is an abstract class dealing with information common to these elements.
See Also:
MemberDoc, ClassDoc
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type Method Description AnnotationDesc[] annotations() Deprecated, for removal: This API element is subject to removal in a future version. Get the annotations of this program element. ClassDoc containingClass() Deprecated, for removal: This API element is subject to removal in a future version. Get the containing class or interface of this program element. PackageDoc containingPackage() Deprecated, for removal: This API element is subject to removal in a future version. Get the package that this program element is contained in. boolean isFinal() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is final. boolean isPackagePrivate() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is package private. boolean isPrivate() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is private. boolean isProtected() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is protected. boolean isPublic() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is public. boolean isStatic() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is static. String modifiers() Deprecated, for removal: This API element is subject to removal in a future version. Get modifiers string. int modifierSpecifier() Deprecated, for removal: This API element is subject to removal in a future version. Get the modifier specifier integer. String qualifiedName() Deprecated, for removal: This API element is subject to removal in a future version. Get the fully qualified name of this program element. * ### 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
* #### containingClass [ClassDoc](ClassDoc.html "interface in com.sun.javadoc") containingClass() Deprecated, for removal: This API element is subject to removal in a future version. Get the containing class or interface of this program element. Returns: a ClassDoc for this element's containing class or interface. If this is a top-level class or interface, return null. * #### containingPackage [PackageDoc](PackageDoc.html "interface in com.sun.javadoc") containingPackage() Deprecated, for removal: This API element is subject to removal in a future version. Get the package that this program element is contained in. Returns: a PackageDoc for this element containing package. If in the unnamed package, this PackageDoc will have the name "". * #### qualifiedName [String](../../../../java.base/java/lang/String.html "class in java.lang") qualifiedName() Deprecated, for removal: This API element is subject to removal in a future version. Get the fully qualified name of this program element. For example, for the class `java.util.Hashtable`, return "java.util.Hashtable". For the method `bar()` in class `Foo` in the unnamed package, return "Foo.bar". Returns: the qualified name of the program element as a String. * #### modifierSpecifier int modifierSpecifier() Deprecated, for removal: This API element is subject to removal in a future version. Get the modifier specifier integer. Returns: Get the modifier specifier integer. See Also: [Modifier](../../../../java.base/java/lang/reflect/Modifier.html "class in java.lang.reflect") * #### modifiers [String](../../../../java.base/java/lang/String.html "class in java.lang") modifiers() Deprecated, for removal: This API element is subject to removal in a future version. Get modifiers string. For example, for: public abstract int foo() { ... } return "public abstract". Annotations are not included. Returns: "public abstract". * #### 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 program element. Return an empty array if there are none. Returns: the annotations of this program element. Since: 1.5 * #### isPublic boolean isPublic() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is public. Returns: true if this program element is public. * #### isProtected boolean isProtected() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is protected. Returns: true if this program element is protected. * #### isPrivate boolean isPrivate() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is private. Returns: true if this program element is private. * #### isPackagePrivate boolean isPackagePrivate() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is package private. Returns: true if this program element is package private. * #### isStatic boolean isStatic() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is static. Returns: true if this program element is static. * #### isFinal boolean isFinal() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this program element is final. Returns: true if this program element is final.
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.