Package jetbrains.mps.smodel.event

Class RepositoryChangeTracker

java.lang.Object

org.jetbrains.mps.openapi.module.SModuleListenerBase

org.jetbrains.mps.openapi.module.SRepositoryContentAdapter

jetbrains.mps.smodel.event.RepositoryChangeTracker

All Implemented Interfaces:

SModelListener, SNodeAccessListener, SNodeChangeListener, SModuleListener, SRepositoryAttachListener, SRepositoryListener

public class RepositoryChangeTracker
extends SRepositoryContentAdapter

XXX PERHAPS, NAME OF THE CLASS SHALL REFLECT WE TRACK CHANGES WITHIN COMMANDS ONLY? IS THERE CASE WHEN WE NEED TO TRACK CHANGES WITHOUT RESPECT TO COMMAND? Tracks changes in a repository within boundaries of a command, and dispatch them further to listeners. Replacement for jetbrains.mps.smodel.GlobalSModelEventsManager, in particular #addGlobalCommandListener and SModelCommandListener RepositoryChangeTracker may come from a dedicated project component (to share it unless there's mechanism to accomplish the same through SRepository/MPSProject. Although why not Project.getComponent?)

Constructor Summary

Constructors

Constructor	Description
RepositoryChangeTracker()

Method Summary

Modifier and Type	Method	Description
void	addListener(SNodeBatchChangeListener l)
void	commandFinished(SRepository repository)
void	commandStarted(SRepository repository)	Notifications about commands in a ModelAccess associated with the repository.
protected boolean	isIncluded(SModule module)
void	removeListener(SNodeBatchChangeListener l)
protected void	startListening(SModel model)	no-op by default.
protected void	stopListening(SModel model)	no-op by default

Methods inherited from class org.jetbrains.mps.openapi.module.SRepositoryContentAdapter

beforeModelRemoved, beforeModuleRemoved, conflictDetected, modelAdded, modelAttached, modelDetached, modelLoaded, modelRemoved, modelReplaced, modelSaved, modelUnloaded, moduleAdded, moduleChanged, moduleRemoved, nodeAdded, nodeRead, nodeRemoved, problemsDetected, propertyChanged, propertyRead, referenceChanged, referenceRead, repositoryChanged, repositoryCommandFinished, repositoryCommandStarted, startListening, startListening, stopListening, stopListening, subscribeTo, unsubscribeFrom, updateFinished, updateStarted

Methods inherited from class org.jetbrains.mps.openapi.module.SModuleListenerBase

beforeModelRenamed, dependencyAdded, dependencyRemoved, languageAdded, languageRemoved, modelRenamed, moduleRenamed

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.SModuleListener

beforeModelRenamed, dependencyAdded, dependencyRemoved, languageAdded, languageRemoved, modelRenamed

Constructor Detail

RepositoryChangeTracker

public RepositoryChangeTracker()

Method Detail

isIncluded

protected boolean isIncluded(SModule module)

Overrides:

isIncluded in class SRepositoryContentAdapter

Returns:

always true

startListening

protected void startListening(SModel model)

Description copied from class: SRepositoryContentAdapter

no-op by default. Subclasses that wish to get model/node change/access events, shall add appropriate listeners here. These listeners are implemented by this class only for convenience, events are not dispatched unless proper listener is explicitly attached.

Overrides:

startListening in class SRepositoryContentAdapter

stopListening

protected void stopListening(SModel model)

Description copied from class: SRepositoryContentAdapter

no-op by default

Overrides:

stopListening in class SRepositoryContentAdapter

commandStarted

public void commandStarted(SRepository repository)

Description copied from interface: SRepositoryListener

Notifications about commands in a ModelAccess associated with the repository. It's convenient to have command notifications right in SRepositoryListener implementation, like RepositoryChangeTracker (the one where all changes within a command are collected), rather than have distinct CommandListener. Unlike CommandListener, gives context repository to facilitate use of the same listener instance among different repositories.

Specified by:

commandStarted in interface SRepositoryListener

Overrides:

commandStarted in class SRepositoryContentAdapter

See Also:

CommandListener.commandStarted()

commandFinished

public void commandFinished(SRepository repository)

Specified by:

commandFinished in interface SRepositoryListener

Overrides:

commandFinished in class SRepositoryContentAdapter

See Also:

CommandListener.commandFinished()

addListener

public void addListener(@Nullable
                        SNodeBatchChangeListener l)

removeListener

public void removeListener(@Nullable
                           SNodeBatchChangeListener l)