Package jetbrains.mps.extapi.model

Class SModelDescriptorStub

java.lang.Object

jetbrains.mps.extapi.model.SModelDescriptorStub

All Implemented Interfaces:

ModelWithDisposeInfo, FastNodeFinder.Factory, SModelInternal, SModel

Direct Known Subclasses:

SModelBase

public abstract class SModelDescriptorStub
extends Object
implements SModelInternal, SModel, FastNodeFinder.Factory

IMPORTANT - DO NOT SUBCLASS THIS ONE DIRECTLY, USE SModelBase INSTEAD. Stub for model implementations with data kept separately in a SModel/SModelData (as of now/planned). Unlike SModelBase, which is true root of model descriptor hierarchy, this class keeps transition stuff like legacy SModelListeners and SModelInternal methods, our explicit though untold dependencies from smodel.SModel. Perhaps, one day we can get rid of if altogether. TODO move listeners to openapi

Nested Class Summary

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

SModel.Problem

Constructor Summary

Constructors

Constructor	Description
SModelDescriptorStub()

Method Summary

Modifier and Type	Method	Description
void	addDevKit(SModuleReference ref)
void	addEngagedOnGenerationLanguage(SLanguage lang)
void	addLanguage(SLanguage language)
void	addModelImport(SModelReference ref)	Tell one model depends from another.
void	addModelListener(SModelListener listener)
protected void	assertCanChange()	Invoked to check if it's legal to modify the model.
protected void	assertCanRead()	Invoked to check if it's legal to read from the model.
void	changeModelReference(SModelReference newModelReference)
protected void	clearListeners()
FastNodeFinder	createNodeFinder(SModel model)
void	deleteDevKit(SModuleReference ref)
void	deleteLanguageId(SLanguage ref)
void	deleteModelImport(SModelReference modelReference)
protected void	fireBeforeModelDisposed(SModel model)
protected void	fireBeforeModelFileChanged(SModelFileChangedEvent event)
protected void	fireBeforeModelRenamed(SModelRenamedEvent event)	Deprecated.
protected void	fireModelFileChanged(SModelFileChangedEvent event)
protected void	fireModelRenamed(SModelRenamedEvent event)	Deprecated.
protected void	fireModelSaved()
protected void	fireModelStateChanged(ModelLoadingState newState)	Deprecated. (a) we are in process to get rid of SModelListener; (b) this method used to change loading state in addition to event dispatch, and if you used to invoke it, please re-consider that code.
StackTraceElement[]	getDisposedStacktrace()
int	getLanguageImportVersion(SLanguage lang)
Collection<SLanguage>	getLanguagesEngagedOnGeneration()
ModelDependenciesManager	getModelDepsManager()	Deprecated. There's no reason to cast openapi.SModel to SModelDescriptorStub to get ModelDependenciesManager instance as it's no longer cached and provides no extra benefit compared to direct new ModelDependenciesManager(model).
Collection<SModelReference>	getModelImports()
List<SModelListener>	getModelListeners()
SModel	getSModel()	Use SModelBase.getModelData() wherever possible.
abstract SModel	getSModelInternal()	Deprecated. use SModelBase.getModelData() or getSModel() FIXME there's implicit convention that smodel.SModel has this openapi.SModel (aka descriptor) assigned once this method returns
List<SModuleReference>	importedDevkits()
Collection<SLanguage>	importedLanguageIds()
boolean	isDisposed()
void	removeEngagedOnGenerationLanguage(SLanguage lang)
void	removeModelListener(SModelListener listener)
void	setLanguageImportVersion(SLanguage language, int version)
boolean	updateExternalReferences(SRepository repo)	Model has a chance to bring its external dependencies to a state manifested by supplied repository

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

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

Constructor Detail

SModelDescriptorStub

public SModelDescriptorStub()

Method Detail

getSModelInternal

@Deprecated
public abstract SModel getSModelInternal()

Deprecated.

use SModelBase.getModelData() or getSModel() FIXME there's implicit convention that smodel.SModel has this openapi.SModel (aka descriptor) assigned once this method returns

Migration to 3.0. Loads and returns model data. FIXME Replace uses of this method with getSModel(), make it abstract and implement in SModelBase subclasses. The name getSModelInternal is misleading as it clashes with SModelInternal interface this class implements. Though getSModel is not much better, at least in the context of SModelDescriptor it makes more sense.

addModelListener

public void addModelListener(@NotNull
                             SModelListener listener)

Specified by:

addModelListener in interface SModelInternal

removeModelListener

public void removeModelListener(@NotNull
                                SModelListener listener)

Specified by:

removeModelListener in interface SModelInternal

getModelListeners

@NotNull
public List<SModelListener> getModelListeners()

clearListeners

protected void clearListeners()

fireBeforeModelFileChanged

protected void fireBeforeModelFileChanged(SModelFileChangedEvent event)

