Class CompletionJavadocParser
java.lang.Object
org.aspectj.org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser
org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocParser
org.aspectj.org.eclipse.jdt.internal.codeassist.complete.CompletionJavadocParser
- All Implemented Interfaces:
JavadocTagConstants
Parser specialized for decoding javadoc comments which includes cursor location for code completion.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic int
static int
static int
Fields inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocParser
docComment, 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, CLASS_TAGS, COMPILATION_UNIT_TAGS, FIELD_TAGS, HREF_TAG, IN_SNIPPET_TAGS, IN_SNIPPET_TAGS_LENGTH, INLINE_IDX, INLINE_TAGS, INLINE_TAGS_LENGTH, JAVADOC_TAG_TYPE, 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_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 -
Method Summary
Modifier and TypeMethodDescriptionboolean
checkDeprecation(int commentPtr)
protected boolean
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
createTypeReference(int primitiveToken, boolean canBeModule)
protected boolean
protected Object
parseArguments(Object receiver)
protected Object
parseArguments(Object receiver, boolean verifySpaceOrEndComment)
protected boolean
protected boolean
protected boolean
parseReference(boolean allowModule)
protected boolean
protected boolean
parseTag(int previousPosition)
protected boolean
protected boolean
pushParamName(boolean isTypeParam)
protected void
pushText(int start, int end)
Push text.protected int
protected Object
syntaxRecoverArgumentType(Object receiver, List arguments, Object argument)
protected Object
syntaxRecoverEmptyArgumentType(Object methodRef)
protected Object
syntaxRecoverQualifiedName(int primitiveToken)
protected void
protected boolean
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocParser
addSnippetInnerTag, addTagProperties, areRegionsClosed, closeJavaDocRegion, createReturnStatement, createSnippetInnerTag, createSnippetRegion, createSnippetTag, createTag, createTypeReference, getParsedTypeDeclaration, parseInheritDocTag, parseProvidesReference, parseReturn, parseSimpleTag, parseUsesReference, pushExternalSnippetText, pushProvidesReference, pushSeeRef, pushSnippetText, pushThrowName, pushUsesReference, refreshInlineTagPosition, refreshReturnStatement, setRegionPosition, setSnippetError, setSnippetID, setSnippetIsValid, toString
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser
consumeToken, createFakeReference, getCurrentTokenType, getNumberOfSingleLineCommentInSnippetTag, getTokenEndPosition, indexOfLastSingleComment, parseHref, parseHtmlTag, parseIdentifierTag, parseMember, parseMember, parseQualifiedName, parseQualifiedName, parseSnippetInlineTags, peekChar, pushIdentifier, pushOnAstStack, readChar, readTokenAndConsume, readTokenSafely, recordInheritedPosition, setInlineTagStarted, setProjectPath, setProjectSrcClasspath, setSourceComplianceLevel, syntaxRecoverModuleQualifiedName, updateLineEnd, verifyEndLine
-
Field Details
-
INLINE_ALL_TAGS_LENGTH
public static final int INLINE_ALL_TAGS_LENGTH -
BLOCK_ALL_TAGS_LENGTH
public static final int BLOCK_ALL_TAGS_LENGTH -
SNIPPET_ALL_TAGS_LENGTH
public static final int SNIPPET_ALL_TAGS_LENGTH
-
-
Constructor Details
-
CompletionJavadocParser
-
-
Method Details
-
checkDeprecation
public boolean checkDeprecation(int commentPtr)- Overrides:
checkDeprecation
in classJavadocParser
-
commentParse
protected boolean commentParse()- Overrides:
commentParse
in classAbstractCommentParser
-
createArgumentReference
protected Object createArgumentReference(char[] name, int dim, boolean isVarargs, Object typeRef, long[] dimPositions, long argNamePos) throws InvalidInputException- Overrides:
createArgumentReference
in classJavadocParser
- Throws:
InvalidInputException
-
createFieldReference
- Overrides:
createFieldReference
in classJavadocParser
- Throws:
InvalidInputException
-
createMethodReference
protected Object createMethodReference(Object receiver, List arguments) throws InvalidInputException- Overrides:
createMethodReference
in classJavadocParser
- Throws:
InvalidInputException
-
createTypeReference
- Overrides:
createTypeReference
in classJavadocParser
-
createModuleTypeReference
- Overrides:
createModuleTypeReference
in classJavadocParser
-
createModuleReference
- Overrides:
createModuleReference
in classJavadocParser
-
parseArguments
- Overrides:
parseArguments
in classAbstractCommentParser
- Throws:
InvalidInputException
-
parseArguments
protected Object parseArguments(Object receiver, boolean verifySpaceOrEndComment) throws InvalidInputException- Overrides:
parseArguments
in classAbstractCommentParser
- Throws:
InvalidInputException
-
parseParam
- Overrides:
parseParam
in classJavadocParser
- Throws:
InvalidInputException
-
parseReference
- Overrides:
parseReference
in classAbstractCommentParser
- Throws:
InvalidInputException
-
parseReference
- Overrides:
parseReference
in classAbstractCommentParser
- Throws:
InvalidInputException
-
parseTag
- Overrides:
parseTag
in classJavadocParser
- Throws:
InvalidInputException
-
parseSnippet
- Overrides:
parseSnippet
in classAbstractCommentParser
- Throws:
InvalidInputException
-
lookForTagsInSnippets
protected boolean lookForTagsInSnippets()- Overrides:
lookForTagsInSnippets
in classAbstractCommentParser
-
parseThrows
protected boolean parseThrows()- Overrides:
parseThrows
in classJavadocParser
-
pushParamName
protected boolean pushParamName(boolean isTypeParam)- Overrides:
pushParamName
in classJavadocParser
-
pushText
protected void pushText(int start, int end)Push text. If it includes completion location, then rescan line to see if there's a possible reference under the cursor location.- Overrides:
pushText
in classJavadocParser
- See Also:
AbstractCommentParser.pushText(int, int)
-
readToken
- Overrides:
readToken
in classAbstractCommentParser
- Throws:
InvalidInputException
-
syntaxRecoverQualifiedName
- Overrides:
syntaxRecoverQualifiedName
in classAbstractCommentParser
- Throws:
InvalidInputException
-
syntaxRecoverArgumentType
protected Object syntaxRecoverArgumentType(Object receiver, List arguments, Object argument) throws InvalidInputException- Throws:
InvalidInputException
-
syntaxRecoverEmptyArgumentType
- Throws:
InvalidInputException
-
updateDocComment
protected void updateDocComment()- Overrides:
updateDocComment
in classJavadocParser
-
verifySpaceOrEndComment
protected boolean verifySpaceOrEndComment()- Overrides:
verifySpaceOrEndComment
in classAbstractCommentParser
-