Package jetbrains.mps.ide.findusages.findalgorithm.finders

Class GeneratedFinder

java.lang.Object

jetbrains.mps.ide.findusages.findalgorithm.finders.BaseFinder

jetbrains.mps.ide.findusages.findalgorithm.finders.GeneratedFinder

All Implemented Interfaces:

Finder, IFinder, IInterfacedFinder

public abstract class GeneratedFinder
extends BaseFinder
implements IInterfacedFinder

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.mps.ide.findusages.findalgorithm.finders.IFinder

IFinder.FindCallback

Constructor Summary

Constructors

Constructor	Description
GeneratedFinder()

Method Summary

Modifier and Type	Method	Description
protected SNodeReference	buildNodePointer(SModelReference modelRef, String nodeId)
boolean	canNavigate()	Is there any meaningful value other than true or getDeclarationNode != null?
protected SearchResult<SNode>	createSingleResult(SNode usage)
protected void	doFind(SNode node, SearchScope scope, List<SNode> _results, ProgressMonitor monitor)	Deprecated.
protected void	doFind0(SNode node, SearchScope scope, IFinder.FindCallback callback, ProgressMonitor monitor)
void	find(SearchQuery query, IFinder.FindCallback callback, ProgressMonitor monitor)	the default behavior is provided in order to guarantee a two-way compatibility
SNodeReference	getDeclarationNode()
List<SNode>	getElementsToLookFor(SNode toSearch, SearchScope scope)
String	getLongDescription()
String	getNodeCategory(SNode node)
void	getSearchedNodes(SNode node, SearchScope scope, List<SNode> _results)	Deprecated.
boolean	isApplicable(SNode node)
boolean	isUsedByDefault(SNode node)
boolean	isVisible(SNode node)

Methods inherited from class jetbrains.mps.ide.findusages.findalgorithm.finders.BaseFinder

getDescription

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.mps.ide.findusages.findalgorithm.finders.IFinder

find

Methods inherited from interface jetbrains.mps.ide.findusages.findalgorithm.finders.IInterfacedFinder

getDescription, getSConcept

Constructor Detail

GeneratedFinder

public GeneratedFinder()

Method Detail

isApplicable

public boolean isApplicable(SNode node)

Specified by:

isApplicable in interface IInterfacedFinder

isVisible

public boolean isVisible(SNode node)

Specified by:

isVisible in interface IInterfacedFinder

isUsedByDefault

public boolean isUsedByDefault(SNode node)

Specified by:

isUsedByDefault in interface IInterfacedFinder

getLongDescription

public String getLongDescription()

Specified by:

getLongDescription in interface IInterfacedFinder

getDeclarationNode

@Nullable
public SNodeReference getDeclarationNode()

Specified by:

getDeclarationNode in interface IInterfacedFinder

buildNodePointer

protected SNodeReference buildNodePointer(SModelReference modelRef,
                                          String nodeId)

canNavigate

public boolean canNavigate()

Description copied from interface: IInterfacedFinder

Is there any meaningful value other than true or getDeclarationNode != null?

Specified by:

canNavigate in interface IInterfacedFinder

doFind

@Deprecated
protected void doFind(SNode node,
                      SearchScope scope,
                      List<SNode> _results,
                      ProgressMonitor monitor)

Deprecated.

both methods are to become abstract

doFind0

protected void doFind0(@NotNull
                       SNode node,
                       @NotNull
                       SearchScope scope,
                       @NotNull
                       IFinder.FindCallback callback,
                       @NotNull
                       ProgressMonitor monitor)

getSearchedNodes

@Deprecated
public void getSearchedNodes(SNode node,
                             SearchScope scope,
                             List<SNode> _results)

Deprecated.

I suggest #getXXX method to return smth instead of this

getElementsToLookFor

@NotNull
public List<SNode> getElementsToLookFor(@NotNull
                                        SNode toSearch,
                                        @NotNull
                                        SearchScope scope)

getNodeCategory

public String getNodeCategory(SNode node)

createSingleResult

@NotNull
protected SearchResult<SNode> createSingleResult(@NotNull
                                                 SNode usage)

find

public void find(@NotNull
                 SearchQuery query,
                 @NotNull
                 IFinder.FindCallback callback,
                 @NotNull
                 ProgressMonitor monitor)

Description copied from interface: IFinder

the default behavior is provided in order to guarantee a two-way compatibility

Specified by:

find in interface IFinder