oracle.javatools.parser.java.v1.symbol
Class CommentSymbol

java.lang.Object
  oracle.javatools.parser.util.ArrayListHeap
      oracle.javatools.parser.java.v1.symbol.JavaSymbol
          oracle.javatools.parser.java.v1.symbol.NameSymbol
              oracle.javatools.parser.java.v1.symbol.CommentSymbol

All Implemented Interfaces:

JavaDocTokens, JavaSyntaxCodes

public class CommentSymbol
extends NameSymbol
implements JavaDocTokens

The CommentSymbol subclasses off of NameSymbol purely to inherit the getValue and toString methods. Right now, only Javadoc comments are parsed.

Field Summary

java.lang.Boolean	isDeprecated
java.lang.Boolean	isHidden
static int	TYPE_JAVADOC This comment is javadoc.

Fields inherited from interface oracle.javatools.parser.java.v1.JavaDocTokens

TK_DOC_AUTHOR, TK_DOC_COMMENTTEXT, TK_DOC_DEPRECATED, TK_DOC_EXCEPTION, TK_DOC_HIDDEN, TK_DOC_PARAM, TK_DOC_RETURN, TK_DOC_SEE, TK_DOC_SERIAL, TK_DOC_SERIALDATA, TK_DOC_SERIALFIELD, TK_DOC_SINCE, TK_DOC_TAGTEXT, TK_DOC_THROWS, TK_DOC_UNKNOWNTAG, TK_DOC_VERSION

Fields inherited from interface oracle.javatools.parser.java.v1.JavaSyntaxCodes

SYNTAX_ARGUMENTS, SYNTAX_ARRAY_CREATOR, SYNTAX_ARRAY_INITIALIZER, SYNTAX_ASG_OPERATOR, SYNTAX_BLOCK, SYNTAX_BRACKET_EXPRESSION, SYNTAX_BRACKETS_OPT, SYNTAX_BROKEN, SYNTAX_CATCH_CLAUSE, SYNTAX_CATCH_PAREN_EXPRESSION, SYNTAX_CLASS_CREATOR, SYNTAX_CLASS_DECLARATION, SYNTAX_CLASS_INITIALIZER, SYNTAX_CODE_ELEMENT, SYNTAX_CONSTRUCTOR_DECLARATION, SYNTAX_CONTROL_PAREN_EXPRESSION, SYNTAX_CREATOR, SYNTAX_DO_STATEMENT, SYNTAX_DOC_COMMENT, SYNTAX_ELSE_CLAUSE, SYNTAX_EXP_WRAPPER, SYNTAX_EXPRESSION, SYNTAX_EXPRESSION_OR_DECL, SYNTAX_EXTENDS, SYNTAX_FIELD_DECLARATION, SYNTAX_FINALLY_CLAUSE, SYNTAX_FOR_CONDITIONAL, SYNTAX_FOR_INIT, SYNTAX_FOR_PAREN_EXPRESSION, SYNTAX_FOR_STATEMENT, SYNTAX_FOR_UPDATE, SYNTAX_FORMAL_PARAMETER, SYNTAX_FORMAL_PARAMETER_LIST, SYNTAX_IDENTIFIER_PRIMARY, SYNTAX_IF_STATEMENT, SYNTAX_IMPLEMENTS, SYNTAX_IMPORT_DECLARATION, SYNTAX_INFIX_OPERATOR, SYNTAX_INIT_ARRAY_CREATOR, SYNTAX_INNER_CLASS_OR_INTERFACE, SYNTAX_INNER_CREATOR, SYNTAX_INTERFACE_DECLARATION, SYNTAX_JAVA_ROOT, SYNTAX_MEMBER_DECLARATION, SYNTAX_METHOD_DECLARATION, SYNTAX_MODIFIERS, SYNTAX_PACKAGE_DECLARATION, SYNTAX_PAREN_EXPRESSION, SYNTAX_POSTFIX_OPERATOR, SYNTAX_PREFIX_OPERATOR, SYNTAX_PRIMARY, SYNTAX_PRIMARY_BRACKETS, SYNTAX_PRIMARY_WORD, SYNTAX_QUALIFIED_IMPORT_NAME, SYNTAX_QUALIFIED_NAME, SYNTAX_QUALIFIED_PRIMARY, SYNTAX_QUES_OPERATOR, SYNTAX_SIMPLE_NAME, SYNTAX_SQLJ_CONTEXT, SYNTAX_SQLJ_STATEMENT, SYNTAX_STATEMENT, SYNTAX_SWITCH_BLOCK, SYNTAX_SWITCH_CASE, SYNTAX_SWITCH_STATEMENT, SYNTAX_SYNCH_STATEMENT, SYNTAX_THROWS, SYNTAX_TRY_STATEMENT, SYNTAX_TYPE, SYNTAX_TYPE_BODY, SYNTAX_TYPE_DECLARATION, SYNTAX_UNINIT_ARRAY_CREATOR, SYNTAX_UNPARSED_BLOCK, SYNTAX_UNPARSED_EXPRESSION, SYNTAX_UNPARSED_PAREN_EXPRESSION, SYNTAX_VARIABLE_DECLARATOR, SYNTAX_VARIABLE_INITIALIZER, SYNTAX_WHILE_STATEMENT

Method Summary

int	getCommentType()
boolean	isDeprecated()
boolean	isHidden() Bug 2798659.

Methods inherited from class oracle.javatools.parser.java.v1.symbol.NameSymbol

getValue

Methods inherited from class oracle.javatools.parser.java.v1.symbol.JavaSymbol

getCode, getEndOffset, getParent, getStartOffset

Methods inherited from class oracle.javatools.parser.util.ArrayListHeap

allocArrayList, freeArrayList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_JAVADOC

public static final int TYPE_JAVADOC

This comment is javadoc. Anything else is not javadoc (duh).

See Also:

Constant Field Values

isDeprecated

public java.lang.Boolean isDeprecated

isHidden

public java.lang.Boolean isHidden

Method Detail

getCommentType

public int getCommentType()

Returns:

the type of this comment. Refer to enumerated constants.

isDeprecated

public boolean isDeprecated()

Returns:

True if this is a Javadoc comment AND this comment indicates deprecation.

isHidden

public boolean isHidden()

Bug 2798659.

Returns:

True if this is a Javadoc comment AND this comment indicates hidden.