fireModelFileChanged

protected void fireModelFileChanged(SModelFileChangedEvent event)

fireBeforeModelRenamed

@Deprecated
protected void fireBeforeModelRenamed(SModelRenamedEvent event)

Deprecated.

fireModelRenamed

@Deprecated
protected void fireModelRenamed(SModelRenamedEvent event)

Deprecated.

fireModelStateChanged

@Deprecated
protected void fireModelStateChanged(ModelLoadingState newState)

Deprecated.

(a) we are in process to get rid of SModelListener; (b) this method used to change loading state in addition to event dispatch, and if you used to invoke it, please re-consider that code.

fireBeforeModelDisposed

protected void fireBeforeModelDisposed(SModel model)

fireModelSaved

protected void fireModelSaved()

getSModel

public SModel getSModel()

Use SModelBase.getModelData() wherever possible. Use this method when accessing implementation aspects of smodel.SModel that are not exposed through SModelInternal interface (for latter, use getSModelInternal() until ceased).

getModelDepsManager

@Deprecated
public final ModelDependenciesManager getModelDepsManager()

Deprecated.

There's no reason to cast openapi.SModel to SModelDescriptorStub to get ModelDependenciesManager instance as it's no longer cached and provides no extra benefit compared to direct new ModelDependenciesManager(model). Besides, use of ModelDependenciesManager is discouraged and ModelDependencyResolver shall be preferred.

importedLanguageIds

public Collection<SLanguage> importedLanguageIds()

Specified by:

importedLanguageIds in interface SModelInternal

deleteLanguageId

public void deleteLanguageId(@NotNull
                             SLanguage ref)

Specified by:

deleteLanguageId in interface SModelInternal

addLanguage

public void addLanguage(@NotNull
                        SLanguage language)

Specified by:

addLanguage in interface SModelInternal

setLanguageImportVersion

public void setLanguageImportVersion(@NotNull
                                     SLanguage language,
                                     int version)

Specified by:

setLanguageImportVersion in interface SModelInternal

getLanguageImportVersion

public int getLanguageImportVersion(SLanguage lang)

Specified by:

getLanguageImportVersion in interface SModelInternal

importedDevkits

public List<SModuleReference> importedDevkits()

Specified by:

importedDevkits in interface SModelInternal

addDevKit

public final void addDevKit(SModuleReference ref)

Specified by:

addDevKit in interface SModelInternal

deleteDevKit

public final void deleteDevKit(@NotNull
                               SModuleReference ref)

Specified by:

deleteDevKit in interface SModelInternal

getModelImports

@NotNull
public Collection<SModelReference> getModelImports()

Specified by:

getModelImports in interface SModelInternal

Returns:

collection of models this one depends from.

addModelImport

public final void addModelImport(@NotNull
                                 SModelReference ref)

Description copied from interface: SModelInternal

Tell one model depends from another.

Specified by:

addModelImport in interface SModelInternal

deleteModelImport

public final void deleteModelImport(SModelReference modelReference)

Specified by:

deleteModelImport in interface SModelInternal

getLanguagesEngagedOnGeneration

@NotNull
public Collection<SLanguage> getLanguagesEngagedOnGeneration()

Specified by:

getLanguagesEngagedOnGeneration in interface SModelInternal

addEngagedOnGenerationLanguage

public final void addEngagedOnGenerationLanguage(SLanguage lang)

Specified by:

addEngagedOnGenerationLanguage in interface SModelInternal

removeEngagedOnGenerationLanguage

public final void removeEngagedOnGenerationLanguage(SLanguage lang)

Specified by:

removeEngagedOnGenerationLanguage in interface SModelInternal

assertCanRead

protected void assertCanRead()

Invoked to check if it's legal to read from the model. By default, is no-op, subclasses shall override to enforce proper policy

assertCanChange

protected void assertCanChange()

Invoked to check if it's legal to modify the model. By default, is no-op, subclasses shall override to enforce proper policy

isDisposed

public boolean isDisposed()

Specified by:

isDisposed in interface ModelWithDisposeInfo

getDisposedStacktrace

public final StackTraceElement[] getDisposedStacktrace()

Specified by:

getDisposedStacktrace in interface ModelWithDisposeInfo

createNodeFinder

public FastNodeFinder createNodeFinder(@NotNull
                                       SModel model)

Specified by:

createNodeFinder in interface FastNodeFinder.Factory

updateExternalReferences

public final boolean updateExternalReferences(@NotNull
                                              SRepository repo)

Description copied from interface: SModelInternal

Model has a chance to bring its external dependencies to a state manifested by supplied repository

Specified by:

updateExternalReferences in interface SModelInternal

Returns:

true if anything has been changed

changeModelReference

public void changeModelReference(SModelReference newModelReference)

Specified by:

changeModelReference in interface SModelInternal