CompletionProposal

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.core
Class CompletionProposal

java.lang.Object
  org.eclipse.jdt.internal.codeassist.InternalCompletionProposal
      org.eclipse.jdt.core.CompletionProposal

public final class CompletionProposal
extends InternalCompletionProposal
extends InternalCompletionProposal

Completion proposal.

In typical usage, the user working in a Java code editor issues a code assist command. This command results in a call to ICodeAssist.codeComplete(position, completionRequestor) passing the current position in the source code. The code assist engine analyzes the code in the buffer, determines what kind of Java language construct is at that position, and proposes ways to complete that construct. These proposals are instances of the class CompletionProposal. These proposals, perhaps after sorting and filtering, are presented to the user to make a choice.

The proposal is as follows: insert the completion string into the source file buffer, replacing the characters between the start and end. The string can be arbitrary; for example, it might include not only the name of a method but a set of parentheses. Moreover, the source range may include source positions before or after the source position where ICodeAssist.codeComplete was invoked. The rest of the information associated with the proposal is to provide context that may help a user to choose from among competing proposals.

The completion engine creates instances of this class.

Since:: 3.0
See Also:: ICodeAssist.codeComplete(int, CompletionRequestor)

Field Summary
`static int`	`ANNOTATION_ATTRIBUTE_REF` Completion is a reference to annotation's attribute.
`static int`	`ANONYMOUS_CLASS_DECLARATION` Completion is a declaration of an anonymous class.
`static int`	`FIELD_IMPORT` Completion is an import of reference to a static field.
`static int`	`FIELD_REF` Completion is a reference to a field.
`static int`	`FIELD_REF_WITH_CASTED_RECEIVER` Completion is a reference to a field with a casted receiver.
`static int`	`JAVADOC_BLOCK_TAG` Completion is a javadoc block tag.
`static int`	`JAVADOC_FIELD_REF` Completion is a link reference to a field in a javadoc text.
`static int`	`JAVADOC_INLINE_TAG` Completion is a javadoc inline tag.
`static int`	`JAVADOC_METHOD_REF` Completion is a link reference to a method in a javadoc text.
`static int`	`JAVADOC_PARAM_REF` Completion is a method argument or a class/method type parameter in javadoc param tag.
`static int`	`JAVADOC_TYPE_REF` Completion is a link reference to a type in a javadoc text.
`static int`	`JAVADOC_VALUE_REF` Completion is a value reference to a static field in a javadoc text.
`static int`	`KEYWORD` Completion is a keyword.
`static int`	`LABEL_REF` Completion is a reference to a label.
`static int`	`LOCAL_VARIABLE_REF` Completion is a reference to a local variable.
`static int`	`METHOD_DECLARATION` Completion is a declaration of a method.
`static int`	`METHOD_IMPORT` Completion is an import of reference to a static method.
`static int`	`METHOD_NAME_REFERENCE` Completion is a reference to a method name.
`static int`	`METHOD_REF` Completion is a reference to a method.
`static int`	`METHOD_REF_WITH_CASTED_RECEIVER` Completion is a reference to a method with a casted receiver.
`static int`	`PACKAGE_REF` Completion is a reference to a package.
`static int`	`POTENTIAL_METHOD_DECLARATION` Completion is a declaration of a new potential method.
`static int`	`TYPE_IMPORT` Completion is an import of reference to a type.
`static int`	`TYPE_REF` Completion is a reference to a type.
`static int`	`VARIABLE_DECLARATION` Completion is a declaration of a variable (locals, parameters, fields, etc.).

