Package com.intellij.codeInsight.completion

Class CompletionService

java.lang.Object

com.intellij.codeInsight.completion.CompletionService

public abstract class CompletionService
extends java.lang.Object

For completion FAQ, see CompletionContributor.

Field Summary

Fields

Modifier and Type	Field and Description
static Key<CompletionWeigher>	RELEVANCE_KEY A "weigher" extension key (see Weigher) to sort completion items by priority and move the heaviest to the top of the Lookup.
static Key<CompletionStatistician>	STATISTICS_KEY

Constructor Summary

Constructors

Constructor and Description
CompletionService()

Method Summary

Modifier and Type	Method and Description
protected abstract PrefixMatcher	createMatcher(java.lang.String prefix, boolean typoTolerant)
protected abstract CompletionResultSet	createResultSet(CompletionParameters parameters, Consumer<? super CompletionResult> consumer, CompletionContributor contributor, PrefixMatcher matcher)
abstract CompletionSorter	defaultSorter(CompletionParameters parameters, PrefixMatcher matcher)
abstract CompletionSorter	emptySorter()
static CompletionService	getCompletionService()
abstract CompletionProcess	getCurrentCompletion()
static PrefixMatcher	getItemMatcher(LookupElement element, WeighingContext context)
void	getVariantsFromContributors(CompletionParameters parameters, CompletionContributor from, Consumer<? super CompletionResult> consumer) Run all contributors until any of them returns false or the list is exhausted.
protected void	getVariantsFromContributors(CompletionParameters parameters, CompletionContributor from, PrefixMatcher matcher, Consumer<? super CompletionResult> consumer)
protected void	getVariantsFromContributors(CompletionParameters parameters, CompletionContributor from, PrefixMatcher matcher, Consumer<? super CompletionResult> consumer, CompletionSorter customSorter)
static boolean	isStartMatch(LookupElement element, WeighingContext context)
void	performCompletion(CompletionParameters parameters, Consumer<? super CompletionResult> consumer) The main method that is invoked to collect all the completion variants
abstract void	setAdvertisementText(java.lang.String text) Deprecated. use CompletionResultSet.addLookupAdvertisement(String)
protected abstract java.lang.String	suggestPrefix(CompletionParameters parameters)

Methods inherited from class java.lang.Object

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

Field Detail

STATISTICS_KEY

public static final Key<CompletionStatistician> STATISTICS_KEY

RELEVANCE_KEY

public static final Key<CompletionWeigher> RELEVANCE_KEY

A "weigher" extension key (see Weigher) to sort completion items by priority and move the heaviest to the top of the Lookup.

Constructor Detail

CompletionService

public CompletionService()

Method Detail

getCompletionService

public static CompletionService getCompletionService()

setAdvertisementText

@Deprecated
public abstract void setAdvertisementText(java.lang.String text)

Deprecated. use CompletionResultSet.addLookupAdvertisement(String)

Set lookup advertisement text (at the bottom) at any time. Will do nothing if no completion process is in progress.

Parameters:

text -

getVariantsFromContributors

public void getVariantsFromContributors(CompletionParameters parameters,
                                        CompletionContributor from,
                                        Consumer<? super CompletionResult> consumer)

Run all contributors until any of them returns false or the list is exhausted. If from parameter is not null, contributors will be run starting from the next one after that.

getVariantsFromContributors

protected void getVariantsFromContributors(CompletionParameters parameters,
                                           CompletionContributor from,
                                           PrefixMatcher matcher,
                                           Consumer<? super CompletionResult> consumer)

getVariantsFromContributors

protected void getVariantsFromContributors(CompletionParameters parameters,
                                           CompletionContributor from,
                                           PrefixMatcher matcher,
                                           Consumer<? super CompletionResult> consumer,
                                           CompletionSorter customSorter)

createResultSet

protected abstract CompletionResultSet createResultSet(CompletionParameters parameters,
                                                       Consumer<? super CompletionResult> consumer,
                                                       CompletionContributor contributor,
                                                       PrefixMatcher matcher)

suggestPrefix

protected abstract java.lang.String suggestPrefix(CompletionParameters parameters)

createMatcher

protected abstract PrefixMatcher createMatcher(java.lang.String prefix,
                                               boolean typoTolerant)

getCurrentCompletion

public abstract CompletionProcess getCurrentCompletion()

performCompletion

public void performCompletion(CompletionParameters parameters,
                              Consumer<? super CompletionResult> consumer)

The main method that is invoked to collect all the completion variants

Parameters:

parameters - Parameters specifying current completion environment

consumer - The consumer of the completion variants. Pass an instance of BatchConsumer if you need to receive information about item batches generated by each completion contributor.

defaultSorter

public abstract CompletionSorter defaultSorter(CompletionParameters parameters,
                                               PrefixMatcher matcher)

emptySorter

public abstract CompletionSorter emptySorter()

isStartMatch

public static boolean isStartMatch(LookupElement element,
                                   WeighingContext context)

getItemMatcher

public static PrefixMatcher getItemMatcher(LookupElement element,
                                           WeighingContext context)