Package org.aspectj.org.eclipse.jdt.internal.compiler.parser

Class JavadocParser

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser

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

All Implemented Interfaces:

JavadocTagConstants

Direct Known Subclasses:

CompletionJavadocParser, SelectionJavadocParser, SourceJavadocParser

public class JavadocParser
extends AbstractCommentParser

Parser specialized for decoding javadoc comments

Nested Class Summary

Nested classes/interfaces inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocTagConstants

JavadocTagConstants.LevelTags

Field Summary

Fields

Modifier and Type	Field	Description
Javadoc	docComment
boolean	shouldReportProblems

Fields inherited from class org.aspectj.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, providesReferencesPtr, providesReferencesStack, QUALIFIED_NAME_RECOVERY, reportProblems, returnStatement, scanner, SELECTION_PARSER, setJavadocPositions, snippetInlineTagStarted, source, SOURCE_PARSER, sourceLevel, sourceParser, starPosition, tagSourceEnd, tagSourceStart, tagValue, TEXT_PARSE, TEXT_VERIF, textStart, tokenPreviousPosition, usesReferencesPtr, usesReferencesStack

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

ALL_TAGS_LENGTH, BLOCK_IDX, BLOCK_TAGS, BLOCK_TAGS_LENGTH, BLOCK_TAGS_RAW, CLASS_TAGS, COMPILATION_UNIT_TAGS, FIELD_TAGS, HREF_TAG, IN_SNIPPET_TAGS, IN_SNIPPET_TAGS_LENGTH, INLINE_IDX, INLINE_TAGS, INLINE_TAGS_LENGTH, INLINE_TAGS_RAW, JAVADOC_TAG_TYPE, JAVADOC_TAG_TYPE_16PLUS, METHOD_TAGS, MODULE_TAGS, NO_TAG_VALUE, ORDERED_TAGS_NUMBER, PACKAGE_TAGS, PARAM_TAG_EXPECTED_ORDER, SEE_TAG_EXPECTED_ORDER, SNIPPET_IDX, SNIPPET_TAGS_LENGTH, TAG_API_NOTE, TAG_API_NOTE_LENGTH, TAG_API_NOTE_VALUE, 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_HIDDEN, TAG_HIDDEN_LENGTH, TAG_HIDDEN_VALUE, TAG_HIGHLIGHT, TAG_HIGHLIGHT_LENGTH, TAG_HIGHLIGHT_VALUE, TAG_IMPL_NOTE, TAG_IMPL_NOTE_LENGTH, TAG_IMPL_NOTE_VALUE, TAG_IMPL_SPEC, TAG_IMPL_SPEC_LENGTH, TAG_IMPL_SPEC_VALUE, TAG_INDEX, TAG_INDEX_LENGTH, TAG_INDEX_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_PROVIDES, TAG_PROVIDES_LENGTH, TAG_PROVIDES_VALUE, TAG_REPLACE, TAG_REPLACE_LENGTH, TAG_REPLACE_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_SNIPPET, TAG_SNIPPET_LENGTH, TAG_SNIPPET_VALUE, TAG_SUMMARY, TAG_SUMMARY_LENGTH, TAG_SUMMARY_VALUE, TAG_SYSTEM_PROPERTY, TAG_SYSTEM_PROPERTY_LENGTH, TAG_SYSTEM_PROPERTY_VALUE, TAG_THROWS, TAG_THROWS_LENGTH, TAG_THROWS_VALUE, TAG_TYPE_BLOCK, TAG_TYPE_IN_SNIPPET, TAG_TYPE_INLINE, TAG_TYPE_INLINE_BLOCK, TAG_TYPE_NONE, TAG_USES, TAG_USES_LENGTH, TAG_USES_VALUE, TAG_VALUE, TAG_VALUE_LENGTH, TAG_VALUE_VALUE, TAG_VERSION, TAG_VERSION_LENGTH, TAG_VERSION_VALUE, THROWS_TAG_EXPECTED_ORDER

Constructor Summary

Constructors

Constructor	Description
JavadocParser(Parser sourceParser)

Method Summary

