- 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 SummaryEnum 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 SummaryAll 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- 
ATTRIBUTEpublic static final DocTree.Kind ATTRIBUTE Used for instances ofAttributeTreerepresenting an HTML attribute.
 - 
AUTHORpublic static final DocTree.Kind AUTHOR Used for instances ofAuthorTreerepresenting an @author tag.
 - 
CODEpublic static final DocTree.Kind CODE Used for instances ofLiteralTreerepresenting an @code tag.
 - 
COMMENTpublic static final DocTree.Kind COMMENT Used for instances ofCommentTreerepresenting an HTML comment.
 - 
DEPRECATEDpublic static final DocTree.Kind DEPRECATED Used for instances ofDeprecatedTreerepresenting an @deprecated tag.
 - 
DOC_COMMENTpublic static final DocTree.Kind DOC_COMMENT Used for instances ofDocCommentTreerepresenting a complete doc comment.
 - 
DOC_ROOTpublic static final DocTree.Kind DOC_ROOT Used for instances ofDocRootTreerepresenting an @docRoot tag.
 - 
DOC_TYPEpublic static final DocTree.Kind DOC_TYPE Used for instances ofDocTypeTreerepresenting an HTML DocType declaration.
 - 
END_ELEMENTpublic static final DocTree.Kind END_ELEMENT Used for instances ofEndElementTreerepresenting the end of an HTML element.
 - 
ENTITYpublic static final DocTree.Kind ENTITY Used for instances ofEntityTreerepresenting an HTML entity.
 - 
ERRONEOUSpublic static final DocTree.Kind ERRONEOUS Used for instances ofErroneousTreerepresenting some invalid text.
 - 
EXCEPTIONpublic static final DocTree.Kind EXCEPTION Used for instances ofThrowsTreerepresenting an @exception tag.
 - 
HIDDENpublic static final DocTree.Kind HIDDEN Used for instances ofHiddenTreerepresenting an @hidden tag.
 - 
IDENTIFIERpublic static final DocTree.Kind IDENTIFIER Used for instances ofIdentifierTreerepresenting an identifier.
 - 
INDEXpublic static final DocTree.Kind INDEX Used for instances ofIndexTreerepresenting a search term.
 - 
INHERIT_DOCpublic static final DocTree.Kind INHERIT_DOC Used for instances ofInheritDocTreerepresenting an @inheritDoc tag.
 - 
LINKpublic static final DocTree.Kind LINK Used for instances ofLinkTreerepresenting an @link tag.
 - 
LINK_PLAINpublic static final DocTree.Kind LINK_PLAIN Used for instances ofLinkTreerepresenting an @linkplain tag.
 - 
LITERALpublic static final DocTree.Kind LITERAL Used for instances ofLiteralTreerepresenting an @literal tag.
 - 
PARAMpublic static final DocTree.Kind PARAM Used for instances ofParamTreerepresenting an @param tag.
 - 
PROVIDESpublic static final DocTree.Kind PROVIDES Used for instances ofProvidesTreerepresenting an @provides tag.
 - 
REFERENCEpublic static final DocTree.Kind REFERENCE Used for instances ofReferenceTreerepresenting a reference to a element in the Java programming language.
 - 
RETURNpublic static final DocTree.Kind RETURN Used for instances ofReturnTreerepresenting an @return tag.
 - 
SEEpublic static final DocTree.Kind SEE Used for instances ofSeeTreerepresenting an @see tag.
 - 
SERIALpublic static final DocTree.Kind SERIAL Used for instances ofSerialTreerepresenting an @serial tag.
 - 
SERIAL_DATApublic static final DocTree.Kind SERIAL_DATA Used for instances ofSerialDataTreerepresenting an @serialData tag.
 - 
SERIAL_FIELDpublic static final DocTree.Kind SERIAL_FIELD Used for instances ofSerialFieldTreerepresenting an @serialField tag.
 - 
SINCEpublic static final DocTree.Kind SINCE Used for instances ofSinceTreerepresenting an @since tag.
 - 
START_ELEMENTpublic static final DocTree.Kind START_ELEMENT Used for instances ofEndElementTreerepresenting the start of an HTML element.
 - 
SUMMARYpublic static final DocTree.Kind SUMMARY Used for instances ofSummaryTreerepresenting the summary of a comment description.
 - 
TEXTpublic static final DocTree.Kind TEXT Used for instances ofTextTreerepresenting some documentation text.
 - 
THROWSpublic static final DocTree.Kind THROWS Used for instances ofThrowsTreerepresenting an @throws tag.
 - 
UNKNOWN_BLOCK_TAGpublic static final DocTree.Kind UNKNOWN_BLOCK_TAG Used for instances ofUnknownBlockTagTreerepresenting an unknown block tag.
 - 
UNKNOWN_INLINE_TAGpublic static final DocTree.Kind UNKNOWN_INLINE_TAG Used for instances ofUnknownInlineTagTreerepresenting an unknown inline tag.
 - 
USESpublic static final DocTree.Kind USES Used for instances ofUsesTreerepresenting an @uses tag.
 - 
VALUEpublic static final DocTree.Kind VALUE Used for instances ofValueTreerepresenting an @value tag.
 - 
VERSIONpublic static final DocTree.Kind VERSION Used for instances ofVersionTreerepresenting an @version tag.
 - 
OTHERpublic static final DocTree.Kind OTHER An implementation-reserved node. This is the not the node you are looking for.
 
- 
 - 
Field Detail- 
tagNamepublic final String tagName The name of the tag, if any, associated with this kind of node.
 
- 
 - 
Method Detail- 
valuespublic 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
 
 - 
valueOfpublic 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 name
- NullPointerException- if the argument is null
 
 
- 
 
-