Module jdk.javadoc

软件包 com.sun.javadoc

Interface ProgramElementDoc

All Superinterfaces:

Comparable<Object> ， Doc

All Known Subinterfaces:

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

已过时。

该包装中的声明已被包装jdk.javadoc.doclet的声明所取代。 有关详细信息，请参阅该软件包的文档中的“ 迁移指南” 。

@Deprecated
public interface ProgramElementDoc
extends Doc

表示一个java程序元素：class，interface，field，constructor或method。 这是一个处理这些元素共同的信息的抽象类。

另请参见：

MemberDoc ， ClassDoc

方法摘要

Modifier and Type	方法	描述
AnnotationDesc[]	annotations()	已过时。 获取此程序元素的注释。
ClassDoc	containingClass()	已过时。 获取该程序元素的包含类或接口。
PackageDoc	containingPackage()	已过时。 获取包含该程序元素的包。
boolean	isFinal()	已过时。 如果此程序元素为final，则返回true。
boolean	isPackagePrivate()	已过时。 如果这个程序元素是私有的，返回true。
boolean	isPrivate()	已过时。 如果此程序元素是私有的，则返回true。
boolean	isProtected()	已过时。 如果该程序元素被保护，返回true。
boolean	isPublic()	已过时。 如果此程序元素为public，则返回true。
boolean	isStatic()	已过时。 如果此程序元素是静态的，则返回true。
String	modifiers()	已过时。 获取修饰符字符串。
int	modifierSpecifier()	已过时。 获取修饰符说明符整数。
String	qualifiedName()	已过时。 获取此程序元素的完全限定名称。

Methods inherited from interface 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()

已过时。

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

结果

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

containingPackage

PackageDoc containingPackage()

已过时。

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

结果

这个包含包的包的PackageDoc。 如果在未命名的包中，该PackageDoc将具有名称“”。

qualifiedName

String qualifiedName()

已过时。

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

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

结果

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

modifierSpecifier

int modifierSpecifier()

已过时。

获取修饰符说明符整数。

结果

获取修饰符说明符整数。

另请参见：

Modifier

modifiers

String modifiers()

已过时。

获取修饰符字符串。 例如：

  public abstract int foo() { ... } 

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

结果

“公共摘要”。

annotations

AnnotationDesc[] annotations()

已过时。

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

结果

该程序元素的注释。

从以下版本开始：

1.5

isPublic

boolean isPublic()

已过时。

如果此程序元素为public，则返回true。

结果

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

isProtected

boolean isProtected()

已过时。

如果该程序元素被保护，返回true。

结果

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

isPrivate

boolean isPrivate()

已过时。

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

结果

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

isPackagePrivate

boolean isPackagePrivate()

已过时。

如果这个程序元素是私有的，返回true。

结果

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

isStatic

boolean isStatic()

已过时。

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

结果

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

isFinal

boolean isFinal()

已过时。

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

结果

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