Package com.intellij.codeInsight.completion

Class CompletionResultSet

java.lang.Object

com.intellij.codeInsight.completion.CompletionResultSet

All Implemented Interfaces:

Consumer<LookupElement>

public abstract class CompletionResultSet
extends java.lang.Object
implements Consumer<LookupElement>

CompletionResultSets feed on LookupElements, match them against specified PrefixMatcher and give them to special Consumer for further processing, which usually means they will sooner or later appear in completion list. If they don't, there must be some CompletionContributor up the invocation stack that filters them out. If you want to change the matching prefix, use withPrefixMatcher(PrefixMatcher) or withPrefixMatcher(String) to obtain another CompletionResultSet and give your lookup elements to that one.

Field Summary

Fields

Modifier and Type	Field and Description
protected CompletionService	myCompletionService
protected CompletionContributor	myContributor

Fields inherited from interface com.intellij.util.Consumer

EMPTY_CONSUMER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompletionResultSet(PrefixMatcher prefixMatcher, Consumer<? super CompletionResult> consumer, CompletionContributor contributor)

Method Summary

Modifier and Type	Method and Description
void	addAllElements(java.lang.Iterable<? extends LookupElement> elements) Adds all elements from the given collection that match the prefix for further processing.
abstract void	addElement(LookupElement element) If a given element matches the prefix, give it for further processing (which may eventually result in its appearing in the completion list).
abstract void	addLookupAdvertisement(java.lang.String text)
abstract CompletionResultSet	caseInsensitive()
void	consume(LookupElement element)
void	endBatch()
protected Consumer<? super CompletionResult>	getConsumer()
PrefixMatcher	getPrefixMatcher()
boolean	isStopped()
void	passResult(CompletionResult result)
void	restartCompletionOnAnyPrefixChange() Request that the completion contributors be run again when the user changes the prefix in any way.
abstract void	restartCompletionOnPrefixChange(ElementPattern<java.lang.String> prefixCondition) Request that the completion contributors be run again when the user changes the prefix in a way satisfied by the given condition.
void	restartCompletionOnPrefixChange(java.lang.String prefix) Request that the completion contributors be run again when the user changes the prefix so that it becomes equal to the one given.
abstract void	restartCompletionWhenNothingMatches() Request that the completion contributors be run again when the user types something into the editor so that no existing lookup elements match that prefix anymore.
java.util.LinkedHashSet<CompletionResult>	runRemainingContributors(CompletionParameters parameters, boolean passResult)
void	runRemainingContributors(CompletionParameters parameters, Consumer<? super CompletionResult> consumer)
void	runRemainingContributors(CompletionParameters parameters, Consumer<CompletionResult> consumer, boolean stop)
void	runRemainingContributors(CompletionParameters parameters, Consumer<CompletionResult> consumer, boolean stop, CompletionSorter customSorter)
void	startBatch()
void	stopHere()
abstract CompletionResultSet	withPrefixMatcher(PrefixMatcher matcher)
abstract CompletionResultSet	withPrefixMatcher(java.lang.String prefix) Creates a default camel-hump prefix matcher based on given prefix
abstract CompletionResultSet	withRelevanceSorter(CompletionSorter sorter)

Methods inherited from class java.lang.Object

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

Field Detail

myCompletionService

protected final CompletionService myCompletionService

myContributor

protected final CompletionContributor myContributor

Constructor Detail

CompletionResultSet

protected CompletionResultSet(PrefixMatcher prefixMatcher,
                              Consumer<? super CompletionResult> consumer,
                              CompletionContributor contributor)

Method Detail

getConsumer

protected Consumer<? super CompletionResult> getConsumer()

consume

public void consume(LookupElement element)

Specified by:

consume in interface Consumer<LookupElement>

Parameters:

element - consequently takes value of each element of the set this processor is passed to for processing. t is supposed to be a not-null value. If you need to pass nulls to the consumer use NullableConsumer instead

addElement

public abstract void addElement(LookupElement element)

If a given element matches the prefix, give it for further processing (which may eventually result in its appearing in the completion list).

See Also:

addAllElements(Iterable)

passResult

public void passResult(CompletionResult result)

startBatch

public void startBatch()

endBatch

public void endBatch()

addAllElements

public void addAllElements(java.lang.Iterable<? extends LookupElement> elements)

Adds all elements from the given collection that match the prefix for further processing. The elements are processed in batch, so that they'll appear in lookup all together.

This can be useful to ensure predictable order of top suggested elements. Otherwise, when the lookup is shown, most relevant elements processed to that moment are put to the top and remain there even if more relevant elements appear later. These "first" elements may differ from completion invocation to completion invocation due to performance fluctuations, resulting in varying preselected item in completion and worse user experience. Using addAllElements instead of addElement(LookupElement) helps to avoid that.

withPrefixMatcher

public abstract CompletionResultSet withPrefixMatcher(PrefixMatcher matcher)

withPrefixMatcher

public abstract CompletionResultSet withPrefixMatcher(java.lang.String prefix)

Creates a default camel-hump prefix matcher based on given prefix

withRelevanceSorter

public abstract CompletionResultSet withRelevanceSorter(CompletionSorter sorter)

addLookupAdvertisement

public abstract void addLookupAdvertisement(java.lang.String text)

caseInsensitive

public abstract CompletionResultSet caseInsensitive()

Returns:

A result set with the same prefix, but the lookup strings will be matched case-insensitively. Their lookup strings will remain as they are though, so upon insertion the prefix case will be changed.

getPrefixMatcher

public PrefixMatcher getPrefixMatcher()

isStopped

public boolean isStopped()

stopHere

public void stopHere()

runRemainingContributors

public java.util.LinkedHashSet<CompletionResult> runRemainingContributors(CompletionParameters parameters,
                                                                          boolean passResult)

runRemainingContributors

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

runRemainingContributors

public void runRemainingContributors(CompletionParameters parameters,
                                     Consumer<CompletionResult> consumer,
                                     boolean stop)

runRemainingContributors

public void runRemainingContributors(CompletionParameters parameters,
                                     Consumer<CompletionResult> consumer,
                                     boolean stop,
                                     CompletionSorter customSorter)

restartCompletionOnPrefixChange

public void restartCompletionOnPrefixChange(java.lang.String prefix)

Request that the completion contributors be run again when the user changes the prefix so that it becomes equal to the one given.

restartCompletionOnPrefixChange

public abstract void restartCompletionOnPrefixChange(ElementPattern<java.lang.String> prefixCondition)

Request that the completion contributors be run again when the user changes the prefix in a way satisfied by the given condition.

restartCompletionOnAnyPrefixChange

public void restartCompletionOnAnyPrefixChange()

Request that the completion contributors be run again when the user changes the prefix in any way.

restartCompletionWhenNothingMatches

public abstract void restartCompletionWhenNothingMatches()

Request that the completion contributors be run again when the user types something into the editor so that no existing lookup elements match that prefix anymore.