模块 jdk.javadoc

软件包 com.sun.javadoc

Interface ProgramElementDoc

All Superinterfaces:

Comparable<Object> ， Doc

All Known Subinterfaces:

AnnotationTypeDoc ， AnnotationTypeElementDoc ， ClassDoc ， ConstructorDoc ， ExecutableMemberDoc ， FieldDoc ， MemberDoc ， MethodDoc

@Deprecated(since="9",
            forRemoval=true)
public interface ProgramElementDoc
extends Doc

Deprecated, for removal: This API element is subject to removal in a future version.

The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.

表示java程序元素：类，接口，字段，构造函数或方法。 这是一个处理这些元素共有信息的抽象类。

另请参见：

MemberDoc ， ClassDoc

方法摘要

变量和类型	方法	描述
AnnotationDesc[]	annotations()	不推荐使用，要删除：此API元素将在以后的版本中删除。 获取此程序元素的注释。
ClassDoc	containingClass()	不推荐使用，要删除：此API元素将在以后的版本中删除。 获取此程序元素的包含类或接口。
PackageDoc	containingPackage()	不推荐使用，要删除：此API元素将在以后的版本中删除。 获取包含此程序元素的包。
boolean	isFinal()	不推荐使用，要删除：此API元素将在以后的版本中删除。 如果此程序元素是final，则返回true。
boolean	isPackagePrivate()	不推荐使用，要删除：此API元素将在以后的版本中删除。 如果此程序元素是包私有，则返回true。
boolean	isPrivate()	不推荐使用，要删除：此API元素将在以后的版本中删除。 如果此程序元素是私有的，则返回true。
boolean	isProtected()	不推荐使用，要删除：此API元素将在以后的版本中删除。 如果此程序元素受保护，则返回true。
boolean	isPublic()	不推荐使用，要删除：此API元素将在以后的版本中删除。 如果此程序元素是公共的，则返回true。
boolean	isStatic()	不推荐使用，要删除：此API元素将在以后的版本中删除。 如果此程序元素是静态的，则返回true。
String	modifiers()	不推荐使用，要删除：此API元素将在以后的版本中删除。 获取修饰符字符串。
int	modifierSpecifier()	不推荐使用，要删除：此API元素将在以后的版本中删除。 获取修饰符说明符整数。
String	qualifiedName()	不推荐使用，要删除：此API元素将在以后的版本中删除。 获取此程序元素的完全限定名称。

声明方法的接口 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

方法详细信息

containingClass

ClassDoc containingClass()

Deprecated, for removal: This API element is subject to removal in a future version.

获取此程序元素的包含类或接口。

结果

包含类或接口的此元素的ClassDoc。 如果这是顶级类或接口，则返回null。

containingPackage

PackageDoc containingPackage()

Deprecated, for removal: This API element is subject to removal in a future version.

获取包含此程序元素的包。

结果

包含此包的元素的PackageDoc。 如果在未命名的包中，此PackageDoc将具有名称“”。

qualifiedName

String qualifiedName()

Deprecated, for removal: This API element is subject to removal in a future version.

获取此程序元素的完全限定名称。 例如，对于类java.util.Hashtable ，返回“java.util.Hashtable”。

对于未命名包中的类Foo中的方法bar() ，返回“Foo.bar”。

结果

程序元素的限定名称为String。

modifierSpecifier

int modifierSpecifier()

Deprecated, for removal: This API element is subject to removal in a future version.

获取修饰符说明符整数。

结果

获取修饰符说明符整数。

另请参见：

Modifier

modifiers

String modifiers()

Deprecated, for removal: This API element is subject to removal in a future version.

获取修饰符字符串。 例如，对于：

  public abstract int foo() { ... } 

返回“公共摘要”。 注释不包括在内。

结果

“公共抽象”。

annotations

AnnotationDesc[] annotations()

Deprecated, for removal: This API element is subject to removal in a future version.

获取此程序元素的注释。 如果没有，则返回一个空数组。

结果

该程序元素的注释。

从以下版本开始：

1.5

isPublic

boolean isPublic()

Deprecated, for removal: This API element is subject to removal in a future version.

如果此程序元素是公共的，则返回true。

结果

如果此程序元素是公共的，则为true。

isProtected

boolean isProtected()

Deprecated, for removal: This API element is subject to removal in a future version.

如果此程序元素受保护，则返回true。

结果

如果此程序元素受到保护，则为true。

isPrivate

boolean isPrivate()

Deprecated, for removal: This API element is subject to removal in a future version.

如果此程序元素是私有的，则返回true。

结果

如果此程序元素是私有的，则为true。

isPackagePrivate

boolean isPackagePrivate()

Deprecated, for removal: This API element is subject to removal in a future version.

如果此程序元素是包私有，则返回true。

结果

如果此程序元素是包私有，则返回true。

isStatic

boolean isStatic()

Deprecated, for removal: This API element is subject to removal in a future version.

如果此程序元素是静态的，则返回true。

结果

如果此程序元素是静态的，则为true。

isFinal

boolean isFinal()

Deprecated, for removal: This API element is subject to removal in a future version.

如果此程序元素是final，则返回true。

结果

如果此程序元素是最终的，则为true。