Package org.aspectj.org.eclipse.jdt.internal.codeassist.complete

Klasse 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

Alle implementierten Schnittstellen:

JavadocTagConstants

public class CompletionJavadocParser
extends JavadocParser

Parser specialized for decoding javadoc comments which includes cursor location for code completion.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final int	BLOCK_ALL_TAGS_LENGTH
static final int	INLINE_ALL_TAGS_LENGTH
static final int	SNIPPET_ALL_TAGS_LENGTH

Von Klasse geerbte Felder org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocParser

docComment, shouldReportProblems

Von Klasse geerbte Felder 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

Von Schnittstelle geerbte Felder 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

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CompletionJavadocParser(CompletionParser sourceParser)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	checkDeprecation(int commentPtr)
protected boolean	commentParse()
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	lookForTagsInSnippets()
protected Object	parseArguments(Object receiver)
protected Object	parseArguments(Object receiver, boolean verifySpaceOrEndComment)
protected boolean	parseParam()
protected boolean	parseReference()
protected boolean	parseReference(boolean allowModule)
protected boolean	parseSnippet()
protected boolean	parseTag(int previousPosition)
protected boolean	parseThrows()
protected boolean	pushParamName(boolean isTypeParam)
protected void	pushText(int start, int end)	Push text.
protected int	readToken()
protected Object	syntaxRecoverArgumentType(Object receiver, List arguments, Object argument)
protected Object	syntaxRecoverEmptyArgumentType(Object methodRef)
protected Object	syntaxRecoverQualifiedName(int primitiveToken)
protected void	updateDocComment()
protected boolean	verifySpaceOrEndComment()

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden 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

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

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

Konstruktordetails

CompletionJavadocParser

public CompletionJavadocParser(CompletionParser sourceParser)

Methodendetails

checkDeprecation

public boolean checkDeprecation(int commentPtr)

Setzt außer Kraft:

checkDeprecation in Klasse JavadocParser

commentParse

protected boolean commentParse()

Setzt außer Kraft:

commentParse in Klasse AbstractCommentParser

createArgumentReference

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

Setzt außer Kraft:

createArgumentReference in Klasse JavadocParser

Löst aus:

InvalidInputException

createFieldReference

protected Object createFieldReference(Object receiver)
                               throws InvalidInputException

Setzt außer Kraft:

createFieldReference in Klasse JavadocParser

Löst aus:

InvalidInputException

createMethodReference

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

Setzt außer Kraft:

createMethodReference in Klasse JavadocParser

Löst aus:

InvalidInputException

createTypeReference

protected Object createTypeReference(int primitiveToken,
 boolean canBeModule)

Setzt außer Kraft:

createTypeReference in Klasse JavadocParser

createModuleTypeReference

protected Object createModuleTypeReference(int primitiveToken,
 int moduleRefTokenCount)

Setzt außer Kraft:

createModuleTypeReference in Klasse JavadocParser

createModuleReference

protected JavadocModuleReference createModuleReference(int moduleRefTokenCount)

Setzt außer Kraft:

createModuleReference in Klasse JavadocParser

parseArguments

protected Object parseArguments(Object receiver)
                         throws InvalidInputException

Setzt außer Kraft:

parseArguments in Klasse AbstractCommentParser

Löst aus:

InvalidInputException

parseArguments

protected Object parseArguments(Object receiver,
 boolean verifySpaceOrEndComment)
                         throws InvalidInputException

Setzt außer Kraft:

parseArguments in Klasse AbstractCommentParser

Löst aus:

InvalidInputException

parseParam

protected boolean parseParam()
                      throws InvalidInputException

Setzt außer Kraft:

parseParam in Klasse JavadocParser

Löst aus:

InvalidInputException

parseReference

protected boolean parseReference()
                          throws InvalidInputException

Setzt außer Kraft:

parseReference in Klasse AbstractCommentParser

Löst aus:

InvalidInputException

parseReference

protected boolean parseReference(boolean allowModule)
                          throws InvalidInputException

Setzt außer Kraft:

parseReference in Klasse AbstractCommentParser

Löst aus:

InvalidInputException

parseTag

protected boolean parseTag(int previousPosition)
                    throws InvalidInputException

Setzt außer Kraft:

parseTag in Klasse JavadocParser

Löst aus:

InvalidInputException

parseSnippet

protected boolean parseSnippet()
                        throws InvalidInputException

Setzt außer Kraft:

parseSnippet in Klasse AbstractCommentParser

Löst aus:

InvalidInputException

lookForTagsInSnippets

protected boolean lookForTagsInSnippets()

Setzt außer Kraft:

lookForTagsInSnippets in Klasse AbstractCommentParser

parseThrows

protected boolean parseThrows()

Setzt außer Kraft:

parseThrows in Klasse JavadocParser

pushParamName

protected boolean pushParamName(boolean isTypeParam)

Setzt außer Kraft:

pushParamName in Klasse JavadocParser

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.

Setzt außer Kraft:

pushText in Klasse JavadocParser

Siehe auch:

• AbstractCommentParser.pushText(int, int)

readToken

protected int readToken()
                 throws InvalidInputException

Setzt außer Kraft:

readToken in Klasse AbstractCommentParser

Löst aus:

InvalidInputException

syntaxRecoverQualifiedName

protected Object syntaxRecoverQualifiedName(int primitiveToken)
                                     throws InvalidInputException

Setzt außer Kraft:

syntaxRecoverQualifiedName in Klasse AbstractCommentParser

Löst aus:

InvalidInputException

syntaxRecoverArgumentType

protected Object syntaxRecoverArgumentType(Object receiver,
 List arguments,
 Object argument)
                                    throws InvalidInputException

Löst aus:

InvalidInputException

syntaxRecoverEmptyArgumentType

protected Object syntaxRecoverEmptyArgumentType(Object methodRef)
                                         throws InvalidInputException

Löst aus:

InvalidInputException

updateDocComment

protected void updateDocComment()

Setzt außer Kraft:

updateDocComment in Klasse JavadocParser

verifySpaceOrEndComment

protected boolean verifySpaceOrEndComment()

Setzt außer Kraft:

verifySpaceOrEndComment in Klasse AbstractCommentParser