Package jetbrains.mps.smodel

Class MPSModuleRepository

java.lang.Object

jetbrains.mps.extapi.module.SRepositoryBase

jetbrains.mps.smodel.MPSModuleRepository

All Implemented Interfaces:

CoreComponent, SRepositoryExt, ReferenceScopeHelper.Source, SRepository

public class MPSModuleRepository
extends SRepositoryBase
implements CoreComponent, SRepositoryExt, ReferenceScopeHelper.Source

Constructor Summary

Constructors

Constructor	Description
MPSModuleRepository(SRepositoryRegistry repositoryRegistry)

Method Summary

Modifier and Type	Method	Description
void	dispose()
static MPSModuleRepository	getInstance()	Deprecated.
ModelAccess	getModelAccess()
SModule	getModule(SModuleId id)
Iterable<SModule>	getModules()	Returns an unmodifiable collection of modules.
Set<SModule>	getModules(MPSModuleOwner moduleOwner)
Set<MPSModuleOwner>	getOwners(SModule module)
ReferenceScopeHelper	getReferenceScopeHelper()
void	init()
void	invalidateCaches()
<T extends SModule> T	registerModule(T moduleToRegister, MPSModuleOwner owner)	Need register/unregister API for modules because at the moment registration goes through static instance of MPSModuleRepository.
void	saveAll()
void	unregisterModule(SModule module, MPSModuleOwner owner)	Unregisters given module only (e.g.
void	unregisterModules(Collection<SModule> modules, MPSModuleOwner owner)	Deprecated. use of this method is discouraged as it's specific to this SRepository implementation.

Methods inherited from class jetbrains.mps.extapi.module.SRepositoryBase

addRepositoryListener, fireBeforeModuleRemoved, fireCommandFinished, fireCommandStarted, fireModuleAdded, fireModuleRemoved, getParent, getRepositoryAccess, removeRepositoryListener

Methods inherited from class java.lang.Object

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

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

addRepositoryListener, getParent, getRepositoryAccess, removeRepositoryListener

Constructor Detail

MPSModuleRepository

public MPSModuleRepository(SRepositoryRegistry repositoryRegistry)

Method Detail

getInstance

@Deprecated
public static MPSModuleRepository getInstance()

Deprecated.

Use SRepository from the project whenever it is possible

Currently the context object is an MPS project class

Since:

3.2

See Also:

It can provide a repository and a model access } So in each case you must have an MPS project within your scope and request SRepository explicitily from the project. To access register/unregister methods for modules, consider using

init

public void init()

Specified by:

init in interface CoreComponent

Overrides:

init in class SRepositoryBase

dispose

public void dispose()

Specified by:

dispose in interface CoreComponent

Overrides:

dispose in class SRepositoryBase

registerModule

public <T extends SModule> T registerModule(@NotNull
                                            T moduleToRegister,
                                            @NotNull
                                            MPSModuleOwner owner)

Description copied from interface: SRepositoryExt

Need register/unregister API for modules because at the moment registration goes through static instance of MPSModuleRepository. Not an API right away due to (a) MPSModuleOwner is not an API; (b) not certain whether we shall have separate 'editable' SRepository interface (like EditableSModel), which sounds rather stupid but it's the way it runs in the rest of MPS, or the API shall become part of SRepository, but this rises a question if the API shall fail in a harsh or silent way for repositories that do not support change (c) I don't like return value for the method, but it's the way MPSModuleRepository have it. I don't quite buy "single module in a repo, with multiple *owners*" story. If it's truly needed, we could accomplish the same with register(getModule(moduleRef), anotherOwner), rather than return value Promise: once returns, module is attached to the repository registerModule(SModule, MPSModuleOwner)

Specified by:

registerModule in interface SRepositoryExt

unregisterModules

@Deprecated
public void unregisterModules(Collection<SModule> modules,
                              MPSModuleOwner owner)

Deprecated.

use of this method is discouraged as it's specific to this SRepository implementation. It shall not get exposed in SRepositoryExt unless there's thorough justification. The only rationale behind this method was slow 'invalidateCaches()' when multiple modules were un-registered during project close/MPS shutdown. Now, with no-op invalidateCaches(), there's no performance gain in using this method. However, might be reasonable to update SRepositoryExt API to accommodate collection instead of a single object for register/unregister operations. The method left as a reminder.

unregisterModule

public void unregisterModule(@NotNull
                             SModule module,
                             @NotNull
                             MPSModuleOwner owner)

Description copied from interface: SRepositoryExt

Unregisters given module only (e.g. in case of a language, it's not repository responsibility to care about language generators)

Specified by:

unregisterModule in interface SRepositoryExt

See Also:

If to persist, shall describe the contract, e.g. what happens when a module doesn't belong to a repo or is not associated with the supplied owner

getModelAccess

@NotNull
public ModelAccess getModelAccess()

Specified by:

getModelAccess in interface SRepository

Returns:

a special class which yields a control to the objects which comprise the repository. These are namely modules, models, model roots, nodes.

getModules

public Set<SModule> getModules(MPSModuleOwner moduleOwner)

Specified by:

getModules in interface SRepositoryExt

getOwners

public Set<MPSModuleOwner> getOwners(SModule module)

Specified by:

getOwners in interface SRepositoryExt

getModule

public SModule getModule(@NotNull
                         SModuleId id)

Specified by:

getModule in interface SRepository

Returns:

the module which id is equal to the given module id. A repository is able to have only one module for a given module id. null is returned iff there is no such module in the repository

getModules

@NotNull
public Iterable<SModule> getModules()

Description copied from interface: SRepository

Returns an unmodifiable collection of modules.

Specified by:

getModules in interface SRepository

invalidateCaches

public void invalidateCaches()

saveAll

public void saveAll()

Specified by:

saveAll in interface SRepository

getReferenceScopeHelper

public ReferenceScopeHelper getReferenceScopeHelper()

Specified by:

getReferenceScopeHelper in interface ReferenceScopeHelper.Source