Modifier and Type	Class and Description
public static enum	DocTree.Kind Enumerates all kinds of trees.

Modifier and Type	Method and Description
public < the result type of this operation R, the type of additional data D> R	Returns: the value returned from the visitor method accept(DocTreeVisitor<R, D> the visitor to be called visitor, D a parameter value to be passed to the visitor method data) Accept method used to implement the visitor pattern.
public DocTree.Kind	Returns: the kind of this tree getKind() Returns the kind of this tree.

accept	back to summary
public <R, D> R accept(DocTreeVisitor<R, D> visitor, D data) Accept method used to implement the visitor pattern. The visitor pattern is used to implement operations on trees. Parameters <R> the result type of this operation <D> the type of additional data visitor:DocTreeVisitor<R, D> the visitor to be called data:D a parameter value to be passed to the visitor method Returns:R the value returned from the visitor method

getKind	back to summary
public DocTree.Kind getKind() Returns the kind of this tree. Returns:DocTree.Kind the kind of this tree

public final Enum DocTree.Kind

Class Inheritance

java.lang.Object
java.lang.Enum
com.sun.source.doctree.DocTree.Kind

Enumerates all kinds of trees.

Field Summary

Modifier and Type	Field and Description
public static final DocTree.Kind	ATTRIBUTE Used for instances of `AttributeTree` representing an attribute in an HTML element or tag.
public static final DocTree.Kind	AUTHOR Used for instances of `AuthorTree` representing an `@author` tag.
public static final DocTree.Kind	CODE Used for instances of `LiteralTree` representing an `@code` tag.
public static final DocTree.Kind	COMMENT Used for instances of `CommentTree` representing an HTML comment.
public static final DocTree.Kind	DEPRECATED Used for instances of `DeprecatedTree` representing an `@deprecated` tag.
public static final DocTree.Kind	DOC_COMMENT Used for instances of `DocCommentTree` representing a complete doc comment.
public static final DocTree.Kind	DOC_ROOT Used for instances of `DocRootTree` representing an `@docRoot` tag.
public static final DocTree.Kind	DOC_TYPE Used for instances of `DocTypeTree` representing an HTML DocType declaration.
public static final DocTree.Kind	END_ELEMENT Used for instances of `EndElementTree` representing the end of an HTML element.
public static final DocTree.Kind	ENTITY Used for instances of `EntityTree` representing an HTML entity.
public static final DocTree.Kind	ERRONEOUS Used for instances of `ErroneousTree` representing some invalid text.
public static final DocTree.Kind	ESCAPE Used for instances of `EscapeTree` representing some escaped documentation text.
public static final DocTree.Kind	EXCEPTION Used for instances of `ThrowsTree` representing an `@exception` tag.
public static final DocTree.Kind	HIDDEN Used for instances of `HiddenTree` representing an `@hidden` tag.
public static final DocTree.Kind	IDENTIFIER Used for instances of `IdentifierTree` representing an identifier.
public static final DocTree.Kind	INDEX Used for instances of `IndexTree` representing an `@index` tag.
public static final DocTree.Kind	INHERIT_DOC Used for instances of `InheritDocTree` representing an `@inheritDoc` tag.
public static final DocTree.Kind	LINK Used for instances of `LinkTree` representing an `@link` tag.
public static final DocTree.Kind	LINK_PLAIN Used for instances of `LinkTree` representing an `@linkplain` tag.
public static final DocTree.Kind	LITERAL Used for instances of `LiteralTree` representing an `@literal` tag.
public static final DocTree.Kind	MARKDOWN Used for instances of `RawTextTree` representing a fragment of Markdown content.
public static final DocTree.Kind	OTHER An implementation-reserved node.
public static final DocTree.Kind	PARAM Used for instances of `ParamTree` representing an `@param` tag.
public static final DocTree.Kind	PROVIDES Used for instances of `ProvidesTree` representing an `@provides` tag.
public static final DocTree.Kind	REFERENCE Used for instances of `ReferenceTree` representing a reference to an element in the Java programming language.
public static final DocTree.Kind	RETURN Used for instances of `ReturnTree` representing an `@return` tag.
public static final DocTree.Kind	SEE Used for instances of `SeeTree` representing an `@see` tag.
public static final DocTree.Kind	SERIAL Used for instances of `SerialTree` representing an `@serial` tag.
public static final DocTree.Kind	SERIAL_DATA Used for instances of `SerialDataTree` representing an `@serialData` tag.
public static final DocTree.Kind	SERIAL_FIELD Used for instances of `SerialFieldTree` representing an `@serialField` tag.
public static final DocTree.Kind	SINCE Used for instances of `SinceTree` representing an `@since` tag.
public static final DocTree.Kind	SNIPPET Used for instances of `SnippetTree` representing an `@snippet` tag.
public static final DocTree.Kind	SPEC Used for instances of `SpecTree` representing an `@spec` tag.
public static final DocTree.Kind	START_ELEMENT Used for instances of `StartElementTree` representing the start of an HTML element.
public static final DocTree.Kind	SUMMARY Used for instances of `SummaryTree` representing an `@summary` tag.
public static final DocTree.Kind	SYSTEM_PROPERTY Used for instances of `SystemPropertyTree` representing an `@systemProperty` tag.
public final String	tagName The name of the tag, if any, associated with this kind of node.
public static final DocTree.Kind	TEXT Used for instances of `TextTree` representing some plain documentation text.
public static final DocTree.Kind	THROWS Used for instances of `ThrowsTree` representing an `@throws` tag.
public static final DocTree.Kind	UNKNOWN_BLOCK_TAG Used for instances of `UnknownBlockTagTree` representing an unknown block tag.
public static final DocTree.Kind	UNKNOWN_INLINE_TAG Used for instances of `UnknownInlineTagTree` representing an unknown inline tag.
public static final DocTree.Kind	USES Used for instances of `UsesTree` representing an `@uses` tag.
public static final DocTree.Kind	VALUE Used for instances of `ValueTree` representing an `@value` tag.
public static final DocTree.Kind	VERSION Used for instances of `VersionTree` representing an `@version` tag.

