Package jetbrains.mps.ide.findusages.model.scopes

Class ModulesScope

java.lang.Object

jetbrains.mps.smodel.BaseScope

jetbrains.mps.ide.findusages.model.scopes.FindUsagesScope

jetbrains.mps.ide.findusages.model.scopes.ModulesScope

All Implemented Interfaces:

IExternalizeable, SearchScope

public class ModulesScope
extends FindUsagesScope

Field Summary

Fields inherited from class jetbrains.mps.ide.findusages.model.scopes.FindUsagesScope

myModels, myModules

Constructor Summary

Constructors

Constructor	Description
ModulesScope(Iterable<? extends SModule> modules)
ModulesScope(org.jdom.Element element, Project project)
ModulesScope(SModule... modules)

Method Summary

Modifier and Type	Method	Description
SModule	resolve(SModuleReference reference)	Finder use this method to go from module reference to SModule object, Find Usages client may use this method to limit what's visible/accessible to a Finder.
void	resolveRespectsAllVisible(boolean respectVisible)	Tells whether to use only specified modules as reference resolution scope for resolve(org.jetbrains.mps.openapi.module.SModuleReference), or all visible/accessible modules shall be considered
protected void	scopeChanged()	Subclasses shall override to react to scope change
String	toString()
void	write(org.jdom.Element element, Project project)

Methods inherited from class jetbrains.mps.ide.findusages.model.scopes.FindUsagesScope

addModel, addModule, getModels, getModules, load, primAddModel, primAddModule, read, save

Methods inherited from class jetbrains.mps.smodel.BaseScope

resolve

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jetbrains.mps.openapi.module.SearchScope

resolve, resolve

Constructor Detail

ModulesScope

public ModulesScope(@NotNull
                    Iterable<? extends SModule> modules)

ModulesScope

public ModulesScope(@NotNull
                    SModule... modules)

ModulesScope

public ModulesScope(org.jdom.Element element,
                    Project project)
             throws CantLoadSomethingException

Throws:

CantLoadSomethingException

Method Detail

resolveRespectsAllVisible

public void resolveRespectsAllVisible(boolean respectVisible)

Tells whether to use only specified modules as reference resolution scope for resolve(org.jetbrains.mps.openapi.module.SModuleReference), or all visible/accessible modules shall be considered

resolve

public SModule resolve(@NotNull
                       SModuleReference reference)

Description copied from interface: SearchScope

Finder use this method to go from module reference to SModule object, Find Usages client may use this method to limit what's visible/accessible to a Finder. shall always resolve references to modules from SearchScope.getModules()

Specified by:

resolve in interface SearchScope

Overrides:

resolve in class BaseScope

Parameters:

reference - module to look up in the scope

Returns:

module instance, or null if there's no such module in the scope

scopeChanged

protected void scopeChanged()

Description copied from class: FindUsagesScope

Subclasses shall override to react to scope change

Overrides:

scopeChanged in class FindUsagesScope

write

public void write(org.jdom.Element element,
                  Project project)
           throws CantSaveSomethingException

Specified by:

write in interface IExternalizeable

Overrides:

write in class FindUsagesScope

Throws:

CantSaveSomethingException

toString

public String toString()

Overrides:

toString in class Object