Module jdk.compiler

软件包 com.sun.source.doctree

Enum DocTree.Kind

java.lang.Object

java.lang.Enum<DocTree.Kind>

com.sun.source.doctree.DocTree.Kind

All Implemented Interfaces:

Serializable ， Comparable<DocTree.Kind>

Enclosing interface:

DocTree

public static enum DocTree.Kind
extends Enum<DocTree.Kind>

列举各种树木。

Enum Constant Summary

Enum Constants

Enum Constant	描述
ATTRIBUTE	用于表示HTML属性的AttributeTree的实例。
AUTHOR	用于表示@author标签的AuthorTree的实例。
CODE	用于表示@code标签的LiteralTree的实例。
COMMENT	用于表示HTML注释的CommentTree的实例。
DEPRECATED	用于实例DeprecatedTree表示@deprecated标记。
DOC_COMMENT	用于表示完整文档注释的DocCommentTree的实例。
DOC_ROOT	用于实例DocRootTree表示@docRoot标签。
END_ELEMENT	用于表示HTML元素结尾的EndElementTree的实例。
ENTITY	用于表示HTML实体的EntityTree的实例。
ERRONEOUS	用于表示一些无效文本的ErroneousTree的实例。
EXCEPTION	用于表示@exception标签的ThrowsTree的实例。
HIDDEN	用于实例HiddenTree表示@hidden标签。
IDENTIFIER	用于表示标识符的IdentifierTree的实例。
INDEX	用于表示搜索项的IndexTree的实例。
INHERIT_DOC	用于实例InheritDocTree表示@inheritDoc标签。
LINK	用于表示@link标签的LinkTree的实例。
LINK_PLAIN	用于实例LinkTree表示@linkplain标签。
LITERAL	用于实例LiteralTree表示@literal标签。
OTHER	实现保留节点。
PARAM	用于表示@param标签的ParamTree的实例。
PROVIDES	用于表示@provides标记的ProvidesTree的实例。
REFERENCE	用于表示对Java编程语言中的元素的引用的ReferenceTree的实例。
RETURN	用于代表一个@return标签的ReturnTree的实例。
SEE	用于表示@see标签的SeeTree的实例。
SERIAL	用于实例SerialTree表示@serial标签。
SERIAL_DATA	用于实例SerialDataTree表示@serialData标签。
SERIAL_FIELD	用于表示@serialField标记的SerialFieldTree的实例。
SINCE	用于实例SinceTree表示@Since标签。
START_ELEMENT	用于表示HTML元素开始的EndElementTree的实例。
TEXT	用于表示一些文档文本的TextTree的实例。
THROWS	用于表示@throws标签的ThrowsTree的实例。
UNKNOWN_BLOCK_TAG	用于表示未知块标签的UnknownBlockTagTree的实例。
UNKNOWN_INLINE_TAG	用于表示未知内联标签的UnknownInlineTagTree的实例。
USES	用于实例UsesTree表示@uses标签。
VALUE	用于表示@value标签的ValueTree的实例。
VERSION	用于表示一个@version标签的VersionTree的实例。

Field Summary

Fields

Modifier and Type	Field	描述
String	tagName	与此类节点相关联的标记名称（如果有）。

方法摘要

Modifier and Type	方法	描述
static DocTree.Kind	valueOf(String name)	以指定的名称返回此类型的枚举常量。
static DocTree.Kind[]	values()	按照它们声明的顺序返回一个包含此枚举类型常量的数组。

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ATTRIBUTE

public static final DocTree.Kind ATTRIBUTE

用于表示HTML属性的AttributeTree的实例。

AUTHOR

public static final DocTree.Kind AUTHOR

用于表示@author标签的AuthorTree的实例。

CODE

public static final DocTree.Kind CODE

用于表示@code标签的LiteralTree的实例。

COMMENT

public static final DocTree.Kind COMMENT

用于表示HTML注释的CommentTree的实例。

DEPRECATED

public static final DocTree.Kind DEPRECATED

用于实例DeprecatedTree表示@deprecated标记。

DOC_COMMENT

public static final DocTree.Kind DOC_COMMENT

用于表示完整文档注释的DocCommentTree的实例。

DOC_ROOT

public static final DocTree.Kind DOC_ROOT

用于实例DocRootTree表示@docRoot标签。