Constructor Summary

Access	Constructor and Description
private	Kind()
private	Kind(String tagName)

Method Summary

Modifier and Type	Method and Description
public static DocTree.Kind	valueOf(String name)
public static DocTree.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ATTRIBUTE	back to summary
public static final DocTree.Kind ATTRIBUTE Used for instances of `AttributeTree` representing an attribute in an HTML element or tag.

AUTHOR	back to summary
public static final DocTree.Kind AUTHOR Used for instances of `AuthorTree` representing an `@author` tag.

CODE	back to summary
public static final DocTree.Kind CODE Used for instances of `LiteralTree` representing an `@code` tag.

COMMENT	back to summary
public static final DocTree.Kind COMMENT Used for instances of `CommentTree` representing an HTML comment.

DEPRECATED	back to summary
public static final DocTree.Kind DEPRECATED Used for instances of `DeprecatedTree` representing an `@deprecated` tag.

DOC_COMMENT	back to summary
public static final DocTree.Kind DOC_COMMENT Used for instances of `DocCommentTree` representing a complete doc comment.

DOC_ROOT	back to summary
public static final DocTree.Kind DOC_ROOT Used for instances of `DocRootTree` representing an `@docRoot` tag.

DOC_TYPE back to summary

DOC_TYPE	back to summary
public static final DocTree.Kind DOC_TYPE Used for instances of `DocTypeTree` representing an HTML DocType declaration. Since 10

public static final DocTree.Kind DOC_TYPE

Used for instances of DocTypeTree representing an HTML DocType declaration.

Since: 10

END_ELEMENT	back to summary
public static final DocTree.Kind END_ELEMENT Used for instances of `EndElementTree` representing the end of an HTML element.

ENTITY	back to summary
public static final DocTree.Kind ENTITY Used for instances of `EntityTree` representing an HTML entity.

ERRONEOUS	back to summary
public static final DocTree.Kind ERRONEOUS Used for instances of `ErroneousTree` representing some invalid text.

ESCAPE back to summary

ESCAPE	back to summary
public static final DocTree.Kind ESCAPE Used for instances of `EscapeTree` representing some escaped documentation text. Since 21

public static final DocTree.Kind ESCAPE

Used for instances of EscapeTree representing some escaped documentation text.

Since: 21

EXCEPTION	back to summary
public static final DocTree.Kind EXCEPTION Used for instances of `ThrowsTree` representing an `@exception` tag.

HIDDEN	back to summary
public static final DocTree.Kind HIDDEN Used for instances of `HiddenTree` representing an `@hidden` tag.

IDENTIFIER	back to summary
public static final DocTree.Kind IDENTIFIER Used for instances of `IdentifierTree` representing an identifier.

INDEX back to summary

INDEX	back to summary
public static final DocTree.Kind INDEX Used for instances of `IndexTree` representing an `@index` tag. Since 9

public static final DocTree.Kind INDEX

Used for instances of IndexTree representing an @index tag.

Since: 9

INHERIT_DOC	back to summary
public static final DocTree.Kind INHERIT_DOC Used for instances of `InheritDocTree` representing an `@inheritDoc` tag.

LINK	back to summary
public static final DocTree.Kind LINK Used for instances of `LinkTree` representing an `@link` tag.

LINK_PLAIN	back to summary
public static final DocTree.Kind LINK_PLAIN Used for instances of `LinkTree` representing an `@linkplain` tag.

LITERAL	back to summary
public static final DocTree.Kind LITERAL Used for instances of `LiteralTree` representing an `@literal` tag.