Modifier and Type	Method	Description
protected void	addSnippetInnerTag(Object tag, Object snippetTag)
protected void	addTagProperties(Object Tag, Map<String,Object> map, int tagCount)
protected boolean	areRegionsClosed()
boolean	checkDeprecation(int commentPtr)
protected void	closeJavaDocRegion(String name, Object snippetTag, int end)
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 JavadocModuleReference	createModuleReference(int moduleRefTokenCount)
protected Object	createModuleTypeReference(int primitiveToken, int moduleRefTokenCount)
protected Object	createReturnStatement()
protected Object	createSnippetInnerTag(String tagName, int start, int end)
protected Object	createSnippetRegion(String name, List<Object> tags, Object snippetTag, boolean isDummyRegion, boolean considerPrevTag)
protected Object	createSnippetTag()
protected void	createTag()
protected Object	createTypeReference(int primitiveToken)
protected Object	createTypeReference(int primitiveToken, boolean canBeModule)
protected TypeDeclaration	getParsedTypeDeclaration()
protected void	parseInheritDocTag()
protected boolean	parseParam()
protected boolean	parseProvidesReference()
protected boolean	parseReturn()
protected void	parseSimpleTag()
protected boolean	parseTag(int previousPosition)
protected boolean	parseThrows()
protected boolean	parseUsesReference()
protected void	pushExternalSnippetText(char[] text, int start, int end, boolean addNewLine, Object snippetTag)
protected boolean	pushParamName(boolean isTypeParam)
protected boolean	pushProvidesReference(Object typeRef)
protected boolean	pushSeeRef(Object statement)
protected void	pushSnippetText(char[] text, int start, int end, boolean addNewLine, Object snippetTag)
protected void	pushText(int start, int end)
protected boolean	pushThrowName(Object typeRef)
protected boolean	pushUsesReference(Object typeRef)
protected void	refreshInlineTagPosition(int previousPosition)
protected void	refreshReturnStatement()
protected void	setRegionPosition(int currentPosition)
protected void	setSnippetError(Object obj, String value)
protected void	setSnippetID(Object tag, String value)
protected void	setSnippetIsValid(Object obj, boolean value)
String	toString()
protected void	updateDocComment()

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

commentParse, consumeToken, createFakeReference, getCurrentTokenType, getNumberOfSingleLineCommentInSnippetTag, getTokenEndPosition, indexOfLastSingleComment, lookForTagsInSnippets, parseArguments, parseArguments, parseHref, parseHtmlTag, parseIdentifierTag, parseMember, parseMember, parseQualifiedName, parseQualifiedName, parseReference, parseReference, parseSnippet, parseSnippetInlineTags, peekChar, pushIdentifier, pushOnAstStack, readChar, readToken, readTokenAndConsume, readTokenSafely, recordInheritedPosition, setInlineTagStarted, setProjectPath, setProjectSrcClasspath, setSourceComplianceLevel, syntaxRecoverModuleQualifiedName, syntaxRecoverQualifiedName, updateLineEnd, verifyEndLine, verifySpaceOrEndComment

Methods inherited from class java.lang.Object

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

Field Details

docComment

public Javadoc docComment

shouldReportProblems

public boolean shouldReportProblems

Constructor Details

JavadocParser

public JavadocParser(Parser sourceParser)

Method Details

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

createSnippetTag

protected Object createSnippetTag()

Specified by:

createSnippetTag in class AbstractCommentParser

createSnippetRegion

protected Object createSnippetRegion(String name,
 List<Object> tags,
 Object snippetTag,
 boolean isDummyRegion,
 boolean considerPrevTag)

Specified by:

createSnippetRegion in class AbstractCommentParser

setSnippetIsValid

protected void setSnippetIsValid(Object obj,
 boolean value)

Specified by:

setSnippetIsValid in class AbstractCommentParser

setSnippetError

protected void setSnippetError(Object obj,
 String value)

Specified by:

setSnippetError in class AbstractCommentParser

setSnippetID

protected void setSnippetID(Object tag,
 String value)

Specified by:

setSnippetID in class AbstractCommentParser

createSnippetInnerTag

protected Object createSnippetInnerTag(String tagName,
 int start,
 int end)

Specified by:

createSnippetInnerTag in class AbstractCommentParser

addTagProperties

protected void addTagProperties(Object Tag,
 Map<String,Object> map,
 int tagCount)

Specified by:

addTagProperties in class AbstractCommentParser

addSnippetInnerTag

protected void addSnippetInnerTag(Object tag,
 Object snippetTag)

Specified by:

addSnippetInnerTag in class AbstractCommentParser

createTypeReference

protected Object createTypeReference(int primitiveToken)

Specified by:

createTypeReference in class AbstractCommentParser

createTypeReference

protected Object createTypeReference(int primitiveToken,
 boolean canBeModule)

Specified by:

createTypeReference in class AbstractCommentParser

createModuleReference

protected JavadocModuleReference createModuleReference(int moduleRefTokenCount)

createModuleTypeReference

protected Object createModuleTypeReference(int primitiveToken,
 int moduleRefTokenCount)

Specified by:

createModuleTypeReference 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

pushSnippetText

protected void pushSnippetText(char[] text,
 int start,
 int end,
 boolean addNewLine,
 Object snippetTag)

Overrides:

pushSnippetText in class AbstractCommentParser

closeJavaDocRegion

protected void closeJavaDocRegion(String name,
 Object snippetTag,
 int end)

Specified by:

closeJavaDocRegion in class AbstractCommentParser

pushExternalSnippetText

protected void pushExternalSnippetText(char[] text,
 int start,
 int end,
 boolean addNewLine,
 Object snippetTag)

Overrides:

pushExternalSnippetText 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

parseUsesReference

protected boolean parseUsesReference()

pushUsesReference

protected boolean pushUsesReference(Object typeRef)

parseProvidesReference

protected boolean parseProvidesReference()

pushProvidesReference

protected boolean pushProvidesReference(Object typeRef)

areRegionsClosed

protected boolean areRegionsClosed()

Specified by:

areRegionsClosed in class AbstractCommentParser

setRegionPosition

protected void setRegionPosition(int currentPosition)

Specified by:

setRegionPosition in class AbstractCommentParser