- All Implemented Interfaces:
Serializable,Comparable<DocTree.Kind>,Constable
- Enclosing interface:
DocTree
Enumerates all kinds of trees.
-
Nested Class Summary
Nested classes/interfaces declared in class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionUsed for instances ofAttributeTreerepresenting an attribute in an HTML element or tag.Used for instances ofAuthorTreerepresenting an@authortag.Used for instances ofLiteralTreerepresenting an@codetag.Used for instances ofCommentTreerepresenting an HTML comment.Used for instances ofDeprecatedTreerepresenting an@deprecatedtag.Used for instances ofDocCommentTreerepresenting a complete doc comment.Used for instances ofDocRootTreerepresenting an@docRoottag.Used for instances ofDocTypeTreerepresenting an HTML DocType declaration.Used for instances ofEndElementTreerepresenting the end of an HTML element.Used for instances ofEntityTreerepresenting an HTML entity.Used for instances ofErroneousTreerepresenting some invalid text.Used for instances ofEscapeTreerepresenting some escaped documentation text.Used for instances ofThrowsTreerepresenting an@exceptiontag.Used for instances ofHiddenTreerepresenting an@hiddentag.Used for instances ofIdentifierTreerepresenting an identifier.Used for instances ofIndexTreerepresenting an@indextag.Used for instances ofInheritDocTreerepresenting an@inheritDoctag.Used for instances ofLinkTreerepresenting an@linktag.Used for instances ofLinkTreerepresenting an@linkplaintag.Used for instances ofLiteralTreerepresenting an@literaltag.An implementation-reserved node.Used for instances ofParamTreerepresenting an@paramtag.Used for instances ofProvidesTreerepresenting an@providestag.Used for instances ofReferenceTreerepresenting a reference to an element in the Java programming language.Used for instances ofReturnTreerepresenting an@returntag.Used for instances ofSeeTreerepresenting an@seetag.Used for instances ofSerialTreerepresenting an@serialtag.Used for instances ofSerialDataTreerepresenting an@serialDatatag.Used for instances ofSerialFieldTreerepresenting an@serialFieldtag.Used for instances ofSinceTreerepresenting an@sincetag.Used for instances ofSnippetTreerepresenting an@snippettag.Used for instances ofSpecTreerepresenting an@spectag.Used for instances ofStartElementTreerepresenting the start of an HTML element.Used for instances ofSummaryTreerepresenting an@summarytag.Used for instances ofSystemPropertyTreerepresenting an@systemPropertytag.Used for instances ofTextTreerepresenting some plain documentation text.Used for instances ofThrowsTreerepresenting an@throwstag.Used for instances ofUnknownBlockTagTreerepresenting an unknown block tag.Used for instances ofUnknownInlineTagTreerepresenting an unknown inline tag.Used for instances ofUsesTreerepresenting an@usestag.Used for instances ofValueTreerepresenting an@valuetag.Used for instances ofVersionTreerepresenting an@versiontag. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic DocTree.KindReturns the enum constant of this class with the specified name.static DocTree.Kind[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ATTRIBUTE
Used for instances ofAttributeTreerepresenting an attribute in an HTML element or tag. -
AUTHOR
Used for instances ofAuthorTreerepresenting an@authortag. -
CODE
Used for instances ofLiteralTreerepresenting an@codetag. -
COMMENT
Used for instances ofCommentTreerepresenting an HTML comment. -
DEPRECATED
Used for instances ofDeprecatedTreerepresenting an@deprecatedtag. -
DOC_COMMENT
Used for instances ofDocCommentTreerepresenting a complete doc comment. -
DOC_ROOT
Used for instances ofDocRootTreerepresenting an@docRoottag. -
DOC_TYPE
Used for instances ofDocTypeTreerepresenting an HTML DocType declaration.- Since:
- 10
-
END_ELEMENT
Used for instances ofEndElementTreerepresenting the end of an HTML element. -
ENTITY
Used for instances ofEntityTreerepresenting an HTML entity. -
ERRONEOUS
Used for instances ofErroneousTreerepresenting some invalid text. -
ESCAPE
Used for instances ofEscapeTreerepresenting some escaped documentation text.- Since:
- 21
-
EXCEPTION
Used for instances ofThrowsTreerepresenting an@exceptiontag. -
HIDDEN
Used for instances ofHiddenTreerepresenting an@hiddentag. -
IDENTIFIER
Used for instances ofIdentifierTreerepresenting an identifier. -
INDEX
Used for instances ofIndexTreerepresenting an@indextag.- Since:
- 9
-
INHERIT_DOC
Used for instances ofInheritDocTreerepresenting an@inheritDoctag. -
LINK
Used for instances ofLinkTreerepresenting an@linktag. -
LINK_PLAIN
Used for instances ofLinkTreerepresenting an@linkplaintag. -
LITERAL
Used for instances ofLiteralTreerepresenting an@literaltag. -
PARAM
Used for instances ofParamTreerepresenting an@paramtag. -
PROVIDES
Used for instances ofProvidesTreerepresenting an@providestag.- Since:
- 9
-
REFERENCE
Used for instances ofReferenceTreerepresenting a reference to an element in the Java programming language. -
RETURN
Used for instances ofReturnTreerepresenting an@returntag. -
SEE
Used for instances ofSeeTreerepresenting an@seetag. -
SERIAL
Used for instances ofSerialTreerepresenting an@serialtag. -
SERIAL_DATA
Used for instances ofSerialDataTreerepresenting an@serialDatatag. -
SERIAL_FIELD
Used for instances ofSerialFieldTreerepresenting an@serialFieldtag. -
SINCE
Used for instances ofSinceTreerepresenting an@sincetag. -
SNIPPET
Used for instances ofSnippetTreerepresenting an@snippettag.- Since:
- 18
-
SPEC
Used for instances ofSpecTreerepresenting an@spectag.- Since:
- 20
-
START_ELEMENT
Used for instances ofStartElementTreerepresenting the start of an HTML element. -
SYSTEM_PROPERTY
Used for instances ofSystemPropertyTreerepresenting an@systemPropertytag.- Since:
- 12
-
SUMMARY
Used for instances ofSummaryTreerepresenting an@summarytag.- Since:
- 10
-
TEXT
Used for instances ofTextTreerepresenting some plain documentation text. -
THROWS
Used for instances ofThrowsTreerepresenting an@throwstag. -
UNKNOWN_BLOCK_TAG
Used for instances ofUnknownBlockTagTreerepresenting an unknown block tag. -
UNKNOWN_INLINE_TAG
Used for instances ofUnknownInlineTagTreerepresenting an unknown inline tag. -
USES
Used for instances ofUsesTreerepresenting an@usestag.- Since:
- 9
-
VALUE
Used for instances ofValueTreerepresenting an@valuetag. -
VERSION
Used for instances ofVersionTreerepresenting an@versiontag. -
OTHER
An implementation-reserved node. This is not the node you are looking for.
-
-
Field Details
-
tagName
The name of the tag, if any, associated with this kind of node.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-