MARKDOWN back to summary

MARKDOWN	back to summary
public static final DocTree.Kind MARKDOWN Used for instances of `RawTextTree` representing a fragment of Markdown content. Since 23

public static final DocTree.Kind MARKDOWN

Used for instances of RawTextTree representing a fragment of Markdown content.

Since: 23

OTHER	back to summary
public static final DocTree.Kind OTHER An implementation-reserved node. This is not the node you are looking for.

PARAM	back to summary
public static final DocTree.Kind PARAM Used for instances of `ParamTree` representing an `@param` tag.

PROVIDES back to summary

PROVIDES	back to summary
public static final DocTree.Kind PROVIDES Used for instances of `ProvidesTree` representing an `@provides` tag. Since 9

public static final DocTree.Kind PROVIDES

Used for instances of ProvidesTree representing an @provides tag.

Since: 9

REFERENCE	back to summary
public static final DocTree.Kind REFERENCE Used for instances of `ReferenceTree` representing a reference to an element in the Java programming language.

RETURN	back to summary
public static final DocTree.Kind RETURN Used for instances of `ReturnTree` representing an `@return` tag.

SEE	back to summary
public static final DocTree.Kind SEE Used for instances of `SeeTree` representing an `@see` tag.

SERIAL	back to summary
public static final DocTree.Kind SERIAL Used for instances of `SerialTree` representing an `@serial` tag.

SERIAL_DATA	back to summary
public static final DocTree.Kind SERIAL_DATA Used for instances of `SerialDataTree` representing an `@serialData` tag.

SERIAL_FIELD	back to summary
public static final DocTree.Kind SERIAL_FIELD Used for instances of `SerialFieldTree` representing an `@serialField` tag.

SINCE	back to summary
public static final DocTree.Kind SINCE Used for instances of `SinceTree` representing an `@since` tag.

SNIPPET back to summary

SNIPPET	back to summary
public static final DocTree.Kind SNIPPET Used for instances of `SnippetTree` representing an `@snippet` tag. Since 18

public static final DocTree.Kind SNIPPET

Used for instances of SnippetTree representing an @snippet tag.

Since: 18

SPEC back to summary

SPEC	back to summary
public static final DocTree.Kind SPEC Used for instances of `SpecTree` representing an `@spec` tag. Since 20

public static final DocTree.Kind SPEC

Used for instances of SpecTree representing an @spec tag.

Since: 20

START_ELEMENT	back to summary
public static final DocTree.Kind START_ELEMENT Used for instances of `StartElementTree` representing the start of an HTML element.

SUMMARY back to summary

SUMMARY	back to summary
public static final DocTree.Kind SUMMARY Used for instances of `SummaryTree` representing an `@summary` tag. Since 10

public static final DocTree.Kind SUMMARY

Used for instances of SummaryTree representing an @summary tag.

Since: 10

SYSTEM_PROPERTY back to summary

SYSTEM_PROPERTY	back to summary
public static final DocTree.Kind SYSTEM_PROPERTY Used for instances of `SystemPropertyTree` representing an `@systemProperty` tag. Since 12

public static final DocTree.Kind SYSTEM_PROPERTY

Used for instances of SystemPropertyTree representing an @systemProperty tag.

Since: 12

tagName	back to summary
public final String tagName The name of the tag, if any, associated with this kind of node.

TEXT	back to summary
public static final DocTree.Kind TEXT Used for instances of `TextTree` representing some plain documentation text.

THROWS	back to summary
public static final DocTree.Kind THROWS Used for instances of `ThrowsTree` representing an `@throws` tag.

UNKNOWN_BLOCK_TAG	back to summary
public static final DocTree.Kind UNKNOWN_BLOCK_TAG Used for instances of `UnknownBlockTagTree` representing an unknown block tag.

UNKNOWN_INLINE_TAG	back to summary
public static final DocTree.Kind UNKNOWN_INLINE_TAG Used for instances of `UnknownInlineTagTree` representing an unknown inline tag.

USES back to summary

USES	back to summary
public static final DocTree.Kind USES Used for instances of `UsesTree` representing an `@uses` tag. Since 9

public static final DocTree.Kind USES

Used for instances of UsesTree representing an @uses tag.

Since: 9

VALUE	back to summary
public static final DocTree.Kind VALUE Used for instances of `ValueTree` representing an `@value` tag.

VERSION	back to summary
public static final DocTree.Kind VERSION Used for instances of `VersionTree` representing an `@version` tag.

Constructor Detail

Kind	back to summary
private Kind()

Kind	back to summary
private Kind(String tagName)

Method Detail

valueOf	back to summary
public static DocTree.Kind valueOf(String name)

values	back to summary
public static DocTree.Kind[] values()

public Interface DocTree

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum DocTree.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail