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

Fields

Modifier and Type	Field and Description
Javadoc	docComment
boolean	shouldReportProblems

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

abort, ARGUMENT_RECOVERY, ARGUMENT_TYPE_RECOVERY, AST_STACK_INCREMENT, astLengthPtr, astLengthStack, astPtr, astStack, checkDocComment, COMPIL_PARSER, COMPLETION_PARSER, complianceLevel, deprecated, DOM_PARSER, EMPTY_ARGUMENT_RECOVERY, firstTagPosition, FORMATTER_COMMENT_PARSER, identifierLengthPtr, identifierLengthStack, identifierPositionStack, identifierPtr, identifierStack, index, inheritedPositions, inheritedPositionsPtr, inlineTagStart, inlineTagStarted, javadocEnd, javadocStart, javadocTextEnd, javadocTextStart, kind, lastBlockTagValue, lastIdentifierEndPosition, lineEnd, lineEnds, lineStarted, memberStart, PARSER_KIND, QUALIFIED_NAME_RECOVERY, reportProblems, returnStatement, scanner, SELECTION_PARSER, setJavadocPositions, 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, COMPILATION_UNIT_TAGS, FIELD_TAGS, HREF_TAG, INLINE_IDX, INLINE_TAGS, INLINE_TAGS_LENGTH, JAVADOC_TAG_TYPE, METHOD_TAGS, NO_TAG_VALUE, ORDERED_TAGS_NUMBER, PACKAGE_TAGS, PARAM_TAG_EXPECTED_ORDER, SEE_TAG_EXPECTED_ORDER, TAG_AUTHOR, TAG_AUTHOR_LENGTH, TAG_AUTHOR_VALUE, TAG_CATEGORY, TAG_CATEGORY_LENGTH, TAG_CATEGORY_VALUE, TAG_CODE, TAG_CODE_LENGTH, TAG_CODE_VALUE, TAG_DEPRECATED, TAG_DEPRECATED_LENGTH, TAG_DEPRECATED_VALUE, TAG_DOC_ROOT, TAG_DOC_ROOT_LENGTH, TAG_DOC_ROOT_VALUE, 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_LITERAL_LENGTH, TAG_LITERAL_VALUE, TAG_NAMES, 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_DATA_LENGTH, TAG_SERIAL_DATA_VALUE, TAG_SERIAL_FIELD, TAG_SERIAL_FIELD_LENGTH, TAG_SERIAL_FIELD_VALUE, TAG_SERIAL_LENGTH, TAG_SERIAL_VALUE, TAG_SINCE, TAG_SINCE_LENGTH, TAG_SINCE_VALUE, TAG_THROWS, TAG_THROWS_LENGTH, TAG_THROWS_VALUE, TAG_TYPE_BLOCK, TAG_TYPE_INLINE, TAG_TYPE_NONE, TAG_VALUE, TAG_VALUE_LENGTH, TAG_VALUE_VALUE, TAG_VERSION, TAG_VERSION_LENGTH, TAG_VERSION_VALUE, THROWS_TAG_EXPECTED_ORDER

Constructor Summary

Constructors

Constructor and Description
JavadocParser(Parser sourceParser)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkDeprecation(int commentPtr)
protected Object	createArgumentReference(char[] name, int dim, boolean isVarargs, Object typeRef, long[] dimPositions, long argNamePos)
protected Object	createFieldReference(Object receiver)
protected Object	createMethodReference(Object receiver, List arguments)
protected Object	createReturnStatement()
protected void	createTag()
protected Object	createTypeReference(int primitiveToken)
protected TypeDeclaration	getParsedTypeDeclaration()
protected void	parseInheritDocTag()
protected boolean	parseParam()
protected boolean	parseReturn()
protected void	parseSimpleTag()
protected boolean	parseTag(int previousPosition)
protected boolean	parseThrows()
protected boolean	pushParamName(boolean isTypeParam)
protected boolean	pushSeeRef(Object statement)
protected void	pushText(int start, int end)
protected boolean	pushThrowName(Object typeRef)
protected void	refreshInlineTagPosition(int previousPosition)
protected void	refreshReturnStatement()
String	toString()
protected void	updateDocComment()

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

commentParse, consumeToken, createFakeReference, getCurrentTokenType, parseArguments, parseHref, parseHtmlTag, parseIdentifierTag, parseMember, parseQualifiedName, parseReference, peekChar, pushIdentifier, pushOnAstStack, readChar, readToken, readTokenAndConsume, readTokenSafely, recordInheritedPosition, setInlineTagStarted, 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

shouldReportProblems

public boolean shouldReportProblems

Constructor Detail

JavadocParser

public JavadocParser(Parser sourceParser)

Method Detail

checkDeprecation

public boolean checkDeprecation(int commentPtr)

createArgumentReference

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

Specified by:

createArgumentReference in class AbstractCommentParser

Throws:

InvalidInputException

createFieldReference

protected Object createFieldReference(Object receiver)
                               throws InvalidInputException

Specified by:

createFieldReference in class AbstractCommentParser

Throws:

InvalidInputException

createMethodReference

protected Object createMethodReference(Object receiver,
                           List arguments)
                                throws InvalidInputException

Specified by:

createMethodReference in class AbstractCommentParser

Throws:

InvalidInputException

createReturnStatement

protected Object createReturnStatement()

Overrides:

createReturnStatement in class AbstractCommentParser

createTag

protected void createTag()

Specified by:

createTag in class AbstractCommentParser

createTypeReference

protected Object createTypeReference(int primitiveToken)

Specified by:

createTypeReference in class AbstractCommentParser

getParsedTypeDeclaration

protected TypeDeclaration getParsedTypeDeclaration()

parseThrows

protected boolean parseThrows()

Overrides:

parseThrows in class AbstractCommentParser

parseReturn

protected boolean parseReturn()

parseSimpleTag

protected void parseSimpleTag()

parseTag

protected boolean parseTag(int previousPosition)
                    throws InvalidInputException

Specified by:

parseTag in class AbstractCommentParser

Throws:

InvalidInputException

parseInheritDocTag

protected void parseInheritDocTag()

parseParam

protected boolean parseParam()
                      throws InvalidInputException

Overrides:

parseParam in class AbstractCommentParser

Throws:

InvalidInputException

pushParamName

protected boolean pushParamName(boolean isTypeParam)

Specified by:

pushParamName in class AbstractCommentParser

pushSeeRef

protected boolean pushSeeRef(Object statement)

Specified by:

pushSeeRef in class AbstractCommentParser

pushText

protected void pushText(int start,
            int end)

Overrides:

pushText in class AbstractCommentParser

pushThrowName

protected boolean pushThrowName(Object typeRef)

Specified by:

pushThrowName in class AbstractCommentParser

refreshInlineTagPosition

protected void refreshInlineTagPosition(int previousPosition)

Overrides:

refreshInlineTagPosition in class AbstractCommentParser

refreshReturnStatement

protected void refreshReturnStatement()

Overrides:

refreshReturnStatement in class AbstractCommentParser

toString

public String toString()

Overrides:

toString in class AbstractCommentParser

updateDocComment

protected void updateDocComment()

Specified by:

updateDocComment in class AbstractCommentParser