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

Class InternalCompletionProposal

java.lang.Object
org.aspectj.org.eclipse.jdt.core.CompletionProposal
org.aspectj.org.eclipse.jdt.internal.codeassist.InternalCompletionProposal
public class InternalCompletionProposal extends CompletionProposal
Internal completion proposal
Since:
3.1

  • Field Details

    • completionEngine

      protected CompletionEngine completionEngine

    • nameLookup

      protected NameLookup nameLookup

    • declarationPackageName

      protected char[] declarationPackageName

    • declarationTypeName

      protected char[] declarationTypeName

    • moduleName

      protected char[] moduleName

    • packageName

      protected char[] packageName

    • typeName

      protected char[] typeName

    • parameterPackageNames

      protected char[][] parameterPackageNames

    • parameterTypeNames

      protected char[][] parameterTypeNames

    • originalSignature

      protected char[] originalSignature

    • accessibility

      protected int accessibility

    • isConstructor

      protected boolean isConstructor

  • Constructor Details

    • InternalCompletionProposal

      public InternalCompletionProposal​(int kind, int completionLocation)
      Creates a basic completion proposal. All instance field have plausible default values unless otherwise noted.

      Note that the constructors for this class are internal to the Java model implementation. Clients cannot directly create CompletionProposal objects.

      Parameters:
      kind - one of the kind constants declared on this class
      completionLocation - original offset of code completion request

  • Method Details

    • findConstructorParameterNames

      protected char[][] findConstructorParameterNames​(char[] declaringTypePackageName, char[] declaringTypeName, char[] selector, char[][] paramTypeNames)

    • findMethodParameterNames

      protected char[][] findMethodParameterNames​(char[] declaringTypePackageName, char[] declaringTypeName, char[] selector, char[][] paramTypeNames)

    • getDeclarationPackageName

      protected char[] getDeclarationPackageName()

    • getDeclarationTypeName

      protected char[] getDeclarationTypeName()

    • getModuleName

      protected char[] getModuleName()

    • getPackageName

      protected char[] getPackageName()

    • getTypeName

      protected char[] getTypeName()

    • getParameterPackageNames

      protected char[][] getParameterPackageNames()

    • getParameterTypeNames

      protected char[][] getParameterTypeNames()

    • setDeclarationPackageName

      protected void setDeclarationPackageName​(char[] declarationPackageName)

    • setDeclarationTypeName

      protected void setDeclarationTypeName​(char[] declarationTypeName)

    • setModuleName

      protected void setModuleName​(char[] moduleName)

    • setPackageName

      protected void setPackageName​(char[] packageName)

    • setTypeName

      protected void setTypeName​(char[] typeName)

    • setParameterPackageNames

      protected void setParameterPackageNames​(char[][] parameterPackageNames)

    • setParameterTypeNames

      protected void setParameterTypeNames​(char[][] parameterTypeNames)

    • setAccessibility

      protected void setAccessibility​(int kind)

    • setIsContructor

      protected void setIsContructor​(boolean isConstructor)

    • setOriginalSignature

      public void setOriginalSignature​(char[] originalSignature)

    • getAdditionalFlags

      public int getAdditionalFlags()
      Description copied from class: CompletionProposal
      Returns the completion flags relevant in the context, or CompletionFlags.Default if none.

      This field is available for the following kinds of completion proposals:

      • FIELD_IMPORT - completion flags of the attribute that is referenced. Completion flags for this proposal kind can only include CompletionFlags.StaticImport
      • METHOD_IMPORT - completion flags of the attribute that is referenced. Completion flags for this proposal kind can only include CompletionFlags.StaticImport
      • TYPE_IMPORT - completion flags of the attribute that is referenced. Completion flags for this proposal kind can only include CompletionFlags.StaticImport
      For other kinds of completion proposals, this method returns CompletionFlags.Default.
      Overrides:
      getAdditionalFlags in class CompletionProposal
      Returns:
      the completion flags, or CompletionFlags.Default if none
      See Also:
      CompletionFlags

    • setAdditionalFlags

      public void setAdditionalFlags​(int additionalFlags)
      Description copied from class: CompletionProposal
      Sets the completion flags relevant in the context.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setAdditionalFlags in class CompletionProposal
      Parameters:
      additionalFlags - the completion flags, or CompletionFlags.Default if none

    • getKind

      public int getKind()
      Description copied from class: CompletionProposal
      Returns the kind of completion being proposed.

      The set of different kinds of completion proposals is expected to change over time. It is strongly recommended that clients do not assume that the kind is one of the ones they know about, and code defensively for the possibility of unexpected future growth.

      Overrides:
      getKind in class CompletionProposal
      Returns:
      the kind; one of the kind constants declared on this class, or possibly a kind unknown to the caller

    • getCompletionLocation

      public int getCompletionLocation()
      Description copied from class: CompletionProposal
      Returns the character index in the source file buffer where source completion was requested (the offset parameter to ICodeAssist.codeComplete minus one).
      Overrides:
      getCompletionLocation in class CompletionProposal
      Returns:
      character index in source file buffer
      See Also:
      ICodeAssist.codeComplete(int,CompletionRequestor)

    • getTokenStart

      public int getTokenStart()
      Description copied from class: CompletionProposal
      Returns the character index of the start of the subrange in the source file buffer containing the relevant token being completed. This token is either the identifier or Java language keyword under, or immediately preceding, the original request offset. If the original request offset is not within or immediately after an identifier or keyword, then the position returned is original request offset and the token range is empty.
      Overrides:
      getTokenStart in class CompletionProposal
      Returns:
      character index of token start position (inclusive)

    • getTokenEnd

      public int getTokenEnd()
      Description copied from class: CompletionProposal
      Returns the character index of the end (exclusive) of the subrange in the source file buffer containing the relevant token. When there is no relevant token, the range is empty (getEndToken() == getStartToken()).
      Overrides:
      getTokenEnd in class CompletionProposal
      Returns:
      character index of token end position (exclusive)

    • setTokenRange

      public void setTokenRange​(int startIndex, int endIndex)
      Description copied from class: CompletionProposal
      Sets the character indices of the subrange in the source file buffer containing the relevant token being completed. This token is either the identifier or Java language keyword under, or immediately preceding, the original request offset. If the original request offset is not within or immediately after an identifier or keyword, then the source range begins at original request offset and is empty.

      If not set, defaults to empty subrange at [0,0).

      Overrides:
      setTokenRange in class CompletionProposal
      Parameters:
      startIndex - character index of token start position (inclusive)
      endIndex - character index of token end position (exclusive)

    • getCompletion

      public char[] getCompletion()
      Description copied from class: CompletionProposal
      Returns the proposed sequence of characters to insert into the source file buffer, replacing the characters at the specified source range. The string can be arbitrary; for example, it might include not only the name of a method but a set of parentheses.

      The client must not modify the array returned.

      Overrides:
      getCompletion in class CompletionProposal
      Returns:
      the completion string

    • setCompletion

      public void setCompletion​(char[] completion)
      Description copied from class: CompletionProposal
      Sets the proposed sequence of characters to insert into the source file buffer, replacing the characters at the specified source range. The string can be arbitrary; for example, it might include not only the name of a method but a set of parentheses.

      If not set, defaults to an empty character array.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setCompletion in class CompletionProposal
      Parameters:
      completion - the completion string

    • getReplaceStart

      public int getReplaceStart()
      Description copied from class: CompletionProposal
      Returns the character index of the start of the subrange in the source file buffer to be replaced by the completion string. If the subrange is empty (getReplaceEnd() == getReplaceStart()), the completion string is to be inserted at this index.

      Note that while the token subrange is precisely specified, the replacement range is loosely constrained and may not bear any direct relation to the original request offset. For example, it would be possible for a type completion to propose inserting an import declaration at the top of the compilation unit; or the completion might include trailing parentheses and punctuation for a method completion.

      Overrides:
      getReplaceStart in class CompletionProposal
      Returns:
      replacement start position (inclusive)

    • getReplaceEnd

      public int getReplaceEnd()
      Description copied from class: CompletionProposal
      Returns the character index of the end of the subrange in the source file buffer to be replaced by the completion string. If the subrange is empty (getReplaceEnd() == getReplaceStart()), the completion string is to be inserted at this index.
      Overrides:
      getReplaceEnd in class CompletionProposal
      Returns:
      replacement end position (exclusive)

    • setReplaceRange

      public void setReplaceRange​(int startIndex, int endIndex)
      Description copied from class: CompletionProposal
      Sets the character indices of the subrange in the source file buffer to be replaced by the completion string. If the subrange is empty (startIndex == endIndex), the completion string is to be inserted at this index.

      If not set, defaults to empty subrange at [0,0).

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setReplaceRange in class CompletionProposal
      Parameters:
      startIndex - character index of replacement start position (inclusive)
      endIndex - character index of replacement end position (exclusive)

    • getRelevance

      public int getRelevance()
      Description copied from class: CompletionProposal
      Returns the relative relevance rating of this proposal.
      Overrides:
      getRelevance in class CompletionProposal
      Returns:
      relevance rating of this proposal; ratings are positive; higher means better

    • setRelevance

      public void setRelevance​(int rating)
      Description copied from class: CompletionProposal
      Sets the relative relevance rating of this proposal.

      If not set, defaults to the lowest possible rating (1).

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setRelevance in class CompletionProposal
      Parameters:
      rating - relevance rating of this proposal; ratings are positive; higher means better

    • getDeclarationSignature

      public char[] getDeclarationSignature()
      Description copied from class: CompletionProposal
      Returns the type signature or package name or module name (9) of the relevant declaration in the context, or null if none.

      This field is available for the following kinds of completion proposals:

      • ANNOTATION_ATTRIBUT_REF - type signature of the annotation that declares the attribute that is referenced
      • ANONYMOUS_CLASS_DECLARATION - type signature of the type that is being subclassed or implemented
      • FIELD_IMPORT - type signature of the type that declares the field that is imported
      • FIELD_REF - type signature of the type that declares the field that is referenced
      • FIELD_REF_WITH_CASTED_RECEIVER - type signature of the type that declares the field that is referenced
      • METHOD_IMPORT - type signature of the type that declares the method that is imported
      • METHOD_REF - type signature of the type that declares the method that is referenced
      • METHOD_REF_WITH_CASTED_RECEIVER - type signature of the type that declares the method that is referenced
      • METHOD_DECLARATION - type signature of the type that declares the method that is being implemented or overridden
      • MODULE_DECLARATION - possible name of the module that is being declared
      • MODULE_REF - name of the module that is referenced
      • PACKAGE_REF - dot-based package name of the package that is referenced
      • TYPE_IMPORT - dot-based package name of the package containing the type that is imported
      • TYPE_REF - dot-based package name of the package containing the type that is referenced
      • POTENTIAL_METHOD_DECLARATION - type signature of the type that declares the method that is being created
      For kinds of completion proposals, this method returns null. Clients must not modify the array returned.
      Overrides:
      getDeclarationSignature in class CompletionProposal
      Returns:
      a type signature or a package name or module name (9) (depending on the kind of completion), or null if none
      See Also:
      Signature

    • getDeclarationKey

      public char[] getDeclarationKey()
      Description copied from class: CompletionProposal
      Returns the key of the relevant declaration in the context, or null if none.

      This field is available for the following kinds of completion proposals:

      • ANONYMOUS_CLASS_DECLARATION - key of the type that is being subclassed or implemented
      • METHOD_DECLARATION - key of the type that declares the method that is being implemented or overridden
      For kinds of completion proposals, this method returns null. Clients must not modify the array returned.
      Overrides:
      getDeclarationKey in class CompletionProposal
      Returns:
      a key, or null if none
      See Also:
      ASTParser.createASTs(ICompilationUnit[], String[], org.aspectj.org.eclipse.jdt.core.dom.ASTRequestor, IProgressMonitor)

    • setDeclarationSignature

      public void setDeclarationSignature​(char[] signature)
      Description copied from class: CompletionProposal
      Sets the type or package signature or module name (9) of the relevant declaration in the context, or null if none.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setDeclarationSignature in class CompletionProposal
      Parameters:
      signature - the type or package signature or module name(9) , or null if none

    • setDeclarationKey

      public void setDeclarationKey​(char[] key)
      Description copied from class: CompletionProposal
      Sets the type or package key of the relevant declaration in the context, or null if none.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setDeclarationKey in class CompletionProposal
      Parameters:
      key - the type or package key, or null if none

    • getName

      public char[] getName()
      Description copied from class: CompletionProposal
      Returns the simple name of the method, field, member, or variable relevant in the context, or null if none.

      This field is available for the following kinds of completion proposals:

      • ANNOTATION_ATTRIBUT_REF - the name of the attribute
      • FIELD_IMPORT - the name of the field
      • FIELD_REF - the name of the field
      • FIELD_REF_WITH_CASTED_RECEIVER - the name of the field
      • KEYWORD - the keyword
      • LABEL_REF - the name of the label
      • LOCAL_VARIABLE_REF - the name of the local variable
      • METHOD_IMPORT - the name of the method
      • METHOD_REF - the name of the method (the type simple name for constructor)
      • METHOD_REF_WITH_CASTED_RECEIVER - the name of the method
      • METHOD_DECLARATION - the name of the method (the type simple name for constructor)
      • VARIABLE_DECLARATION - the name of the variable
      • POTENTIAL_METHOD_DECLARATION - the name of the method
      For kinds of completion proposals, this method returns null. Clients must not modify the array returned.
      Overrides:
      getName in class CompletionProposal
      Returns:
      the keyword, field, method, local variable, or member name, or null if none

    • setName

      public void setName​(char[] name)
      Description copied from class: CompletionProposal
      Sets the simple name of the method (type simple name for constructor), field, member, or variable relevant in the context, or null if none.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setName in class CompletionProposal
      Parameters:
      name - the keyword, field, method, local variable, or member name, or null if none

    • getBinding

      public Binding getBinding()
      Returns a binding of the method or field corresponding to this proposal or null if none.

      The binding may be available for the following kinds of completion proposals:

      • ANONYMOUS_CLASS_CONSTRUCTOR_INVOCATION - MethodBinding of the constructor being proposed
      • CONSTRUCTOR_INVOCATION - MethodBinding of the constructor being proposed
      • FIELD_REF - FieldBinding of the field being proposed
      • FIELD_REF_WITH_CASTED_RECEIVER - FieldBinding of the field being proposed
      • JAVADOC_FIELD_REF - FieldBinding of the field being proposed
      • JAVADOC_METHOD_REF - MethodBinding of the method or constructor being proposed
      • METHOD_DECLARATION - MethodBinding of the method or constructor being proposed
      • METHOD_NAME_REFERENCE - MethodBinding of the method or constructor being proposed
      • METHOD_REF - MethodBinding of the method or constructor being proposed
      • METHOD_REF_WITH_CASTED_RECEIVER - MethodBinding of the method or constructor being proposed
      For other kinds of completion proposals, this method returns null.

      Returns:
      the binding corresponding to this proposal (if available), or null if none

    • setBinding

      public void setBinding​(Binding binding)

    • getSignature

      public char[] getSignature()
      Description copied from class: CompletionProposal
      Returns the signature of the method or type relevant in the context, or null if none.

      This field is available for the following kinds of completion proposals:

      • ANNOTATION_ATTRIBUT_REF - the type signature of the referenced attribute's type
      • ANONYMOUS_CLASS_DECLARATION - method signature of the constructor that is being invoked
      • FIELD_IMPORT - the type signature of the referenced field's type
      • FIELD_REF - the type signature of the referenced field's type
      • FIELD_REF_WITH_CASTED_RECEIVER - the type signature of the referenced field's type
      • LOCAL_VARIABLE_REF - the type signature of the referenced local variable's type
      • METHOD_IMPORT - method signature of the method that is imported
      • METHOD_REF - method signature of the method that is referenced
      • METHOD_REF_WITH_CASTED_RECEIVER - method signature of the method that is referenced
      • METHOD_DECLARATION - method signature of the method that is being implemented or overridden
      • TYPE_IMPORT - type signature of the type that is imported
      • TYPE_REF - type signature of the type that is referenced
      • VARIABLE_DECLARATION - the type signature of the type of the variable being declared
      • POTENTIAL_METHOD_DECLARATION - method signature of the method that is being created
      For kinds of completion proposals, this method returns null. Clients must not modify the array returned.
      Overrides:
      getSignature in class CompletionProposal
      Returns:
      the signature, or null if none
      See Also:
      Signature

    • getKey

      public char[] getKey()
      Description copied from class: CompletionProposal
      Returns the key relevant in the context, or null if none.

      This field is available for the following kinds of completion proposals:

      • ANONYMOUS_CLASS_DECLARATION - method key of the constructor that is being invoked, or null if the declaring type is an interface
      • METHOD_DECLARATION - method key of the method that is being implemented or overridden
      For kinds of completion proposals, this method returns null. Clients must not modify the array returned.
      Overrides:
      getKey in class CompletionProposal
      Returns:
      the key, or null if none
      See Also:
      ASTParser.createASTs(ICompilationUnit[], String[], org.aspectj.org.eclipse.jdt.core.dom.ASTRequestor, IProgressMonitor)

    • setSignature

      public void setSignature​(char[] signature)
      Description copied from class: CompletionProposal
      Sets the signature of the method, field type, member type, relevant in the context, or null if none.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setSignature in class CompletionProposal
      Parameters:
      signature - the signature, or null if none

    • setKey

      public void setKey​(char[] key)
      Description copied from class: CompletionProposal
      Sets the key of the method, field type, member type, relevant in the context, or null if none.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setKey in class CompletionProposal
      Parameters:
      key - the key, or null if none

    • getFlags

      public int getFlags()
      Description copied from class: CompletionProposal
      Returns the modifier flags relevant in the context, or Flags.AccDefault if none.

      This field is available for the following kinds of completion proposals:

      • ANNOTATION_ATTRIBUT_REF - modifier flags of the attribute that is referenced;
      • ANONYMOUS_CLASS_DECLARATION - modifier flags of the constructor that is referenced
      • FIELD_IMPORT - modifier flags of the field that is imported.
      • FIELD_REF - modifier flags of the field that is referenced; Flags.AccEnum can be used to recognize references to enum constants
      • FIELD_REF_WITH_CASTED_RECEIVER - modifier flags of the field that is referenced.
      • KEYWORD - modifier flag corresponding to the modifier keyword
      • LOCAL_VARIABLE_REF - modifier flags of the local variable that is referenced
      • METHOD_IMPORT - modifier flags of the method that is imported;
      • METHOD_REF - modifier flags of the method that is referenced; Flags.AccAnnotation can be used to recognize references to annotation type members
      • METHOD_REF_WITH_CASTED_RECEIVER - modifier flags of the method that is referenced.
      • METHOD_DECLARATION - modifier flags for the method that is being implemented or overridden
      • TYPE_IMPORT - modifier flags of the type that is imported; Flags.AccInterface can be used to recognize references to interfaces, Flags.AccEnum enum types, and Flags.AccAnnotation annotation types
      • TYPE_REF - modifier flags of the type that is referenced; Flags.AccInterface can be used to recognize references to interfaces, Flags.AccEnum enum types, and Flags.AccAnnotation annotation types
      • VARIABLE_DECLARATION - modifier flags for the variable being declared
      • POTENTIAL_METHOD_DECLARATION - modifier flags for the method that is being created
      For other kinds of completion proposals, this method returns Flags.AccDefault.
      Overrides:
      getFlags in class CompletionProposal
      Returns:
      the modifier flags, or Flags.AccDefault if none
      See Also:
      Flags

    • setFlags

      public void setFlags​(int flags)
      Description copied from class: CompletionProposal
      Sets the modifier flags relevant in the context.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setFlags in class CompletionProposal
      Parameters:
      flags - the modifier flags, or Flags.AccDefault if none

    • setHasNoParameterNamesFromIndex

      public void setHasNoParameterNamesFromIndex​(boolean hasNoParameterNamesFromIndex)

    • getRequiredProposals

      public CompletionProposal[] getRequiredProposals()
      Description copied from class: CompletionProposal
      Returns the required completion proposals. The proposal can be apply only if these required completion proposals are also applied. If the required proposal aren't applied the completion could create completion problems.

      This field is available for the following kinds of completion proposals:

      • FIELD_REF - The allowed required proposals for this kind are:
        • TYPE_REF
        • TYPE_IMPORT
        • FIELD_IMPORT
      • METHOD_REF - The allowed required proposals for this kind are:
        • TYPE_REF
        • TYPE_IMPORT
        • METHOD_IMPORT
      • TYPE_REF - The allowed required proposals for this kind are:
        • TYPE_REF
      • CONSTRUCTOR_INVOCATION - The allowed required proposals for this kind are:
        • TYPE_REF
      • ANONYMOUS_CLASS_CONSTRUCTOR_INVOCATION - The allowed required proposals for this kind are:
        • TYPE_REF
      • ANONYMOUS_CLASS_DECLARATION - The allowed required proposals for this kind are:
        • TYPE_REF

      Other kinds of required proposals will be returned in the future, therefore clients of this API must allow with CompletionRequestor.setAllowsRequiredProposals(int, int, boolean) only kinds which are in this list to avoid unexpected results in the future.

      A required proposal of a given kind is proposed even if CompletionRequestor.isIgnored(int) return true for that kind.

      A required completion proposal cannot have required completion proposals.

      Overrides:
      getRequiredProposals in class CompletionProposal
      Returns:
      the required completion proposals, or null if none.
      See Also:
      CompletionRequestor.setAllowsRequiredProposals(int, int,boolean)

    • setRequiredProposals

      public void setRequiredProposals​(CompletionProposal[] proposals)
      Description copied from class: CompletionProposal
      Sets the list of required completion proposals, or null if none.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setRequiredProposals in class CompletionProposal
      Parameters:
      proposals - the list of required completion proposals, or null if none

    • findParameterNames

      public char[][] findParameterNames​(org.eclipse.core.runtime.IProgressMonitor monitor)
      Description copied from class: CompletionProposal
      Finds the method parameter names. This information is relevant to method reference (and method declaration proposals). Returns null if not available or not relevant.

      The client must not modify the array returned.

      Note that this is an expensive thing to compute, which may require parsing Java source files, etc. Use sparingly.

      Overrides:
      findParameterNames in class CompletionProposal
      Parameters:
      monitor - the progress monitor, or null if none
      Returns:
      the parameter names, or null if none or not available or not relevant

    • setParameterNames

      public void setParameterNames​(char[][] parameterNames)
      Description copied from class: CompletionProposal
      Sets the method parameter names. This information is relevant to method reference (and method declaration proposals).

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setParameterNames in class CompletionProposal
      Parameters:
      parameterNames - the parameter names, or null if none

    • getAccessibility

      public int getAccessibility()
      Description copied from class: CompletionProposal
      Returns the accessibility of the proposal.

      This field is available for the following kinds of completion proposals:

      • TYPE_REF - accessibility of the type
      For these kinds of completion proposals, this method returns IAccessRule.K_ACCESSIBLE or IAccessRule.K_DISCOURAGED or IAccessRule.K_NON_ACCESSIBLE. By default this method return IAccessRule.K_ACCESSIBLE.
      Overrides:
      getAccessibility in class CompletionProposal
      Returns:
      the accessibility of the proposal
      See Also:
      IAccessRule

    • isConstructor

      public boolean isConstructor()
      Description copied from class: CompletionProposal
      Returns whether this proposal is a constructor.

      This field is available for the following kinds of completion proposals:

      • METHOD_REF - return true if the referenced method is a constructor
      • METHOD_DECLARATION - return true if the declared method is a constructor
      For kinds of completion proposals, this method returns false.
      Overrides:
      isConstructor in class CompletionProposal
      Returns:
      true if the proposal is a constructor.

    • getReceiverSignature

      public char[] getReceiverSignature()
      Description copied from class: CompletionProposal
      Returns the type signature or package name of the relevant receiver in the context, or null if none.

      This field is available for the following kinds of completion proposals:

      • FIELD_REF_WITH_CASTED_RECEIVER - type signature of the type that cast the receiver of the field that is referenced
      • METHOD_REF_WITH_CASTED_RECEIVER - type signature of the type that cast the receiver of the method that is referenced
      For kinds of completion proposals, this method returns null. Clients must not modify the array returned.
      Overrides:
      getReceiverSignature in class CompletionProposal
      Returns:
      a type signature or a package name (depending on the kind of completion), or null if none
      See Also:
      Signature

    • getReceiverStart

      public int getReceiverStart()
      Description copied from class: CompletionProposal
      Returns the character index of the start of the subrange in the source file buffer containing the relevant receiver of the member being completed. This receiver is an expression.

      This field is available for the following kinds of completion proposals:

      • FIELD_REF_WITH_CASTED_RECEIVER
      • METHOD_REF_WITH_CASTED_RECEIVER
      For kinds of completion proposals, this method returns 0.
      Overrides:
      getReceiverStart in class CompletionProposal
      Returns:
      character index of receiver start position (inclusive)

    • getReceiverEnd

      public int getReceiverEnd()
      Description copied from class: CompletionProposal
      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. *

      This field is available for the following kinds of completion proposals:

      • FIELD_REF_WITH_CASTED_RECEIVER
      • METHOD_REF_WITH_CASTED_RECEIVER
      For kinds of completion proposals, this method returns 0.
      Overrides:
      getReceiverEnd in class CompletionProposal
      Returns:
      character index of receiver end position (exclusive)

    • setReceiverSignature

      public void setReceiverSignature​(char[] signature)
      Description copied from class: CompletionProposal
      Sets the type or package signature of the relevant receiver in the context, or null if none.

      If not set, defaults to none.

      The completion engine creates instances of this class and sets its properties; this method is not intended to be used by other clients.

      Overrides:
      setReceiverSignature in class CompletionProposal
      Parameters:
      signature - the type or package signature, or null if none

    • setReceiverRange

      public void setReceiverRange​(int startIndex, int endIndex)
      Description copied from class: CompletionProposal
      Sets the character indices of the subrange in the source file buffer containing the relevant receiver of the member being completed.

      If not set, defaults to empty subrange at [0,0).

      Overrides:
      setReceiverRange in class CompletionProposal
      Parameters:
      startIndex - character index of receiver start position (inclusive)
      endIndex - character index of receiver end position (exclusive)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • canUseDiamond

      public boolean canUseDiamond​(CompletionContext coreContext)
      Description copied from class: CompletionProposal
      Returns whether it is safe to use the '<>' (diamond) operator in place of explicitly specifying type arguments for this proposal.

      This is only relevant for source level 1.7 or greater.

      Overrides:
      canUseDiamond in class CompletionProposal
      Parameters:
      coreContext - the completion context associated with the proposal
      Returns:
      true if it is safe to use the diamond operator for the constructor invocation, false otherwise. Also returns false for source levels below 1.7