Package org.jetbrains.mps.openapi.module

Class FindUsagesFacade

java.lang.Object

org.jetbrains.mps.openapi.module.FindUsagesFacade

Direct Known Subclasses:

FindUsagesManager

public abstract class FindUsagesFacade
extends Object

Effective (usually index-based) implementation of find usages routines. If the monitor passed to one of the findXXX method is null, then the default EmptyProgressMonitor is created.

Field Summary

Fields

Modifier and Type	Field	Description
protected static FindUsagesFacade	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FindUsagesFacade()

Method Summary

Modifier and Type	Method	Description
void	findInstances(SearchScope scope, Set<? extends SAbstractConcept> concepts, boolean exact, Consumer<SNode> consumer, ProgressMonitor monitor)
abstract Set<SNode>	findInstances(SearchScope scope, Set<? extends SAbstractConcept> concepts, boolean exact, ProgressMonitor monitor)	Deprecated. please use more general version below.
void	findModelUsages(SearchScope scope, Set<SModelReference> modelReferences, Consumer<SModel> consumer, ProgressMonitor monitor)
abstract Set<SModel>	findModelUsages(SearchScope scope, Set<SModelReference> modelReferences, ProgressMonitor monitor)	Deprecated. please use more general version below.
void	findUsages(SearchScope scope, Set<SNode> nodes, Consumer<SReference> consumer, ProgressMonitor monitor)	The methods below do exactly the same, only report their results not via the return but via the provided callback consumer.
abstract Set<SReference>	findUsages(SearchScope scope, Set<SNode> nodes, ProgressMonitor monitor)	Deprecated. please use more general version below.
static FindUsagesFacade	getInstance()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

protected static FindUsagesFacade INSTANCE

Constructor Detail

FindUsagesFacade

protected FindUsagesFacade()

Method Detail

getInstance

public static FindUsagesFacade getInstance()

findUsages

@Deprecated
public abstract Set<SReference> findUsages(@NotNull
                                           SearchScope scope,
                                           @NotNull
                                           Set<SNode> nodes,
                                           @Nullable
                                           ProgressMonitor monitor)

Deprecated.

please use more general version below. consider using jetbrains.mps.util.CollectConsumer if you need to recreate the old behavior.

Finds references to the provided nodes in the scope.

findInstances

@Deprecated
public abstract Set<SNode> findInstances(@NotNull
                                         SearchScope scope,
                                         @NotNull
                                         Set<? extends SAbstractConcept> concepts,
                                         boolean exact,
                                         @Nullable
                                         ProgressMonitor monitor)

Deprecated.

please use more general version below. consider using jetbrains.mps.util.CollectConsumer if you need to recreate the old behavior.

Finds instances of the provided concepts in the scope.

findModelUsages

@Deprecated
public abstract Set<SModel> findModelUsages(@NotNull
                                            SearchScope scope,
                                            @NotNull
                                            Set<SModelReference> modelReferences,
                                            @Nullable
                                            ProgressMonitor monitor)

Deprecated.

please use more general version below. consider using jetbrains.mps.util.CollectConsumer if you need to recreate the old behavior.

Finds models referencing the provided set of models in the scope.

findUsages

public void findUsages(@NotNull
                       SearchScope scope,
                       @NotNull
                       Set<SNode> nodes,
                       @NotNull
                       Consumer<SReference> consumer,
                       ProgressMonitor monitor)

The methods below do exactly the same, only report their results not via the return but via the provided callback consumer. They are to become abstract in the future releases

findInstances

public void findInstances(@NotNull
                          SearchScope scope,
                          @NotNull
                          Set<? extends SAbstractConcept> concepts,
                          boolean exact,
                          @NotNull
                          Consumer<SNode> consumer,
                          ProgressMonitor monitor)

findModelUsages

public void findModelUsages(@NotNull
                            SearchScope scope,
                            @NotNull
                            Set<SModelReference> modelReferences,
                            @NotNull
                            Consumer<SModel> consumer,
                            ProgressMonitor monitor)