Package jetbrains.mps.smodel

Class EditableModelDescriptor

java.lang.Object

jetbrains.mps.extapi.model.SModelDescriptorStub

jetbrains.mps.extapi.model.SModelBase

jetbrains.mps.smodel.RegularModelDescriptor

jetbrains.mps.smodel.EditableModelDescriptor

All Implemented Interfaces:

ModelWithDisposeInfo, FastNodeFinder.Factory, SModelInternal, EditableSModel, SModel

public abstract class EditableModelDescriptor
extends RegularModelDescriptor
implements EditableSModel

Base implementation of EditableSModel. Since it relies on non-API j.m.smodel.SModel model data implementation, the class kept in our implementation package, rather than being part of openapi/extapi. This implementation is responsible for change state field, change listeners (both new and contemporary), and root add/remove. Other aspects of EditableSModel shall be implemented in subclasses.

Since:

3.3

Nested Class Summary

Nested classes/interfaces inherited from interface org.jetbrains.mps.openapi.model.SModel

SModel.Problem

Field Summary

Fields inherited from class jetbrains.mps.smodel.RegularModelDescriptor

myLoadLock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EditableModelDescriptor(SModelReference modelRef, DataSource source)

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(SNodeChangeListener listener)	This class doesn't dispatch change events, no listeners are tracked.
void	addRootNode(SNode node)	Adds the node as a root to this model.
boolean	isChanged()
boolean	isReadOnly()	No changes are permitted.
void	removeChangeListener(SNodeChangeListener listener)	This class doesn't dispatch change events, no listeners are tracked.
void	removeRootNode(SNode node)	Removes the whole subtree from the model.
void	setChanged(boolean changed)

Methods inherited from class jetbrains.mps.smodel.RegularModelDescriptor

createModel, doUnload, getCurrentModelInternal, getSModelInternal, replace

Methods inherited from class jetbrains.mps.extapi.model.SModelBase

addAccessListener, addModelListener, assertCanChange, assertCanRead, attach, changeModelReference, createNode, createNode, detach, fireBeforeModelRenamed, fireConflictDetected, fireModelRenamed, fireModelReplaced, fireModelSaved, fireModelStateChanged, fireProblemsDetected, getLoadingState, getModelData, getModelId, getModelName, getModelRoot, getModule, getName, getNode, getNodeEventDispatch, getProblems, getReference, getRepository, getRootNodes, getSource, isLoaded, load, removeAccessListener, removeModelListener, replaceModelAndFireEvent, setLoadingState, setModelRoot, setModule, unload

Methods inherited from class jetbrains.mps.extapi.model.SModelDescriptorStub

addDevKit, addEngagedOnGenerationLanguage, addLanguage, addModelImport, addModelListener, clearListeners, createNodeFinder, deleteDevKit, deleteLanguageId, deleteModelImport, fireBeforeModelDisposed, fireBeforeModelFileChanged, fireBeforeModelRenamed, fireModelFileChanged, fireModelRenamed, fireModelStateChanged, getDisposedStacktrace, getLanguageImportVersion, getLanguagesEngagedOnGeneration, getModelDepsManager, getModelImports, getModelListeners, getSModel, importedDevkits, importedLanguageIds, isDisposed, removeEngagedOnGenerationLanguage, removeModelListener, setLanguageImportVersion, updateExternalReferences

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.model.EditableSModel

needsReloading, reloadFromSource, rename, save, updateTimestamp

Methods inherited from interface org.jetbrains.mps.openapi.model.SModel

addAccessListener, addModelListener, createNode, createNode, getModelId, getModelName, getModelRoot, getModule, getName, getNode, getProblems, getReference, getRepository, getRootNodes, getSource, isLoaded, load, removeAccessListener, removeModelListener, unload

Constructor Detail

EditableModelDescriptor

protected EditableModelDescriptor(@NotNull
                                  SModelReference modelRef,
                                  @NotNull
                                  DataSource source)

Method Detail

isChanged

public boolean isChanged()

Specified by:

isChanged in interface EditableSModel

setChanged

public void setChanged(boolean changed)

Specified by:

setChanged in interface EditableSModel

addRootNode

public void addRootNode(@NotNull
                        SNode node)

Description copied from interface: SModel

Adds the node as a root to this model. Each node in the underlying subtree becomes connected to this model and returns it from the getModel() method.

Specified by:

addRootNode in interface SModel

Overrides:

addRootNode in class SModelBase

removeRootNode

public void removeRootNode(@NotNull
                           SNode node)

Description copied from interface: SModel

Removes the whole subtree from the model.

Specified by:

removeRootNode in interface SModel

Overrides:

removeRootNode in class SModelBase

isReadOnly

public boolean isReadOnly()

Description copied from interface: SModel

No changes are permitted. For read-only models all modification operations always throw IllegalModelChangeError.

Specified by:

isReadOnly in interface SModel

Overrides:

isReadOnly in class SModelBase

addChangeListener

public void addChangeListener(SNodeChangeListener listener)

Description copied from class: SModelBase

This class doesn't dispatch change events, no listeners are tracked.

Specified by:

addChangeListener in interface SModel

Overrides:

addChangeListener in class SModelBase

Parameters:

listener - listener to add, tolerates null

removeChangeListener

public void removeChangeListener(SNodeChangeListener listener)

Description copied from class: SModelBase

This class doesn't dispatch change events, no listeners are tracked.

Specified by:

removeChangeListener in interface SModel

Overrides:

removeChangeListener in class SModelBase

Parameters:

listener - listener to remove, tolerates null and unknown (not registered) listeners