Package com.intellij.ide.util.gotoByName

Class DefaultChooseByNameItemProvider

java.lang.Object

com.intellij.ide.util.gotoByName.DefaultChooseByNameItemProvider

All Implemented Interfaces:

ChooseByNameInScopeItemProvider, ChooseByNameItemProvider, ChooseByNameWeightedItemProvider

Direct Known Subclasses:

GotoFileItemProvider

public class DefaultChooseByNameItemProvider
extends java.lang.Object
implements ChooseByNameInScopeItemProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultChooseByNameItemProvider.PathProximityComparator

Constructor Summary

Constructors

Constructor and Description
DefaultChooseByNameItemProvider(PsiElement context)

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	filterElements(ChooseByNameBase base, java.lang.String pattern, boolean everywhere, ProgressIndicator indicator, Processor<java.lang.Object> consumer)
static boolean	filterElements(ChooseByNameViewModel base, java.lang.String pattern, boolean everywhere, ProgressIndicator indicator, PsiElement context, Processor<java.lang.Object> consumer) Filters and sorts elements in the given choose by name popup according to the given pattern.
boolean	filterElementsWithWeights(ChooseByNameBase base, FindSymbolParameters parameters, ProgressIndicator indicator, Processor<? super FoundItemDescriptor<?>> consumer) Searches for elements that match specified filters and returns also their weights.
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.
java.util.List<java.lang.String>	filterNames(ChooseByNameBase base, java.lang.String [] names, java.lang.String pattern)
protected DefaultChooseByNameItemProvider.PathProximityComparator	getPathProximityComparator()
protected static MatchResult	matches(ChooseByNameViewModel base, java.lang.String pattern, MinusculeMatcher matcher, java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultChooseByNameItemProvider

public DefaultChooseByNameItemProvider(PsiElement context)

Method Detail

filterElements

public boolean filterElements(ChooseByNameBase base,
                              java.lang.String pattern,
                              boolean everywhere,
                              ProgressIndicator indicator,
                              Processor<java.lang.Object> consumer)

Specified by:

filterElements in interface ChooseByNameItemProvider

filterElements

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

Description copied from interface: ChooseByNameInScopeItemProvider

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

Specified by:

filterElements in interface ChooseByNameInScopeItemProvider

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

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

Description copied from interface: ChooseByNameWeightedItemProvider

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)

Specified by:

filterElementsWithWeights in interface ChooseByNameWeightedItemProvider

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

filterElementsWithWeights

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

Description copied from interface: ChooseByNameInScopeItemProvider

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)

Specified by:

filterElementsWithWeights in interface ChooseByNameInScopeItemProvider

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

filterElements

public static boolean filterElements(ChooseByNameViewModel base,
                                     java.lang.String pattern,
                                     boolean everywhere,
                                     ProgressIndicator indicator,
                                     PsiElement context,
                                     Processor<java.lang.Object> consumer)

Filters and sorts elements in the given choose by name popup according to the given pattern.

Parameters:

indicator - Progress indicator which can be used to cancel the operation

context - The PSI element currently open in the editor (used for proximity ordering of returned results)

consumer - The consumer to which the results (normally NavigationItem instances) are passed

Returns:

true if the operation completed normally, false if it was interrupted

getPathProximityComparator

protected DefaultChooseByNameItemProvider.PathProximityComparator getPathProximityComparator()

filterNames

public java.util.List<java.lang.String> filterNames(ChooseByNameBase base,
                                                    java.lang.String [] names,
                                                    java.lang.String pattern)

Specified by:

filterNames in interface ChooseByNameItemProvider

matches

protected static MatchResult matches(ChooseByNameViewModel base,
                                     java.lang.String pattern,
                                     MinusculeMatcher matcher,
                                     java.lang.String name)