org.eclipse.jdt.internal.compiler.parser
Class JavadocParser

java.lang.Object
  org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser
      org.eclipse.jdt.internal.compiler.parser.JavadocParser

All Implemented Interfaces:

JavadocTagConstants

public class JavadocParser
extends AbstractCommentParser

Parser specialized for decoding javadoc comments

Field Summary

Javadoc

docComment

Fields inherited from class org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser

abort, ARGUMENT_RECOVERY, ARGUMENT_TYPE_RECOVERY, astLengthPtr, astLengthStack, astPtr, astStack, AstStackIncrement, checkDocComment, COMPIL_PARSER, COMPLETION_PARSER, complianceLevel, deprecated, DOM_PARSER, EMPTY_ARGUMENT_RECOVERY, firstTagPosition, identifierLengthPtr, identifierLengthStack, identifierPositionStack, identifierPtr, identifierStack, index, inheritedPositions, inlineTagStart, inlineTagStarted, javadocEnd, javadocStart, kind, lastIdentifierEndPosition, lineEnd, lineEnds, lineStarted, memberStart, PARSER_KIND, QUALIFIED_NAME_RECOVERY, reportProblems, returnStatement, scanner, SELECTION_PARSER, source, SOURCE_PARSER, sourceLevel, sourceParser, starPosition, tagSourceEnd, tagSourceStart, tagValue, TEXT_PARSE, TEXT_VERIF, textStart, tokenPreviousPosition

Fields inherited from interface org.eclipse.jdt.internal.compiler.parser.JavadocTagConstants

ALL_TAGS_LENGTH, BLOCK_IDX, BLOCK_TAGS, BLOCK_TAGS_LENGTH, CLASS_TAGS, FIELD_TAGS, INLINE_IDX, INLINE_TAGS, INLINE_TAGS_LENGTH, METHOD_TAGS, NO_TAG_VALUE, ORDERED_TAGS_NUMBER, PACKAGE_TAGS, PARAM_TAG_EXPECTED_ORDER, SEE_TAG_EXPECTED_ORDER, TAG_AUTHOR, TAG_CATEGORY, TAG_CATEGORY_LENGTH, TAG_CATEGORY_VALUE, TAG_CODE, TAG_DEPRECATED, TAG_DEPRECATED_LENGTH, TAG_DEPRECATED_VALUE, TAG_DOC_ROOT, TAG_EXCEPTION, TAG_EXCEPTION_LENGTH, TAG_EXCEPTION_VALUE, TAG_INHERITDOC, TAG_INHERITDOC_LENGTH, TAG_INHERITDOC_VALUE, TAG_LINK, TAG_LINK_LENGTH, TAG_LINK_VALUE, TAG_LINKPLAIN, TAG_LINKPLAIN_LENGTH, TAG_LINKPLAIN_VALUE, TAG_LITERAL, TAG_OTHERS_VALUE, TAG_PARAM, TAG_PARAM_LENGTH, TAG_PARAM_VALUE, TAG_RETURN, TAG_RETURN_LENGTH, TAG_RETURN_VALUE, TAG_SEE, TAG_SEE_LENGTH, TAG_SEE_VALUE, TAG_SERIAL, TAG_SERIAL_DATA, TAG_SERIAL_FIELD, TAG_SINCE, TAG_THROWS, TAG_THROWS_LENGTH, TAG_THROWS_VALUE, TAG_VALUE, TAG_VALUE_LENGTH, TAG_VALUE_VALUE, TAG_VERSION, THROWS_TAG_EXPECTED_ORDER

Constructor Summary

JavadocParser(Parser sourceParser)

Method Summary

boolean	checkDeprecation(int commentPtr)
protected java.lang.Object	createArgumentReference(char[] name, int dim, boolean isVarargs, java.lang.Object typeRef, long[] dimPositions, long argNamePos)
protected java.lang.Object	createFieldReference(java.lang.Object receiver)
protected java.lang.Object	createMethodReference(java.lang.Object receiver, java.util.List arguments)
protected java.lang.Object	createReturnStatement()
protected void	createTag()
protected java.lang.Object	createTypeReference(int primitiveToken)
protected TypeDeclaration	getParsedTypeDeclaration()
protected boolean	parseReturn()
protected void	parseSimpleTag()
protected boolean	parseTag(int previousPosition)
protected boolean	pushParamName(boolean isTypeParam)
protected boolean	pushSeeRef(java.lang.Object statement)
protected boolean	pushThrowName(java.lang.Object typeRef)
protected void	refreshReturnStatement()
java.lang.String	toString()
protected void	updateDocComment()

Methods inherited from class org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser

commentParse, consumeToken, getCurrentTokenType, parseArguments, parseIdentifierTag, parseMember, parseParam, parseQualifiedName, parseReference, parseThrows, peekChar, pushIdentifier, pushOnAstStack, pushText, readChar, readToken, readTokenAndConsume, readTokenSafely, refreshInlineTagPosition, syntaxRecoverQualifiedName, updateLineEnd, verifyEndLine, verifySpaceOrEndComment

Methods inherited from class java.lang.Object

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

Field Detail

docComment

public Javadoc docComment

Constructor Detail

JavadocParser

public JavadocParser(Parser sourceParser)

Method Detail

checkDeprecation

public boolean checkDeprecation(int commentPtr)

createArgumentReference

protected java.lang.Object createArgumentReference(char[] name,
                                                   int dim,
                                                   boolean isVarargs,
                                                   java.lang.Object typeRef,
                                                   long[] dimPositions,
                                                   long argNamePos)
                                            throws InvalidInputException

Specified by:

createArgumentReference in class AbstractCommentParser

Throws:

InvalidInputException

createFieldReference

protected java.lang.Object createFieldReference(java.lang.Object receiver)
                                         throws InvalidInputException

Specified by:

createFieldReference in class AbstractCommentParser

Throws:

InvalidInputException

createMethodReference

protected java.lang.Object createMethodReference(java.lang.Object receiver,
                                                 java.util.List arguments)
                                          throws InvalidInputException

Specified by:

createMethodReference in class AbstractCommentParser

Throws:

InvalidInputException

createReturnStatement

protected java.lang.Object createReturnStatement()

Overrides:

createReturnStatement in class AbstractCommentParser

createTag

protected void createTag()

Specified by:

createTag in class AbstractCommentParser

createTypeReference

protected java.lang.Object createTypeReference(int primitiveToken)

Specified by:

createTypeReference in class AbstractCommentParser

getParsedTypeDeclaration

protected TypeDeclaration getParsedTypeDeclaration()

parseReturn

protected boolean parseReturn()

parseSimpleTag

protected void parseSimpleTag()

parseTag

protected boolean parseTag(int previousPosition)
                    throws InvalidInputException

Specified by:

parseTag in class AbstractCommentParser

Throws:

InvalidInputException

pushParamName

protected boolean pushParamName(boolean isTypeParam)

Specified by:

pushParamName in class AbstractCommentParser

pushSeeRef

protected boolean pushSeeRef(java.lang.Object statement)

Specified by:

pushSeeRef in class AbstractCommentParser

pushThrowName

protected boolean pushThrowName(java.lang.Object typeRef)

Specified by:

pushThrowName in class AbstractCommentParser

refreshReturnStatement

protected void refreshReturnStatement()

Overrides:

refreshReturnStatement in class AbstractCommentParser

toString

public java.lang.String toString()

Overrides:

toString in class AbstractCommentParser

updateDocComment

protected void updateDocComment()

Specified by:

updateDocComment in class AbstractCommentParser