END_ELEMENT

public static final DocTree.Kind END_ELEMENT

用于表示HTML元素结尾的EndElementTree的实例。

ENTITY

public static final DocTree.Kind ENTITY

用于表示HTML实体的EntityTree的实例。

ERRONEOUS

public static final DocTree.Kind ERRONEOUS

用于表示一些无效文本的ErroneousTree的实例。

EXCEPTION

public static final DocTree.Kind EXCEPTION

用于表示@exception标签的ThrowsTree的实例。

HIDDEN

public static final DocTree.Kind HIDDEN

用于实例HiddenTree表示@hidden标签。

IDENTIFIER

public static final DocTree.Kind IDENTIFIER

用于表示标识符的IdentifierTree的实例。

INDEX

public static final DocTree.Kind INDEX

用于表示搜索项的IndexTree的实例。

INHERIT_DOC

public static final DocTree.Kind INHERIT_DOC

用于实例InheritDocTree表示@inheritDoc标签。

LINK

public static final DocTree.Kind LINK

用于表示@link标签的LinkTree的实例。

LINK_PLAIN

public static final DocTree.Kind LINK_PLAIN

用于实例LinkTree表示@linkplain标签。

LITERAL

public static final DocTree.Kind LITERAL

用于实例LiteralTree表示@literal标签。

PARAM

public static final DocTree.Kind PARAM

用于表示@param标签的ParamTree的实例。

PROVIDES

public static final DocTree.Kind PROVIDES

用于表示@provides标记的ProvidesTree的实例。

REFERENCE

public static final DocTree.Kind REFERENCE

用于表示对Java编程语言中的元素的引用的ReferenceTree的实例。

RETURN

public static final DocTree.Kind RETURN

用于代表一个@return标签的ReturnTree的实例。

SEE

public static final DocTree.Kind SEE

用于表示@see标签的SeeTree的实例。

SERIAL

public static final DocTree.Kind SERIAL

用于实例SerialTree表示@serial标签。

SERIAL_DATA

public static final DocTree.Kind SERIAL_DATA

用于实例SerialDataTree表示@serialData标签。

SERIAL_FIELD

public static final DocTree.Kind SERIAL_FIELD

用于表示@serialField标记的SerialFieldTree的实例。

SINCE

public static final DocTree.Kind SINCE

用于实例SinceTree表示@Since标签。

START_ELEMENT

public static final DocTree.Kind START_ELEMENT

用于表示HTML元素开始的EndElementTree的实例。

TEXT

public static final DocTree.Kind TEXT

用于表示一些文档文本的TextTree的实例。

THROWS

public static final DocTree.Kind THROWS

用于表示@throws标签的ThrowsTree的实例。

UNKNOWN_BLOCK_TAG

public static final DocTree.Kind UNKNOWN_BLOCK_TAG

用于表示未知块标签的UnknownBlockTagTree的实例。

UNKNOWN_INLINE_TAG

public static final DocTree.Kind UNKNOWN_INLINE_TAG

用于表示未知内联标签的UnknownInlineTagTree的实例。

USES

public static final DocTree.Kind USES

用于实例UsesTree表示@uses标签。

VALUE

public static final DocTree.Kind VALUE

用于表示@value标签的ValueTree的实例。

VERSION

public static final DocTree.Kind VERSION

用于代表一个@version标签的VersionTree的实例。

OTHER

public static final DocTree.Kind OTHER

实现保留节点。 这不是您要查找的节点。

字段详细信息

tagName

public final String tagName

与此类节点相关联的标记名称（如果有）。

方法详细信息

values

public static DocTree.Kind[] values()

按照它们声明的顺序返回一个包含此枚举类型常量的数组。 该方法可用于遍历常量如下：

  for (DocTree.Kind c : DocTree.Kind.values())
    System.out.println(c); 

结果

一个包含这个枚举类型的常量的数组，按照它们被声明的顺序

valueOf

public static DocTree.Kind valueOf(String name)

以指定的名称返回此类型的枚举常量。 字符串必须完全匹配用于声明此类型的枚举常量的标识符。 （不允许使用外来空白字符。）

参数

name - 要返回的枚举常量的名称。

结果

具有指定名称的枚举常数

异常

IllegalArgumentException - 如果此枚举类型没有指定名称的常量

NullPointerException - 如果参数为null