Package com.intellij.ide.util.gotoByName

Interface ChooseByNameWeightedItemProvider

All Superinterfaces:

ChooseByNameItemProvider

All Known Subinterfaces:

ChooseByNameInScopeItemProvider

All Known Implementing Classes:

DefaultChooseByNameItemProvider, GotoFileItemProvider

public interface ChooseByNameWeightedItemProvider
extends ChooseByNameItemProvider

Method Summary

Modifier and Type	Method and Description
boolean	filterElementsWithWeights(ChooseByNameBase base, java.lang.String pattern, boolean everywhere, ProgressIndicator indicator, Processor<? super FoundItemDescriptor<?>> consumer) Searches for elements that match specified filters and returns also their weights.

Methods inherited from interface com.intellij.ide.util.gotoByName.ChooseByNameItemProvider

filterElements, filterNames

Method Detail

filterElementsWithWeights

boolean filterElementsWithWeights(ChooseByNameBase base,
                                  java.lang.String pattern,
                                  boolean everywhere,
                                  ProgressIndicator indicator,
                                  Processor<? super FoundItemDescriptor<?>> consumer)

Searches for elements that match specified filters and returns also their weights. Method processes to consumer instances of FoundItemDescriptor wrapper that contains found item and its weight. Method should be used when receiver wants to sort found items by itself (for example when they should be mixed with results from other providers)

Parameters:

pattern - string pattern for search

everywhere - indicates if search should be preformed only in project files or external resources (like libraries and other) should be included

indicator - ProgressIndicator which could be used to cancel search process

consumer - consumer for process all found items. Takes instances of FoundItemDescriptor wrapper, which contains also item's wights

Returns:

true if all found items were processed. If consumer returns false for any of them search will be stopped and method will return false

See Also:

FoundItemDescriptor