- 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>
Enumerates all kinds of trees.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ATTRIBUTEUsed for instances ofAttributeTreerepresenting an HTML attribute.AUTHORUsed for instances ofAuthorTreerepresenting an @author tag.CODEUsed for instances ofLiteralTreerepresenting an @code tag.COMMENTUsed for instances ofCommentTreerepresenting an HTML comment.DEPRECATEDUsed for instances ofDeprecatedTreerepresenting an @deprecated tag.DOC_COMMENTUsed for instances ofDocCommentTreerepresenting a complete doc comment.DOC_ROOTUsed for instances ofDocRootTreerepresenting an @docRoot tag.DOC_TYPEUsed for instances ofDocTypeTreerepresenting an HTML DocType declaration.END_ELEMENTUsed for instances ofEndElementTreerepresenting the end of an HTML element.ENTITYUsed for instances ofEntityTreerepresenting an HTML entity.ERRONEOUSUsed for instances ofErroneousTreerepresenting some invalid text.EXCEPTIONUsed for instances ofThrowsTreerepresenting an @exception tag.HIDDENUsed for instances ofHiddenTreerepresenting an @hidden tag.IDENTIFIERUsed for instances ofIdentifierTreerepresenting an identifier.INDEXUsed for instances ofIndexTreerepresenting a search term.INHERIT_DOCUsed for instances ofInheritDocTreerepresenting an @inheritDoc tag.LINKUsed for instances ofLinkTreerepresenting an @link tag.LINK_PLAINUsed for instances ofLinkTreerepresenting an @linkplain tag.LITERALUsed for instances ofLiteralTreerepresenting an @literal tag.OTHERAn implementation-reserved node.PARAMUsed for instances ofParamTreerepresenting an @param tag.PROVIDESUsed for instances ofProvidesTreerepresenting an @provides tag.REFERENCEUsed for instances ofReferenceTreerepresenting a reference to a element in the Java programming language.RETURNUsed for instances ofReturnTreerepresenting an @return tag.SEEUsed for instances ofSeeTreerepresenting an @see tag.SERIALUsed for instances ofSerialTreerepresenting an @serial tag.SERIAL_DATAUsed for instances ofSerialDataTreerepresenting an @serialData tag.SERIAL_FIELDUsed for instances ofSerialFieldTreerepresenting an @serialField tag.SINCEUsed for instances ofSinceTreerepresenting an @since tag.START_ELEMENTUsed for instances ofEndElementTreerepresenting the start of an HTML element.SUMMARYUsed for instances ofSummaryTreerepresenting the summary of a comment description.TEXTUsed for instances ofTextTreerepresenting some documentation text.THROWSUsed for instances ofThrowsTreerepresenting an @throws tag.UNKNOWN_BLOCK_TAGUsed for instances ofUnknownBlockTagTreerepresenting an unknown block tag.UNKNOWN_INLINE_TAGUsed for instances ofUnknownInlineTagTreerepresenting an unknown inline tag.USESUsed for instances ofUsesTreerepresenting an @uses tag.VALUEUsed for instances ofValueTreerepresenting an @value tag.VERSIONUsed for instances ofVersionTreerepresenting an @version tag.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static DocTree.KindvalueOf(String name)Returns the enum constant of this type with the specified name.static DocTree.Kind[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ATTRIBUTE
public static final DocTree.Kind ATTRIBUTE
Used for instances ofAttributeTreerepresenting an HTML attribute.
-
AUTHOR
public static final DocTree.Kind AUTHOR
Used for instances ofAuthorTreerepresenting an @author tag.
-
CODE
public static final DocTree.Kind CODE
Used for instances ofLiteralTreerepresenting an @code tag.
-
COMMENT
public static final DocTree.Kind COMMENT
Used for instances ofCommentTreerepresenting an HTML comment.
-
DEPRECATED
public static final DocTree.Kind DEPRECATED
Used for instances ofDeprecatedTreerepresenting an @deprecated tag.
-
DOC_COMMENT
public static final DocTree.Kind DOC_COMMENT
Used for instances ofDocCommentTreerepresenting a complete doc comment.
-
DOC_ROOT
public static final DocTree.Kind DOC_ROOT
Used for instances ofDocRootTreerepresenting an @docRoot tag.
-
DOC_TYPE
public static final DocTree.Kind DOC_TYPE
Used for instances ofDocTypeTreerepresenting an HTML DocType declaration.
-
END_ELEMENT
public static final DocTree.Kind END_ELEMENT
Used for instances ofEndElementTreerepresenting the end of an HTML element.
-
ENTITY
public static final DocTree.Kind ENTITY
Used for instances ofEntityTreerepresenting an HTML entity.
-
ERRONEOUS
public static final DocTree.Kind ERRONEOUS
Used for instances ofErroneousTreerepresenting some invalid text.
-
EXCEPTION
public static final DocTree.Kind EXCEPTION
Used for instances ofThrowsTreerepresenting an @exception tag.
-
HIDDEN
public static final DocTree.Kind HIDDEN
Used for instances ofHiddenTreerepresenting an @hidden tag.
-
IDENTIFIER
public static final DocTree.Kind IDENTIFIER
Used for instances ofIdentifierTreerepresenting an identifier.
-
INDEX
public static final DocTree.Kind INDEX
Used for instances ofIndexTreerepresenting a search term.
-
INHERIT_DOC
public static final DocTree.Kind INHERIT_DOC
Used for instances ofInheritDocTreerepresenting an @inheritDoc tag.
-
LINK
public static final DocTree.Kind LINK
Used for instances ofLinkTreerepresenting an @link tag.
-
LINK_PLAIN
public static final DocTree.Kind LINK_PLAIN
Used for instances ofLinkTreerepresenting an @linkplain tag.
-
LITERAL
public static final DocTree.Kind LITERAL
Used for instances ofLiteralTreerepresenting an @literal tag.
-
PARAM
public static final DocTree.Kind PARAM
Used for instances ofParamTreerepresenting an @param tag.
-
PROVIDES
public static final DocTree.Kind PROVIDES
Used for instances ofProvidesTreerepresenting an @provides tag.
-
REFERENCE
public static final DocTree.Kind REFERENCE
Used for instances ofReferenceTreerepresenting a reference to a element in the Java programming language.
-
RETURN
public static final DocTree.Kind RETURN
Used for instances ofReturnTreerepresenting an @return tag.
-
SEE
public static final DocTree.Kind SEE
Used for instances ofSeeTreerepresenting an @see tag.
-
SERIAL
public static final DocTree.Kind SERIAL
Used for instances ofSerialTreerepresenting an @serial tag.
-
SERIAL_DATA
public static final DocTree.Kind SERIAL_DATA
Used for instances ofSerialDataTreerepresenting an @serialData tag.
-
SERIAL_FIELD
public static final DocTree.Kind SERIAL_FIELD
Used for instances ofSerialFieldTreerepresenting an @serialField tag.
-
SINCE
public static final DocTree.Kind SINCE
Used for instances ofSinceTreerepresenting an @since tag.
-
START_ELEMENT
public static final DocTree.Kind START_ELEMENT
Used for instances ofEndElementTreerepresenting the start of an HTML element.
-
SUMMARY
public static final DocTree.Kind SUMMARY
Used for instances ofSummaryTreerepresenting the summary of a comment description.
-
TEXT
public static final DocTree.Kind TEXT
Used for instances ofTextTreerepresenting some documentation text.
-
THROWS
public static final DocTree.Kind THROWS
Used for instances ofThrowsTreerepresenting an @throws tag.
-
UNKNOWN_BLOCK_TAG
public static final DocTree.Kind UNKNOWN_BLOCK_TAG
Used for instances ofUnknownBlockTagTreerepresenting an unknown block tag.
-
UNKNOWN_INLINE_TAG
public static final DocTree.Kind UNKNOWN_INLINE_TAG
Used for instances ofUnknownInlineTagTreerepresenting an unknown inline tag.
-
USES
public static final DocTree.Kind USES
Used for instances ofUsesTreerepresenting an @uses tag.
-
VALUE
public static final DocTree.Kind VALUE
Used for instances ofValueTreerepresenting an @value tag.
-
VERSION
public static final DocTree.Kind VERSION
Used for instances ofVersionTreerepresenting an @version tag.
-
OTHER
public static final DocTree.Kind OTHER
An implementation-reserved node. This is the not the node you are looking for.
-
-
Field Detail
-
tagName
public final String tagName
The name of the tag, if any, associated with this kind of node.
-
-
Method Detail
-
values
public static DocTree.Kind[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (DocTree.Kind c : DocTree.Kind.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DocTree.Kind valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException- if the argument is null
-
-