Package com.puppycrawl.tools.checkstyle.api

Class JavadocTokenTypes

    • Field Detail

      • RETURN_LITERAL

        public static final int RETURN_LITERAL
        '@return' literal in @return Javadoc tag.

        Such Javadoc tag can have one argument - DESCRIPTION

        Example:

        @return true if file exists
        Tree: 
        
   |--JAVADOC_TAG[4x3] : [@return true if file exists]
       |--RETURN_LITERAL[4x3] : [@return]
       |--WS[4x10] : [ ]
       |--DESCRIPTION[4x11] : [true if file exists]
           |--TEXT[4x11] : [true if file exists]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • DEPRECATED_LITERAL

        public static final int DEPRECATED_LITERAL
        '@deprecated' literal in @deprecated Javadoc tag.

        Such Javadoc tag can have one argument - DESCRIPTION

        Example:

        @deprecated it is deprecated method
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@deprecated it is deprecated method]
   |--DEPRECATED_LITERAL[3x0] : [@deprecated]
   |--WS[3x11] : [ ]
   |--DESCRIPTION[3x12] : [it is deprecated method]
       |--TEXT[3x12] : [it is deprecated method]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • SINCE_LITERAL

        public static final int SINCE_LITERAL
        '@since' literal in @since Javadoc tag.

        Such Javadoc tag can have one argument - DESCRIPTION

        Example:

        @since 3.4 RELEASE
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@since 3.4 RELEASE]
       |--SINCE_LITERAL[3x0] : [@since]
       |--WS[3x6] : [ ]
       |--DESCRIPTION[3x7] : [3.4 RELEASE]
           |--TEXT[3x7] : [3.4 RELEASE]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • SERIAL_DATA_LITERAL

        public static final int SERIAL_DATA_LITERAL
        '@serialData' literal in @serialData Javadoc tag.

        Such Javadoc tag can have one argument - DESCRIPTION

        Example:

        @serialData two values of Integer type
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@serialData two values of Integer type ]
       |--SERIAL_DATA_LITERAL[3x0] : [@serialData]
       |--WS[3x11] : [ ]
       |--DESCRIPTION[3x12] : [two values of Integer type ]
           |--TEXT[3x12] : [two values of Integer type ]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • SERIAL_FIELD_LITERAL

        public static final int SERIAL_FIELD_LITERAL
        '@serialField' literal in @serialField Javadoc tag.

        Such Javadoc tag can have three arguments:

        1. FIELD_NAME
        2. FIELD_TYPE
        3. DESCRIPTION

        Example:

        @serialField counter Integer objects counter
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@serialField counter Integer objects counter]
       |--SERIAL_FIELD_LITERAL[3x0] : [@serialField]
       |--WS[3x12] : [ ]
       |--FIELD_NAME[3x13] : [counter]
       |--WS[3x20] : [ ]
       |--FIELD_TYPE[3x21] : [Integer]
       |--WS[3x28] : [ ]
       |--DESCRIPTION[3x29] : [objects counter]
           |--TEXT[3x29] : [objects counter]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • PARAM_LITERAL

        public static final int PARAM_LITERAL
        '@param' literal in @param Javadoc tag.

        Such Javadoc tag can have two arguments:

        1. PARAMETER_NAME
        2. DESCRIPTION

        Example:

        @param T The bar.
        Tree: 
        
   |--JAVADOC_TAG[4x3] : [@param T The bar.]
       |--PARAM_LITERAL[4x3] : [@param]
       |--WS[4x9] : [ ]
       |--PARAMETER_NAME[4x10] : [T]
       |--WS[4x11] : [ ]
       |--DESCRIPTION[4x12] : [The bar.]
           |--TEXT[4x12] : [The bar.]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • SEE_LITERAL

        public static final int SEE_LITERAL
        '@see' literal in @see Javadoc tag.

        Such Javadoc tag can have one argument - REFERENCE

        Example:

        @see org.apache.utils.Lists.Comparator#compare(Object)
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
       |--SEE_LITERAL[3x0] : [@see]
       |--WS[3x4] : [ ]
       |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
           |--PACKAGE_CLASS[3x5] : [org.apache.utils]
           |--DOT[3x21] : [.]
           |--CLASS[3x22] : [Lists]
           |--DOT[3x27] : [.]
           |--CLASS[3x28] : [Comparator]
           |--HASH[3x38] : [#]
           |--MEMBER[3x39] : [compare]
           |--PARAMETERS[3x46] : [(Object)]
               |--LEFT_BRACE[3x46] : [(]
               |--ARGUMENT[3x47] : [Object]
               |--RIGHT_BRACE[3x53] : [)]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • SERIAL_LITERAL

        public static final int SERIAL_LITERAL
        '@serial' literal in @serial Javadoc tag.

        Such Javadoc tag can have one argument - REFERENCE or LITERAL_EXCLUDE or LITERAL_INCLUDE

        Example:

        @serial include
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@serial include]
       |--SERIAL_LITERAL[3x0] : [@serial]
       |--WS[3x7] : [ ]
       |--LITERAL_INCLUDE[3x8] : [include]

        Example:

        @serial serialized company name
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@serial serialized company name]
       |--SERIAL_LITERAL[3x0] : [@serial]
       |--WS[3x7] : [ ]
       |--DESCRIPTION[3x8] : [serialized company name]
           |--TEXT[3x8] : [serialized company name]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • VERSION_LITERAL

        public static final int VERSION_LITERAL
        '@version' literal in @version Javadoc tag.

        Such Javadoc tag can have one argument - DESCRIPTION

        Example:

        @version 1.3
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@version 1.3]
       |--VERSION_LITERAL[3x0] : [@version]
       |--WS[3x8] : [ ]
       |--DESCRIPTION[3x9] : [1.3]
           |--TEXT[3x9] : [1.3]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • EXCEPTION_LITERAL

        public static final int EXCEPTION_LITERAL
        '@exception' literal in @exception Javadoc tag.

        Such Javadoc tag can have two argument - CLASS_NAME and DESCRIPTION

        Example:

        @exception SQLException if query is not correct
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@exception SQLException if query is not correct]
       |--EXCEPTION_LITERAL[3x0] : [@exception]
       |--WS[3x10] : [ ]
       |--CLASS_NAME[3x11] : [SQLException]
       |--WS[3x23] : [ ]
       |--DESCRIPTION[3x24] : [if query is not correct]
           |--TEXT[3x24] : [if query is not correct]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • THROWS_LITERAL

        public static final int THROWS_LITERAL
        '@throws' literal in @throws Javadoc tag.

        Such Javadoc tag can have two argument - CLASS_NAME and DESCRIPTION

        Example:

        @throws SQLException if query is not correct
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@throws SQLException if query is not correct]
       |--THROWS_LITERAL[3x0] : [@throws]
       |--WS[3x7] : [ ]
       |--CLASS_NAME[3x8] : [SQLException]
       |--WS[3x20] : [ ]
       |--DESCRIPTION[3x21] : [if query is not correct]
           |--TEXT[3x21] : [if query is not correct]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • AUTHOR_LITERAL

        public static final int AUTHOR_LITERAL
        '@author' literal in @author Javadoc tag.

        Such Javadoc tag can have one argument - DESCRIPTION

        Example:

        @author Baratali Izmailov
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@author Baratali Izmailov]
       |--AUTHOR_LITERAL[3x0] : [@author]
       |--WS[3x7] : [ ]
       |--DESCRIPTION[3x8] : [Baratali Izmailov]
           |--TEXT[3x8] : [Baratali Izmailov]
        See Also:
        Oracle Docs, JAVADOC_TAG, Constant Field Values

      • CUSTOM_NAME

        public static final int CUSTOM_NAME
        Name of custom Javadoc tag (or Javadoc inline tag).

        Such Javadoc tag can have one argument - DESCRIPTION

        Example:

        @myJavadocTag some magic
        Tree: 
        
   |--JAVADOC_TAG[3x0] : [@myJavadocTag some magic]
       |--CUSTOM_NAME[3x0] : [@myJavadocTag]
       |--WS[3x13] : [ ]
       |--DESCRIPTION[3x14] : [some magic]
           |--TEXT[3x14] : [some magic]
        See Also:
        Constant Field Values

      • JAVADOC_INLINE_TAG_START

        public static final int JAVADOC_INLINE_TAG_START
        First child of JAVADOC_INLINE_TAG that represents left curly brace '{'.

        Example:

        {@code Comparable<E>}
        Tree: 
          |--JAVADOC_INLINE_TAG[3x0] : [{@code Comparable<E>}]
         |--JAVADOC_INLINE_TAG_START[3x0] : [{]
         |--CODE_LITERAL[3x1] : [@code]
         |--WS[3x6] : [ ]
         |--TEXT[3x7] : [Comparable<E>]
         |--JAVADOC_INLINE_TAG_END[3x21] : [}]
        See Also:
        Constant Field Values

      • JAVADOC_INLINE_TAG_END

        public static final int JAVADOC_INLINE_TAG_END
        Last child of JAVADOC_INLINE_TAG that represents right curly brace '}'.

        Example:

        {@code Comparable<E>}
        Tree: 
          |--JAVADOC_INLINE_TAG[3x0] : [{@code Comparable<E>}]
         |--JAVADOC_INLINE_TAG_START[3x0] : [{]
         |--CODE_LITERAL[3x1] : [@code]
         |--WS[3x6] : [ ]
         |--TEXT[3x7] : [Comparable<E>]
         |--JAVADOC_INLINE_TAG_END[3x21] : [}]
        See Also:
        Constant Field Values

      • CODE_LITERAL

        public static final int CODE_LITERAL
        '@code' literal in {@code} Javadoc inline tag.

        Such Javadoc inline tag can have such child nodes:

        Example:

        {@code Comparable<E>}
        Tree: 
          |--JAVADOC_INLINE_TAG[3x0] : [{@code Comparable<E>}]
         |--JAVADOC_INLINE_TAG_START[3x0] : [{]
         |--CODE_LITERAL[3x1] : [@code]
         |--WS[3x6] : [ ]
         |--TEXT[3x7] : [Comparable<E>]
         |--JAVADOC_INLINE_TAG_END[3x21] : [}]
        See Also:
        Oracle Docs, JAVADOC_INLINE_TAG, Constant Field Values

      • DOC_ROOT_LITERAL

        public static final int DOC_ROOT_LITERAL
        '@docRoot' literal in {@docRoot} Javadoc inline tag.

        Such Javadoc inline tag does not have any arguments and can have such child nodes:

        Example:

        {@docRoot}
        Tree: 
           |--JAVADOC_INLINE_TAG[1x0] : [{@docRoot}]
            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
            |--DOC_ROOT_LITERAL[1x1] : [@docRoot]
            |--JAVADOC_INLINE_TAG_END[2x0] : [}]

        Example:

        {@docRoot
 }
        Tree: 
           |--JAVADOC_INLINE_TAG[1x0] : [{@docRoot \n}]
            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
            |--DOC_ROOT_LITERAL[1x1] : [@docRoot]
            |--WS[1x9] : [ ]
            |--NEWLINE[1x10] : [\n]
            |--JAVADOC_INLINE_TAG_END[2x0] : [}]
        See Also:
        Oracle Docs, JAVADOC_INLINE_TAG, Constant Field Values

      • LINK_LITERAL

        public static final int LINK_LITERAL
        '@link' literal in {@link} Javadoc inline tag.

        Such Javadoc inline tag can have one argument - REFERENCE

        Example:

        {@link org.apache.utils.Lists.Comparator#compare(Object)}

        Tree:

          |--JAVADOC_INLINE_TAG[1x0] :
               [{@link org.apache.utils.Lists.Comparator#compare(Object)}]
        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
        |--LINK_LITERAL[1x1] : [@link]
        |--WS[1x6] : [ ]
        |--REFERENCE[1x7] : [org.apache.utils.Lists.Comparator#compare(Object)]
            |--PACKAGE_CLASS[1x7] : [org.apache.utils]
            |--DOT[1x23] : [.]
            |--CLASS[1x24] : [Lists]
            |--DOT[1x29] : [.]
            |--CLASS[1x30] : [Comparator]
            |--HASH[1x40] : [#]
            |--MEMBER[1x41] : [compare]
            |--PARAMETERS[1x48] : [(Object)]
                |--LEFT_BRACE[1x48] : [(]
                |--ARGUMENT[1x49] : [Object]
                |--RIGHT_BRACE[1x55] : [)]
        |--JAVADOC_INLINE_TAG_END[1x56] : [}]
        See Also:
        Oracle Docs, JAVADOC_INLINE_TAG, Constant Field Values

      • INHERIT_DOC_LITERAL

        public static final int INHERIT_DOC_LITERAL
        '@inheritDoc' literal in {@inheritDoc} Javadoc inline tag.

        Such Javadoc inline tag does not have any arguments and can have such child nodes:

        Example:

        {@inheritDoc}
        Tree: 
           |--JAVADOC_INLINE_TAG[1x0] : [{@inheritDoc}]
            |--JAVADOC_INLINE_TAG_START[1x0] : [{]
            |--INHERIT_DOC_LITERAL[1x1] : [@inheritDoc]
            |--JAVADOC_INLINE_TAG_END[1x12] : [}]
        See Also:
        Oracle Docs, JAVADOC_INLINE_TAG, Constant Field Values

      • LINKPLAIN_LITERAL

        public static final int LINKPLAIN_LITERAL
        '@linkplain' literal in {@linkplain} Javadoc inline tag.

        Such Javadoc inline tag can have one argument - REFERENCE

        Example:

        {@linkplain org.apache.utils.Lists.Comparator#compare(Object) compare}
        Tree: 
          |--JAVADOC_INLINE_TAG[1x0] :
               [{@linkplain org.apache.utils.Lists.Comparator#compare(Object) compare}]
        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
        |--LINKPLAIN_LITERAL[1x1] : [@linkplain]
        |--WS[1x11] : [ ]
        |--REFERENCE[1x12] : [org.apache.utils.Lists.Comparator#compare(Object)]
            |--PACKAGE_CLASS[1x12] : [org.apache.utils]
            |--DOT[1x28] : [.]
            |--CLASS[1x29] : [Lists]
            |--DOT[1x34] : [.]
            |--CLASS[1x35] : [Comparator]
            |--HASH[1x45] : [#]
            |--MEMBER[1x46] : [compare]
            |--PARAMETERS[1x53] : [(Object)]
                |--LEFT_BRACE[1x53] : [(]
                |--ARGUMENT[1x54] : [Object]
                |--RIGHT_BRACE[1x60] : [)]
        |--DESCRIPTION[1x61] : [ compare]
            |--TEXT[1x61] : [ compare]
        |--JAVADOC_INLINE_TAG_END[1x69] : [}]
        See Also:
        Oracle Docs, JAVADOC_INLINE_TAG, Constant Field Values

      • LITERAL_LITERAL

        public static final int LITERAL_LITERAL
        '@literal' literal in {@literal} Javadoc inline tag.

        Such Javadoc inline tag can have such child nodes:

        Example:

        {@literal #compare(Object)}
        Tree: 
          |--JAVADOC_INLINE_TAG[1x0] : [{@literal #compare(Object)}]
        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
        |--LITERAL_LITERAL[1x1] : [@literal]
        |--WS[1x9] : [ ]
        |--TEXT[1x10] : [#compare(Object)]
        |--JAVADOC_INLINE_TAG_END[1x27] : [}]
        See Also:
        Oracle Docs, JAVADOC_INLINE_TAG, Constant Field Values

      • VALUE_LITERAL

        public static final int VALUE_LITERAL
        '@value' literal in {@value} Javadoc inline tag.

        Such Javadoc inline tag has one argument REFERENCE and can have such child nodes:

        Example:

        {@value Integer#MAX_VALUE}
        Tree: 
          |--JAVADOC_INLINE_TAG[1x0] : [@value Integer#MAX_VALUE}]
        |--JAVADOC_INLINE_TAG_START[1x0] : [{]
        |--VALUE_LITERAL[1x1] : [@value]
        |--WS[1x7] : [ ]
        |--REFERENCE[1x8] : [Integer#MAX_VALUE]
            |--CLASS[1x8] : [Integer]
            |--HASH[1x15] : [#]
            |--MEMBER[1x16] : [MAX_VALUE]
        |--JAVADOC_INLINE_TAG_END[1x25] : [}]
        See Also:
        Oracle Docs, JAVADOC_INLINE_TAG, Constant Field Values

      • PACKAGE_CLASS

        public static final int PACKAGE_CLASS
        PACKAGE_CLASS represents the package or class which has been referenced in the `@see`, `@link`, `@linkplain` or `@value` javadoc tags. In the javadoc tree it shall be a child of REFERENCE.
        IMPORTANT: Constructs like package.Class.NestedClassAtDepth1.NestedClassAtDepth2#member are recognized by the javadoc tool from oracle, and no assumptions like, package names wouldn't consist of uppercase characters or class names begin with an uppercase character, are made. Also, the reference in a javadoc tag can consist just a package name or a simple class name or even a full class name. Thus, PACKAGE_CLASS can represent a package name or a simple class name or a full class name i.e checkstyle doesn't resolve references at present.

        Example:

        @see org.apache.utils.Lists.Comparator#compare(Object)
        Tree: 
         |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
        |--SEE_LITERAL[3x0] : [@see]
        |--WS[3x4] : [ ]
        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
            |--DOT[3x21] : [.]
            |--CLASS[3x22] : [Lists]
            |--DOT[3x27] : [.]
            |--CLASS[3x28] : [Comparator]
            |--HASH[3x38] : [#]
            |--MEMBER[3x39] : [compare]
            |--PARAMETERS[3x46] : [(Object)]
                |--LEFT_BRACE[3x46] : [(]
                |--ARGUMENT[3x47] : [Object]
                |--RIGHT_BRACE[3x53] : [)]
        See Also:
        Constant Field Values

      • HASH

        public static final int HASH
        Hash character in REFERENCE. Hash character is used before specifying a class member.

        Example:

        @see org.apache.utils.Lists.Comparator#compare(Object)
        Tree: 
         |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
        |--SEE_LITERAL[3x0] : [@see]
        |--WS[3x4] : [ ]
        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
            |--DOT[3x21] : [.]
            |--CLASS[3x22] : [Lists]
            |--DOT[3x27] : [.]
            |--CLASS[3x28] : [Comparator]
            |--HASH[3x38] : [#]
            |--MEMBER[3x39] : [compare]
            |--PARAMETERS[3x46] : [(Object)]
                |--LEFT_BRACE[3x46] : [(]
                |--ARGUMENT[3x47] : [Object]
                |--RIGHT_BRACE[3x53] : [)]
        See Also:
        Constant Field Values

      • MEMBER

        public static final int MEMBER
        A class member in REFERENCE. Class member is specified after HASH symbol.

        Example:

        @see org.apache.utils.Lists.Comparator#compare(Object)
        Tree: 
         |--JAVADOC_TAG[3x0] : [@see org.apache.utils.Lists.Comparator#compare(Object)]
        |--SEE_LITERAL[3x0] : [@see]
        |--WS[3x4] : [ ]
        |--REFERENCE[3x5] : [org.apache.utils.Lists.Comparator#compare(Object)]
            |--PACKAGE_CLASS[3x5] : [org.apache.utils]
            |--DOT[3x21] : [.]
            |--CLASS[3x22] : [Lists]
            |--DOT[3x27] : [.]
            |--CLASS[3x28] : [Comparator]
            |--HASH[3x38] : [#]
            |--MEMBER[3x39] : [compare]
            |--PARAMETERS[3x46] : [(Object)]
                |--LEFT_BRACE[3x46] : [(]
                |--ARGUMENT[3x47] : [Object]
                |--RIGHT_BRACE[3x53] : [)]
        See Also:
        Constant Field Values

      • LEFT_BRACE

        public static final int LEFT_BRACE
        Left brace in PARAMETERS part of REFERENCE.

        Example:

        @see #method(Processor, String)
        Tree: 
         |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
        |--SEE_LITERAL[1x0] : [@see]
        |--WS[1x4] : [ ]
        |--REFERENCE[1x5] : [#method(Processor, String)]
            |--HASH[1x5] : [#]
            |--MEMBER[1x6] : [method]
            |--PARAMETERS[1x12] : [(Processor, String)]
                |--LEFT_BRACE[1x12] : [(]
                |--ARGUMENT[1x13] : [Processor]
                |--COMMA[1x22] : [,]
                |--WS[1x23] : [ ]
                |--ARGUMENT[1x24] : [String]
                |--RIGHT_BRACE[1x30] : [)]
        See Also:
        Constant Field Values

      • RIGHT_BRACE

        public static final int RIGHT_BRACE
        Right brace in PARAMETERS part of REFERENCE.

        Example:

        @see #method(Processor, String)
        Tree: 
         |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
        |--SEE_LITERAL[1x0] : [@see]
        |--WS[1x4] : [ ]
        |--REFERENCE[1x5] : [#method(Processor, String)]
            |--HASH[1x5] : [#]
            |--MEMBER[1x6] : [method]
            |--PARAMETERS[1x12] : [(Processor, String)]
                |--LEFT_BRACE[1x12] : [(]
                |--ARGUMENT[1x13] : [Processor]
                |--COMMA[1x22] : [,]
                |--WS[1x23] : [ ]
                |--ARGUMENT[1x24] : [String]
                |--RIGHT_BRACE[1x30] : [)]
        See Also:
        Constant Field Values

      • ARGUMENT

        public static final int ARGUMENT
        Argument definition in PARAMETERS part of REFERENCE.

        Example:

        @see #method(Processor, String)
        Tree: 
         |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
        |--SEE_LITERAL[1x0] : [@see]
        |--WS[1x4] : [ ]
        |--REFERENCE[1x5] : [#method(Processor, String)]
            |--HASH[1x5] : [#]
            |--MEMBER[1x6] : [method]
            |--PARAMETERS[1x12] : [(Processor, String)]
                |--LEFT_BRACE[1x12] : [(]
                |--ARGUMENT[1x13] : [Processor]
                |--COMMA[1x22] : [,]
                |--WS[1x23] : [ ]
                |--ARGUMENT[1x24] : [String]
                |--RIGHT_BRACE[1x30] : [)]
        See Also:
        Constant Field Values

      • COMMA

        public static final int COMMA
        Comma separator between parameters in PARAMETERS part of REFERENCE.

        Example:

        @see #method(Processor, String)
        Tree: 
         |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
        |--SEE_LITERAL[1x0] : [@see]
        |--WS[1x4] : [ ]
        |--REFERENCE[1x5] : [#method(Processor, String)]
            |--HASH[1x5] : [#]
            |--MEMBER[1x6] : [method]
            |--PARAMETERS[1x12] : [(Processor, String)]
                |--LEFT_BRACE[1x12] : [(]
                |--ARGUMENT[1x13] : [Processor]
                |--COMMA[1x22] : [,]
                |--WS[1x23] : [ ]
                |--ARGUMENT[1x24] : [String]
                |--RIGHT_BRACE[1x30] : [)]
        See Also:
        PARAMETERS, REFERENCE, ARGUMENT, Constant Field Values

      • STRING

        public static final int STRING
        Quoted text. One of possible @see tag arguments.

        Example:

        @see "Spring Framework"
        Tree: 
         |--JAVADOC_TAG[1x0] : [@see "Spring Framework"]
        |--SEE_LITERAL[1x0] : [@see]
        |--WS[1x4] : [ ]
        |--STRING[1x5] : ["Spring Framework"]
        See Also:
        SEE_LITERAL, Constant Field Values

      • CLASS_NAME

        public static final int CLASS_NAME
        Exception class name. First argument in @throws and @exception Javadoc tags.

        Example:

        @throws IOException connection problems
        Tree: 
         |--JAVADOC_TAG[1x0] : [@throws IOException connection problems]
        |--THROWS_LITERAL[1x0] : [@throws]
        |--WS[1x7] : [ ]
        |--CLASS_NAME[1x8] : [IOException]
        |--WS[1x19] : [ ]
        |--DESCRIPTION[1x20] : [connection problems]
            |--TEXT[1x20] : [connection problems]
        See Also:
        EXCEPTION_LITERAL, THROWS_LITERAL, Constant Field Values

      • PARAMETER_NAME

        public static final int PARAMETER_NAME
        First argument in @param Javadoc tag.

        Example:

        @param T The bar.
        Tree: 
         |--JAVADOC_TAG[4x3] : [@param T The bar.]
        |--PARAM_LITERAL[4x3] : [@param]
        |--WS[4x9] : [ ]
        |--PARAMETER_NAME[4x10] : [T]
        |--WS[4x11] : [ ]
        |--DESCRIPTION[4x12] : [The bar.]
            |--TEXT[4x12] : [The bar.]
        See Also:
        Oracle Docs, PARAM_LITERAL, Constant Field Values

      • LITERAL_EXCLUDE

        public static final int LITERAL_EXCLUDE
        'exclude' literal. One of three possible @serial tag arguments.

        Example:

        @serial exclude
        Tree: 
         |--JAVADOC_TAG[1x0] : [@serial exclude]
        |--SERIAL_LITERAL[1x0] : [@serial]
        |--WS[1x7] : [ ]
        |--LITERAL_EXCLUDE[1x8] : [exclude]
        See Also:
        Oracle Docs, SERIAL_LITERAL, Constant Field Values

      • LITERAL_INCLUDE

        public static final int LITERAL_INCLUDE
        'include' literal. One of three possible @serial tag arguments.

        Example:

        @serial include
        Tree: 
         |--JAVADOC_TAG[1x0] : [@serial include]
        |--SERIAL_LITERAL[1x0] : [@serial]
        |--WS[1x7] : [ ]
        |--LITERAL_INCLUDE[1x8] : [include]
        See Also:
        Oracle Docs, SERIAL_LITERAL, Constant Field Values

      • FIELD_NAME

        public static final int FIELD_NAME
        Field name. First argument of @serialField Javadoc tag.

        Example:

        @serialField counter Integer objects counter
        Tree: 
         |--JAVADOC_TAG[3x0] : [@serialField counter Integer objects counter]
        |--SERIAL_FIELD_LITERAL[3x0] : [@serialField]
        |--WS[3x12] : [ ]
        |--FIELD_NAME[3x13] : [counter]
        |--WS[3x20] : [ ]
        |--FIELD_TYPE[3x21] : [Integer]
        |--WS[3x28] : [ ]
        |--DESCRIPTION[3x29] : [objects counter]
            |--TEXT[3x29] : [objects counter]
        See Also:
        Oracle Docs, SERIAL_FIELD_LITERAL, Constant Field Values

      • FIELD_TYPE

        public static final int FIELD_TYPE
        Field type. Second argument of @serialField Javadoc tag.

        Example:

        @serialField counter Integer objects counter
        Tree: 
         |--JAVADOC_TAG[3x0] : [@serialField counter Integer objects counter]
        |--SERIAL_FIELD_LITERAL[3x0] : [@serialField]
        |--WS[3x12] : [ ]
        |--FIELD_NAME[3x13] : [counter]
        |--WS[3x20] : [ ]
        |--FIELD_TYPE[3x21] : [Integer]
        |--WS[3x28] : [ ]
        |--DESCRIPTION[3x29] : [objects counter]
            |--TEXT[3x29] : [objects counter]
        See Also:
        Oracle Docs, SERIAL_FIELD_LITERAL, Constant Field Values

      • HTML_TAG_NAME

        public static final int HTML_TAG_NAME
        Identifier inside HTML tag: tag name or attribute name.
        See Also:
        Constant Field Values

      • SLASH_END

        public static final int SLASH_END
        Slash close html tag component: '/>'.
        See Also:
        Constant Field Values

      • ATTR_VALUE

        public static final int ATTR_VALUE
        Attribute value html tag component.
        See Also:
        Constant Field Values

      • P_HTML_TAG_NAME

        public static final int P_HTML_TAG_NAME
        Paragraph tag name.
        See Also:
        Constant Field Values

      • LI_HTML_TAG_NAME

        public static final int LI_HTML_TAG_NAME
        List item tag name.
        See Also:
        Constant Field Values

      • TR_HTML_TAG_NAME

        public static final int TR_HTML_TAG_NAME
        Table row tag name.
        See Also:
        Constant Field Values

      • TD_HTML_TAG_NAME

        public static final int TD_HTML_TAG_NAME
        Table cell tag name.
        See Also:
        Constant Field Values

      • TH_HTML_TAG_NAME

        public static final int TH_HTML_TAG_NAME
        Table header cell tag name.
        See Also:
        Constant Field Values

      • BODY_HTML_TAG_NAME

        public static final int BODY_HTML_TAG_NAME
        Body tag name.
        See Also:
        Constant Field Values

      • COLGROUP_HTML_TAG_NAME

        public static final int COLGROUP_HTML_TAG_NAME
        Colgroup tag name.
        See Also:
        Constant Field Values

      • DD_HTML_TAG_NAME

        public static final int DD_HTML_TAG_NAME
        Description of a term tag name.
        See Also:
        Constant Field Values

      • DT_HTML_TAG_NAME

        public static final int DT_HTML_TAG_NAME
        Description term tag name.
        See Also:
        Constant Field Values

      • HEAD_HTML_TAG_NAME

        public static final int HEAD_HTML_TAG_NAME
        Head tag name.
        See Also:
        Constant Field Values

      • HTML_HTML_TAG_NAME

        public static final int HTML_HTML_TAG_NAME
        Html tag name.
        See Also:
        Constant Field Values

      • OPTION_HTML_TAG_NAME

        public static final int OPTION_HTML_TAG_NAME
        Option tag name.
        See Also:
        Constant Field Values

      • TBODY_HTML_TAG_NAME

        public static final int TBODY_HTML_TAG_NAME
        Table body tag name.
        See Also:
        Constant Field Values

      • TFOOT_HTML_TAG_NAME

        public static final int TFOOT_HTML_TAG_NAME
        Table foot tag name.
        See Also:
        Constant Field Values

      • THEAD_HTML_TAG_NAME

        public static final int THEAD_HTML_TAG_NAME
        Table head tag name.
        See Also:
        Constant Field Values

      • OPTGROUP_HTML_TAG_NAME

        public static final int OPTGROUP_HTML_TAG_NAME
        `optgroup` tag name.
        See Also:
        Constant Field Values

      • RB_HTML_TAG_NAME

        public static final int RB_HTML_TAG_NAME
        `rb` tag name.
        See Also:
        Constant Field Values

      • RT_HTML_TAG_NAME

        public static final int RT_HTML_TAG_NAME
        `rt` tag name.
        See Also:
        Constant Field Values

      • RTC_HTML_TAG_NAME

        public static final int RTC_HTML_TAG_NAME
        `rtc` tag name.
        See Also:
        Constant Field Values

      • RP_HTML_TAG_NAME

        public static final int RP_HTML_TAG_NAME
        `rp` tag name.
        See Also:
        Constant Field Values

      • AREA_HTML_TAG_NAME

        public static final int AREA_HTML_TAG_NAME
        Area tag name.
        See Also:
        Constant Field Values

      • BASE_HTML_TAG_NAME

        public static final int BASE_HTML_TAG_NAME
        Base tag name.
        See Also:
        Constant Field Values

      • BASEFONT_HTML_TAG_NAME

        public static final int BASEFONT_HTML_TAG_NAME
        Basefont tag name.
        See Also:
        Constant Field Values

      • BR_HTML_TAG_NAME

        public static final int BR_HTML_TAG_NAME
        Br tag name.
        See Also:
        Constant Field Values

      • COL_HTML_TAG_NAME

        public static final int COL_HTML_TAG_NAME
        Col tag name.
        See Also:
        Constant Field Values

      • FRAME_HTML_TAG_NAME

        public static final int FRAME_HTML_TAG_NAME
        Frame tag name.
        See Also:
        Constant Field Values

      • HR_HTML_TAG_NAME

        public static final int HR_HTML_TAG_NAME
        Hr tag name.
        See Also:
        Constant Field Values

      • IMG_HTML_TAG_NAME

        public static final int IMG_HTML_TAG_NAME
        Img tag name.
        See Also:
        Constant Field Values

      • INPUT_HTML_TAG_NAME

        public static final int INPUT_HTML_TAG_NAME
        Input tag name.
        See Also:
        Constant Field Values

      • ISINDEX_HTML_TAG_NAME

        public static final int ISINDEX_HTML_TAG_NAME
        Isindex tag name.
        See Also:
        Constant Field Values

      • LINK_HTML_TAG_NAME

        public static final int LINK_HTML_TAG_NAME
        Link tag name.
        See Also:
        Constant Field Values

      • META_HTML_TAG_NAME

        public static final int META_HTML_TAG_NAME
        Meta tag name.
        See Also:
        Constant Field Values

      • PARAM_HTML_TAG_NAME

        public static final int PARAM_HTML_TAG_NAME
        Param tag name.
        See Also:
        Constant Field Values

      • EMBED_HTML_TAG_NAME

        public static final int EMBED_HTML_TAG_NAME
        "embed" tag name.
        See Also:
        Constant Field Values

      • KEYGEN_HTML_TAG_NAME

        public static final int KEYGEN_HTML_TAG_NAME
        "keygen" tag name.
        See Also:
        Constant Field Values

      • SOURCE_HTML_TAG_NAME

        public static final int SOURCE_HTML_TAG_NAME
        "source" tag name.
        See Also:
        Constant Field Values

      • TRACK_HTML_TAG_NAME

        public static final int TRACK_HTML_TAG_NAME
        "track" tag name.
        See Also:
        Constant Field Values

      • WBR_HTML_TAG_NAME

        public static final int WBR_HTML_TAG_NAME
        "wbr" tag name.
        See Also:
        Constant Field Values

      • HTML_COMMENT_START

        public static final int HTML_COMMENT_START
        HTML comment start symbol '<!--'.
        See Also:
        Constant Field Values

      • HTML_COMMENT_END

        public static final int HTML_COMMENT_END
        HTML comment end symbol '-->'.
        See Also:
        Constant Field Values

      • LEADING_ASTERISK

        public static final int LEADING_ASTERISK
        Leading asterisk.
        See Also:
        Constant Field Values

      • EOF

        public static final int EOF
        End Of File symbol. Copied from Recognizer.EOF to avoid ANTLR dependency in API.
        See Also:
        Constant Field Values

      • JAVADOC

        public static final int JAVADOC
        Root node of any Javadoc comment. Last child is always EOF.

        Tree for example:

        
 JAVADOC[3x0]
   |--NEWLINE[3x0] : [\n]
   |--LEADING_ASTERISK[4x0] : [ *]
   |--WS[4x2] : [ ]
   |--JAVADOC_TAG[4x3] : [@param T The bar.\n ]
       |--PARAM_LITERAL[4x3] : [@param]
       |--WS[4x9] : [ ]
       |--PARAMETER_NAME[4x10] : [T]
       |--WS[4x11] : [ ]
       |--DESCRIPTION[4x12] : [The bar.\n ]
           |--TEXT[4x12] : [The bar.]
           |--NEWLINE[4x20] : [\n]
           |--TEXT[5x0] : [ ]
   |--EOF[5x1] : [<EOF>]
        See Also:
        Constant Field Values

      • PARAMETERS

        public static final int PARAMETERS
        Parameters part in REFERENCE. It is used to specify parameters for method. Always contains LEFT_BRACE as first child and RIGHT_BRACE as last child. Each parameter is represented by ARGUMENT node. Arguments in braces are separated by COMMA (and optional WS).

        Example:

        @see #method(Processor, String)
        Tree: 
         |--JAVADOC_TAG[1x0] : [@see #method(Processor, String)]
        |--SEE_LITERAL[1x0] : [@see]
        |--WS[1x4] : [ ]
        |--REFERENCE[1x5] : [#method(Processor, String)]
            |--HASH[1x5] : [#]
            |--MEMBER[1x6] : [method]
            |--PARAMETERS[1x12] : [(Processor, String)]
                |--LEFT_BRACE[1x12] : [(]
                |--ARGUMENT[1x13] : [Processor]
                |--COMMA[1x22] : [,]
                |--WS[1x23] : [ ]
                |--ARGUMENT[1x24] : [String]
                |--RIGHT_BRACE[1x30] : [)]
        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final int DESCRIPTION
        Description node. It contains:

        It is argument for many Javadoc tags and inline tags.

        Example:

        @throws IOException if <b>connection</b> problems occur
        Tree: 
         |--JAVADOC_TAG[1x0] : [@throws IOException if <b>connection</b> problems occur]
        |--THROWS_LITERAL[1x0] : [@throws]
        |--WS[1x7] : [ ]
        |--CLASS_NAME[1x8] : [IOException]
        |--WS[1x19] : [ ]
        |--DESCRIPTION[1x20] : [if <b>connection</b> problems occur]
            |--TEXT[1x20] : [if ]
            |--HTML_ELEMENT[1x23] : [<b>connection</b>]
                |--HTML_TAG[1x23] : [<b>connection</b>]
                    |--HTML_ELEMENT_START[1x23] : [<b>]
                        |--START[1x23] : [<]
                        |--HTML_TAG_NAME[1x24] : [b]
                        |--END[1x25] : [>]
                    |--TEXT[1x26] : [connection]
                    |--HTML_ELEMENT_END[1x36] : [</b>]
                        |--START[1x36] : [<]
                        |--SLASH[1x37] : [/]
                        |--HTML_TAG_NAME[1x38] : [b]
                        |--END[1x39] : [>]
            |--TEXT[1x40] : [ problems occur]
        See Also:
        Constant Field Values

      • HTML_ELEMENT

        public static final int HTML_ELEMENT
        Parent node for all html tags.
        See Also:
        Constant Field Values

      • HTML_ELEMENT_START

        public static final int HTML_ELEMENT_START
        Start html tag: <XXXX>.
        See Also:
        Constant Field Values

      • HTML_ELEMENT_END

        public static final int HTML_ELEMENT_END
        End html tag: <XXXX>.
        See Also:
        Constant Field Values

      • ATTRIBUTE

        public static final int ATTRIBUTE
        Html tag attribute. Parent node for: HTML_TAG_IDENT, EQUALS, ATTR_VALUE.
        See Also:
        Constant Field Values

      • PARAGRAPH

        public static final int PARAGRAPH
        Paragraph html tag: <p></p>.
        See Also:
        Constant Field Values

      • LI_TAG_START

        public static final int LI_TAG_START
        Start list item tag.
        See Also:
        Constant Field Values

      • TR_TAG_START

        public static final int TR_TAG_START
        Start table row tag.
        See Also:
        Constant Field Values

      • TD_TAG_START

        public static final int TD_TAG_START
        Start table cell tag.
        See Also:
        Constant Field Values

      • TH_TAG_START

        public static final int TH_TAG_START
        Start table header cell tag.
        See Also:
        Constant Field Values

      • TH_TAG_END

        public static final int TH_TAG_END
        End table header cell tag.
        See Also:
        Constant Field Values

      • COLGROUP_TAG_START

        public static final int COLGROUP_TAG_START
        Start colgroup tag.
        See Also:
        Constant Field Values

      • COLGROUP_TAG_END

        public static final int COLGROUP_TAG_END
        End colgroup tag.
        See Also:
        Constant Field Values

      • DD

        public static final int DD
        Description of a term html tag: <dd></dd>.
        See Also:
        Constant Field Values

      • DD_TAG_START

        public static final int DD_TAG_START
        Start description of a term tag.
        See Also:
        Constant Field Values

      • DD_TAG_END

        public static final int DD_TAG_END
        End description of a term tag.
        See Also:
        Constant Field Values

      • DT_TAG_START

        public static final int DT_TAG_START
        Start description term tag.
        See Also:
        Constant Field Values

      • DT_TAG_END

        public static final int DT_TAG_END
        End description term tag.
        See Also:
        Constant Field Values

      • OPTION_TAG_START

        public static final int OPTION_TAG_START
        Start option tag.
        See Also:
        Constant Field Values

      • TBODY_TAG_START

        public static final int TBODY_TAG_START
        Start table body tag.
        See Also:
        Constant Field Values

      • TBODY_TAG_END

        public static final int TBODY_TAG_END
        End table body tag.
        See Also:
        Constant Field Values

      • TFOOT_TAG_START

        public static final int TFOOT_TAG_START
        Start table foot tag.
        See Also:
        Constant Field Values

      • TFOOT_TAG_END

        public static final int TFOOT_TAG_END
        End table foot tag.
        See Also:
        Constant Field Values

      • THEAD_TAG_START

        public static final int THEAD_TAG_START
        Start table head tag.
        See Also:
        Constant Field Values

      • THEAD_TAG_END

        public static final int THEAD_TAG_END
        End table head tag.
        See Also:
        Constant Field Values

      • OPTGROUP_TAG_START

        public static final int OPTGROUP_TAG_START
        `optgroup` tag start.
        See Also:
        Constant Field Values

      • OPTGROUP_TAG_END

        public static final int OPTGROUP_TAG_END
        `optgroup` tag end.
        See Also:
        Constant Field Values

      • SINGLETON_ELEMENT

        public static final int SINGLETON_ELEMENT
        Parent node for all singleton html tags.
        See Also:
        Constant Field Values

      • EMPTY_TAG

        public static final int EMPTY_TAG
        Non-special empty html tag.
        See Also:
        Constant Field Values

      • HTML_COMMENT

        public static final int HTML_COMMENT
        Html comment: <!-- -->.
        See Also:
        Constant Field Values