Package com.intellij.ide.util.gotoByName

Interface ChooseByNameInScopeItemProvider

All Superinterfaces:

ChooseByNameItemProvider, ChooseByNameWeightedItemProvider

All Known Implementing Classes:

DefaultChooseByNameItemProvider, GotoFileItemProvider

public interface ChooseByNameInScopeItemProvider
extends ChooseByNameWeightedItemProvider

Method Summary

Modifier and Type	Method and Description
boolean	filterElements(ChooseByNameBase base, FindSymbolParameters parameters, ProgressIndicator indicator, Processor<java.lang.Object> consumer) Searches for elements that match specified filters.
boolean	filterElementsWithWeights(ChooseByNameBase base, FindSymbolParameters parameters, 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.ChooseByNameWeightedItemProvider

filterElementsWithWeights

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

filterElements, filterNames

Method Detail

filterElements

boolean filterElements(ChooseByNameBase base,
                       FindSymbolParameters parameters,
                       ProgressIndicator indicator,
                       Processor<java.lang.Object> consumer)

Searches for elements that match specified filters. Uses extended filters for searching (see FindSymbolParameters)

Parameters:

parameters - search parameters

indicator - ProgressIndicator which could be used to cancel search process

consumer - consumer for process all found items

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:

FindSymbolParameters

filterElementsWithWeights

boolean filterElementsWithWeights(ChooseByNameBase base,
                                  FindSymbolParameters parameters,
                                  ProgressIndicator indicator,
                                  Processor<? super FoundItemDescriptor<?>> consumer)

Searches for elements that match specified filters and returns also their weights. Uses extended filters for searching (see FindSymbolParameters) 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:

parameters - search parameters

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:

FindSymbolParameters, FoundItemDescriptor