Package com.intellij.codeInsight.completion

Interface PlainTextSymbolCompletionContributor

All Known Implementing Classes:

JvmPlainTextSymbolCompletionContributor

public interface PlainTextSymbolCompletionContributor

A language-specific completion contributor which provides reasonable amount of symbols declared in given file (likely only top-level declarations). Such contributor could be used in plain text editors like VCS commit message field to help users referring to code symbols from the text.

See Also:

PlainTextSymbolCompletionContributorEP

Method Summary

Modifier and Type	Method and Description
java.util.Collection<LookupElement>	getLookupElements(PsiFile file, int invocationCount, java.lang.String prefix) Adds lookup elements from given file.

Method Detail

getLookupElements

java.util.Collection<LookupElement> getLookupElements(PsiFile file,
                                                      int invocationCount,
                                                      java.lang.String prefix)

Adds lookup elements from given file.

Parameters:

file - file to add elements from.

invocationCount - number of times the completion was invoked (see CompletionParameters.getInvocationCount()).

prefix - a prefix string. It's not required to return only matches starting with prefix, but this may be used to improve performance.

Returns:

a collection of LookupElement's to suggest.