Method Summary
`static CompletionProposal`	`create(int kind, int completionOffset)` Creates a basic completion proposal.
`char[][]`	`findParameterNames(org.eclipse.core.runtime.IProgressMonitor monitor)` Finds the method parameter names.
`int`	`getAccessibility()` Returns the accessibility of the proposal.
`int`	`getAdditionalFlags()` Returns the completion flags relevant in the context, or `CompletionFlags.Default` if none.
`char[]`	`getCompletion()` Returns the proposed sequence of characters to insert into the source file buffer, replacing the characters at the specified source range.
`int`	`getCompletionLocation()` Returns the character index in the source file buffer where source completion was requested (the `offset` parameter to `ICodeAssist.codeComplete` minus one).
`char[]`	`getDeclarationKey()` Returns the key of the relevant declaration in the context, or `null` if none.
`char[]`	`getDeclarationSignature()` Returns the type signature or package name of the relevant declaration in the context, or `null` if none.
`int`	`getFlags()` Returns the modifier flags relevant in the context, or `Flags.AccDefault` if none.
`char[]`	`getKey()` Returns the key relevant in the context, or `null` if none.
`int`	`getKind()` Returns the kind of completion being proposed.
`char[]`	`getName()` Returns the simple name of the method, field, member, or variable relevant in the context, or `null` if none.
`int`	`getReceiverEnd()` Returns the character index of the end (exclusive) of the subrange in the source file buffer containing the relevant receiver of the member being completed.
`char[]`	`getReceiverSignature()` Returns the type signature or package name of the relevant receiver in the context, or `null` if none.
`int`	`getReceiverStart()` Returns the character index of the start of the subrange in the source file buffer containing the relevant receiver of the member being completed.
`int`	`getRelevance()` Returns the relative relevance rating of this proposal.
`int`	`getReplaceEnd()` Returns the character index of the end of the subrange in the source file buffer to be replaced by the completion string.
`int`	`getReplaceStart()` Returns the character index of the start of the subrange in the source file buffer to be replaced by the completion string.
`CompletionProposal[]`	`getRequiredProposals()` Returns the required completion proposals.
`char[]`	`getSignature()` Returns the signature of the method or type relevant in the context, or `null` if none.
`int`	`getTokenEnd()` Returns the character index of the end (exclusive) of the subrange in the source file buffer containing the relevant token.
`int`	`getTokenStart()` Returns the character index of the start of the subrange in the source file buffer containing the relevant token being completed.
`boolean`	`isConstructor()` Returns whether this proposal is a constructor.
`void`	`setAdditionalFlags(int additionalFlags)` Sets the completion flags relevant in the context.
`void`	`setCompletion(char[] completion)` Sets the proposed sequence of characters to insert into the source file buffer, replacing the characters at the specified source range.
`void`	`setDeclarationKey(char[] key)` Sets the type or package key of the relevant declaration in the context, or `null` if none.
`void`	`setDeclarationSignature(char[] signature)` Sets the type or package signature of the relevant declaration in the context, or `null` if none.
`void`	`setFlags(int flags)` Sets the modifier flags relevant in the context.
`void`	`setKey(char[] key)` Sets the key of the method, field type, member type, relevant in the context, or `null` if none.
`void`	`setName(char[] name)` Sets the simple name of the method (type simple name for constructor), field, member, or variable relevant in the context, or `null` if none.
`void`	`setParameterNames(char[][] parameterNames)` Sets the method parameter names.
`void`	`setReceiverRange(int startIndex, int endIndex)` Sets the character indices of the subrange in the source file buffer containing the relevant receiver of the member being completed.
`void`	`setReceiverSignature(char[] signature)` Sets the type or package signature of the relevant receiver in the context, or `null` if none.
`void`	`setRelevance(int rating)` Sets the relative relevance rating of this proposal.
`void`	`setReplaceRange(int startIndex, int endIndex)` Sets the character indices of the subrange in the source file buffer to be replaced by the completion string.
`void`	`setRequiredProposals(CompletionProposal[] proposals)` Sets the list of required completion proposals, or `null` if none.
`void`	`setSignature(char[] signature)` Sets the signature of the method, field type, member type, relevant in the context, or `null` if none.
`void`	`setTokenRange(int startIndex, int endIndex)` Sets the character indices of the subrange in the source file buffer containing the relevant token being completed.
`java.lang.String`	`toString()`

Methods inherited from class org.eclipse.jdt.internal.codeassist.InternalCompletionProposal
`setOriginalSignature`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

ANONYMOUS_CLASS_DECLARATION

public static final int ANONYMOUS_CLASS_DECLARATION

Completion is a declaration of an anonymous class. This kind of completion might occur in a context like "new List^;" and complete it to "new List() {}".