Class JavadocCommentsTokenTypes
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intAt-sign@that starts a block tag.static final intValue assigned to an attribute.static final int@authorJavadoc block tag.static final int{@code}Javadoc inline tag.static final intColon symbol:.static final intComma symbol,.static final int@customBlockJavadoc block tag.static final intCustom or unrecognized inline tag.static final int@deprecatedblock tag.static final intDescription part of a Javadoc tag.static final intEquals sign=.static final int@exceptionJavadoc block tag.static final intKeywordextendsin type parameters.static final intField type reference.static final intFormat specifier inside Javadoc content.static final intGreater-than symbol>.static final intHash symbol#used in references.static final int@hiddenJavadoc block tag.static final intSingle HTML attribute.static final intList of HTML attributes.static final intFull HTML comment.static final intContent inside an HTML comment.static final intClosing part of an HTML comment.static final intOpening part of an HTML comment.static final intContent inside an HTML element.static final intGeneral HTML element.static final intEnd of an HTML tag.static final intStart of an HTML tag.static final intIdentifier token.static final int{@index}inline tag.static final intTerm used in{@index}tag.static final int{@inheritDoc}inline tag.static final intGeneral block tag (e.g.static final intRoot node of any Javadoc comment.static final intGeneral inline tag (e.g.static final intEnd of an inline tag}.static final intStart of an inline tag{.static final intLeading asterisk used to format Javadoc lines.static final int{@link}Javadoc inline tag.static final int{@linkplain}Javadoc inline tag.static final int{@literal}inline tag.static final intLeft parenthesis(.static final intLess-than symbol<.static final intMember reference (e.g. method or field).static final intNewline character in a Javadoc comment.static final int@paramJavadoc block tag.static final intParameter name reference.static final intParameter type reference.static final intList of parameter types in a reference.static final int@providesblock tag.static final intQuestion mark symbol?.static final intGeneral reference within Javadoc.static final int@returnJavadoc block tag.static final int{@return}inline tag.static final intRight parenthesis).static final int@seeJavadoc block tag.static final int@serialblock tag.static final int@serialDatablock tag.static final int@serialFieldJavadoc block tag.static final int@sinceJavadoc block tag.static final intSlash symbol/.static final intAttribute name in a@snippet.static final intSingle snippet attribute.static final intCollection of snippet attributes.static final intBody content of a@snippet.static final int@snippetinline tag.static final intString literal inside Javadoc.static final int{@summary}inline tag.static final intKeywordsuperin type parameters.static final int{@systemProperty}inline tag.static final intAttribute name inside an HTML tag.static final intClosing tag delimiter>.static final intHTML tag name.static final intOpening tag delimiter<.static final intSlash symbol inside a closing tag.static final intSelf-closing tag delimiter/>.static final intPlain text content within a Javadoc comment.static final int@throwsJavadoc block tag.static final intSingle type argument in generics.static final intType arguments in generics.static final intType name reference.static final int@usesJavadoc block tag.static final int{@value}Javadoc inline tag.static final int@versionJavadoc block tag.static final intVoid HTML element (self-closing). -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateEmpty private constructor of the current class. -
Method Summary
-
Field Details
-
JAVADOC_CONTENT
Root node of any Javadoc comment.Tree for example:
JAVADOC_CONTENT -> JAVADOC_CONTENT |--LEADING_ASTERISK -> * |--NEWLINE -> \n |--LEADING_ASTERISK -> * |--NEWLINE -> \n |--LEADING_ASTERISK -> * `--NEWLINE -> \n- See Also:
-
LEADING_ASTERISK
Leading asterisk used to format Javadoc lines.- See Also:
-
NEWLINE
Newline character in a Javadoc comment.- See Also:
-
TEXT
Plain text content within a Javadoc comment.- See Also:
-
JAVADOC_BLOCK_TAG
General block tag (e.g.@param,@return).- See Also:
-
AT_SIGN
At-sign@that starts a block tag.- See Also:
-
AUTHOR_BLOCK_TAG
@authorJavadoc block tag.Such Javadoc tag can have one child:
Example:
Tree:* @author name.JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--AUTHOR_BLOCK_TAG -> AUTHOR_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> author `--DESCRIPTION -> DESCRIPTION `--TEXT -> name.- See Also:
-
DEPRECATED_BLOCK_TAG
@deprecatedblock tag.Such Javadoc tag can have one child:
Example:
Tree:* @deprecated deprecated text.JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--DEPRECATED_BLOCK_TAG -> DEPRECATED_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> deprecated `--DESCRIPTION -> DESCRIPTION `--TEXT -> deprecated text.- See Also:
-
PARAM_BLOCK_TAG
@paramJavadoc block tag.Such Javadoc tag can have two children:
Example:
Tree:* @param value The parameter of method.JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--PARAM_BLOCK_TAG -> PARAM_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> param |--TEXT -> |--PARAMETER_NAME -> value `--DESCRIPTION -> DESCRIPTION `--TEXT -> The parameter of method.- See Also:
-
RETURN_BLOCK_TAG
@returnJavadoc block tag.Such Javadoc tag can have one child:
Example:
Tree:* @return The return of method.JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--RETURN_BLOCK_TAG -> RETURN_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> return `--DESCRIPTION -> DESCRIPTION `--TEXT -> The return of method.- See Also:
-
THROWS_BLOCK_TAG
@throwsJavadoc block tag.Such Javadoc tag can have two children:
IDENTIFIER- the exception classDESCRIPTION- description
Example:
Tree:* @throws IOException if an I/O error occursJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--THROWS_BLOCK_TAG -> THROWS_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> throws |--TEXT -> |--IDENTIFIER -> IOException `--DESCRIPTION -> DESCRIPTION `--TEXT -> if an I/O error occurs- See Also:
-
EXCEPTION_BLOCK_TAG
@exceptionJavadoc block tag.Such Javadoc tag can have two children:
Example:
Tree:* @exception FileNotFoundException when file is not found.JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--EXCEPTION_BLOCK_TAG -> EXCEPTION_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> exception |--TEXT -> |--IDENTIFIER -> FileNotFoundException `--DESCRIPTION -> DESCRIPTION `--TEXT -> when file is not found.- See Also:
-
SINCE_BLOCK_TAG
@sinceJavadoc block tag.Such Javadoc tag can have one child:
Example:
Tree:* @since 1.0JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--SINCE_BLOCK_TAG -> SINCE_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> since `--DESCRIPTION -> DESCRIPTION `--TEXT -> 1.0- See Also:
-
VERSION_BLOCK_TAG
@versionJavadoc block tag.This tag has only one argument —
TEXT:Example:
Tree:* @version valueJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--VERSION_BLOCK_TAG -> VERSION_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> version `--DESCRIPTION -> DESCRIPTION `--TEXT -> value- See Also:
-
SEE_BLOCK_TAG
@seeJavadoc block tag.Such Javadoc tag can have three children:
Example:
Tree:* @see SomeClass#FieldJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--SEE_BLOCK_TAG -> SEE_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> see |--TEXT -> `--REFERENCE -> REFERENCE |--IDENTIFIER -> SomeClass |--HASH -> # `--MEMBER_REFERENCE -> MEMBER_REFERENCE `--IDENTIFIER -> Field- See Also:
-
HIDDEN_BLOCK_TAG
@hiddenJavadoc block tag.Such Javadoc tag can have one child:
DESCRIPTION– optional description text
Example:
Tree:* @hidden valueJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--HIDDEN_BLOCK_TAG -> HIDDEN_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> hidden `--DESCRIPTION -> DESCRIPTION `--TEXT -> value- See Also:
-
USES_BLOCK_TAG
@usesJavadoc block tag.Such Javadoc tag can have one child:
IDENTIFIER– the referenced service type
Example:
Tree:* @uses com.example.app.MyServiceJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--USES_BLOCK_TAG -> USES_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> uses |--TEXT -> `--IDENTIFIER -> com.example.app.MyService- See Also:
-
PROVIDES_BLOCK_TAG
@providesblock tag.Such Javadoc tag can have two children:
Example:
Tree:* @provides com.example.MyService with com.example.MyServiceImplJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--PROVIDES_BLOCK_TAG -> PROVIDES_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> provides |--TEXT -> |--IDENTIFIER -> com.example.MyService `--DESCRIPTION -> DESCRIPTION `--TEXT -> with com.example.MyServiceImpl- See Also:
-
SERIAL_BLOCK_TAG
@serialblock tag.Such Javadoc tag can have one child:
DESCRIPTION– optional description text
Example:
Tree:* @serial includeJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--SERIAL_BLOCK_TAG -> SERIAL_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> serial `--DESCRIPTION -> DESCRIPTION `--TEXT -> include- See Also:
-
SERIAL_DATA_BLOCK_TAG
@serialDatablock tag.Such Javadoc tag can have one child:
DESCRIPTION– optional description text
Example:
Tree:* @serialData data description valueJAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--SERIAL_DATA_BLOCK_TAG -> SERIAL_DATA_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> serialData `--DESCRIPTION -> DESCRIPTION `--TEXT -> data description value- See Also:
-
SERIAL_FIELD_BLOCK_TAG
@serialFieldJavadoc block tag.Such Javadoc tag can have three children:
IDENTIFIER– field nameFIELD_TYPE– field typeDESCRIPTION– field description
Example:
Tree:* @serialField name String The person's full name.JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--SERIAL_FIELD_BLOCK_TAG -> SERIAL_FIELD_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> serialField |--TEXT -> |--IDENTIFIER -> name |--TEXT -> |--FIELD_TYPE -> String `--DESCRIPTION -> DESCRIPTION `--TEXT -> The person's full name.- See Also:
-
CUSTOM_BLOCK_TAG
@customBlockJavadoc block tag.This type represents any block tag that is not explicitly recognized by Checkstyle, such as a project-specific or malformed tag.
Example:
Tree:* @mycustomtag This is a custom block tag.JAVADOC_BLOCK_TAG -> JAVADOC_BLOCK_TAG `--CUSTOM_BLOCK_TAG -> CUSTOM_BLOCK_TAG |--AT_SIGN -> @ |--TAG_NAME -> customBlock |--TEXT -> `--DESCRIPTION -> DESCRIPTION `--TEXT -> This is a custom block tag.- See Also:
-
JAVADOC_INLINE_TAG
General inline tag (e.g.@link).- See Also:
-
JAVADOC_INLINE_TAG_START
Start of an inline tag{.- See Also:
-
JAVADOC_INLINE_TAG_END
End of an inline tag}.- See Also:
-
CODE_INLINE_TAG
{@code}Javadoc inline tag.Such Javadoc tag can have no children:
Example:
Tree:* {@code println("Hello");}`--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG |--CODE_INLINE_TAG -> CODE_INLINE_TAG |--JAVADOC_INLINE_TAG_START -> { @ |--TAG_NAME -> code |--TEXT -> println("Hello"); `--JAVADOC_INLINE_TAG_END -> }- See Also:
-
LINK_INLINE_TAG
{@link}Javadoc inline tag.Such Javadoc tag can have two children:
Example:
Tree:* {@link Math#max(int, int) label}--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG `--LINK_INLINE_TAG -> LINK_INLINE_TAG |--JAVADOC_INLINE_TAG_START -> { @ |--TAG_NAME -> link |--TEXT -> |--REFERENCE -> REFERENCE | |--IDENTIFIER -> Math | |--HASH -> # | `--MEMBER_REFERENCE -> MEMBER_REFERENCE | |--IDENTIFIER -> max | |--LPAREN -> ( | |--PARAMETER_TYPE_LIST -> PARAMETER_TYPE_LIST | | |--PARAMETER_TYPE -> int | | |--COMMA -> , | | |--TEXT -> | | `--PARAMETER_TYPE -> int | `--RPAREN -> ) |--DESCRIPTION -> DESCRIPTION | `--TEXT -> label `--JAVADOC_INLINE_TAG_END -> }- See Also:
-
LINKPLAIN_INLINE_TAG
{@linkplain}Javadoc inline tag.Such Javadoc tag can have two children:
Example:
Tree:* {@linkplain String#indexOf(int, int) label}--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG `--LINKPLAIN_INLINE_TAG -> LINKPLAIN_INLINE_TAG |--JAVADOC_INLINE_TAG_START -> { @ |--TAG_NAME -> linkplain |--TEXT -> |--REFERENCE -> REFERENCE | |--IDENTIFIER -> String | |--HASH -> # | `--MEMBER_REFERENCE -> MEMBER_REFERENCE | |--IDENTIFIER -> indexOf | |--LPAREN -> ( | |--PARAMETER_TYPE_LIST -> PARAMETER_TYPE_LIST | | |--PARAMETER_TYPE -> int | | |--COMMA -> , | | |--TEXT -> | | `--PARAMETER_TYPE -> int | `--RPAREN -> ) |--DESCRIPTION -> DESCRIPTION | `--TEXT -> label `--JAVADOC_INLINE_TAG_END -> }- See Also:
-
VALUE_INLINE_TAG
{@value}Javadoc inline tag.Such Javadoc tag can have one child:
Example:
Tree:* {@value Integer#MAX_VALUE}--JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG `--VALUE_INLINE_TAG -> VALUE_INLINE_TAG |--JAVADOC_INLINE_TAG_START -> { @ |--TAG_NAME -> value |--TEXT -> |--REFERENCE -> REFERENCE | |--IDENTIFIER -> Integer | |--HASH -> # | `--MEMBER_REFERENCE -> MEMBER_REFERENCE | `--IDENTIFIER -> MAX_VALUE |--TEXT -> `--JAVADOC_INLINE_TAG_END -> }- See Also:
-
SUMMARY_INLINE_TAG
{@summary}inline tag.- See Also:
-
INHERIT_DOC_INLINE_TAG
{@inheritDoc}inline tag.- See Also:
-
SYSTEM_PROPERTY_INLINE_TAG
{@systemProperty}inline tag.- See Also:
-
LITERAL_INLINE_TAG
{@literal}inline tag.- See Also:
-
RETURN_INLINE_TAG
{@return}inline tag.- See Also:
-
INDEX_INLINE_TAG
{@index}inline tag.- See Also:
-
SNIPPET_INLINE_TAG
@snippetinline tag.- See Also:
-
CUSTOM_INLINE_TAG
Custom or unrecognized inline tag.- See Also:
-
IDENTIFIER
Identifier token.- See Also:
-
HASH
Hash symbol#used in references.- See Also:
-
LPAREN
Left parenthesis(.- See Also:
-
RPAREN
Right parenthesis).- See Also:
-
COMMA
Comma symbol,.- See Also:
-
SLASH
Slash symbol/.- See Also:
-
QUESTION
Question mark symbol?.- See Also:
-
LT
Less-than symbol<.- See Also:
-
GT
Greater-than symbol>.- See Also:
-
EXTENDS
Keywordextendsin type parameters.- See Also:
-
SUPER
Keywordsuperin type parameters.- See Also:
-
PARAMETER_TYPE
Parameter type reference.- See Also:
-
REFERENCE
General reference within Javadoc.- See Also:
-
TYPE_NAME
Type name reference.- See Also:
-
MEMBER_REFERENCE
Member reference (e.g. method or field).- See Also:
-
PARAMETER_TYPE_LIST
List of parameter types in a reference.- See Also:
-
TYPE_ARGUMENTS
Type arguments in generics.- See Also:
-
TYPE_ARGUMENT
Single type argument in generics.- See Also:
-
DESCRIPTION
Description part of a Javadoc tag.- See Also:
-
FORMAT_SPECIFIER
Format specifier inside Javadoc content.- See Also:
-
SNIPPET_ATTR_NAME
Attribute name in a@snippet.- See Also:
-
EQUALS
Equals sign=.- See Also:
-
ATTRIBUTE_VALUE
Value assigned to an attribute.- See Also:
-
COLON
Colon symbol:.- See Also:
-
INDEX_TERM
Term used in{@index}tag.- See Also:
-
SNIPPET_ATTRIBUTE
Single snippet attribute.- See Also:
-
SNIPPET_ATTRIBUTES
Collection of snippet attributes.- See Also:
-
SNIPPET_BODY
Body content of a@snippet.- See Also:
-
FIELD_TYPE
Field type reference.- See Also:
-
PARAMETER_NAME
Parameter name reference.- See Also:
-
STRING_LITERAL
String literal inside Javadoc.- See Also:
-
HTML_ELEMENT
General HTML element.- See Also:
-
VOID_ELEMENT
Void HTML element (self-closing).- See Also:
-
HTML_CONTENT
Content inside an HTML element.- See Also:
-
HTML_ATTRIBUTE
Single HTML attribute.- See Also:
-
HTML_ATTRIBUTES
List of HTML attributes.- See Also:
-
HTML_TAG_START
Start of an HTML tag.- See Also:
-
HTML_TAG_END
End of an HTML tag.- See Also:
-
TAG_OPEN
Opening tag delimiter<.- See Also:
-
TAG_NAME
HTML tag name.- See Also:
-
TAG_CLOSE
Closing tag delimiter>.- See Also:
-
TAG_SLASH_CLOSE
Self-closing tag delimiter/>.- See Also:
-
TAG_SLASH
Slash symbol inside a closing tag.- See Also:
-
TAG_ATTR_NAME
Attribute name inside an HTML tag.- See Also:
-
HTML_COMMENT
Full HTML comment.- See Also:
-
HTML_COMMENT_START
Opening part of an HTML comment.- See Also:
-
HTML_COMMENT_END
Closing part of an HTML comment.- See Also:
-
HTML_COMMENT_CONTENT
Content inside an HTML comment.- See Also:
-
-
Constructor Details
-
JavadocCommentsTokenTypes
private JavadocCommentsTokenTypes()Empty private constructor of the current class.
-