Package jetbrains.mps.generator

Class TransientModelsModule.TransientSModelDescriptor

java.lang.Object

jetbrains.mps.extapi.model.SModelDescriptorStub

jetbrains.mps.extapi.model.SModelBase

jetbrains.mps.extapi.model.EditableSModelBase

jetbrains.mps.generator.TransientModelsModule.TransientSModelDescriptor

All Implemented Interfaces:

ModelWithAttributes, ModelWithDisposeInfo, TransientSModel, FastNodeFinder.Factory, SModelInternal, EditableSModel, SModel

Enclosing class:

TransientModelsModule

public final class TransientModelsModule.TransientSModelDescriptor
extends EditableSModelBase
implements TransientSModel, ModelWithAttributes

Nested Class Summary

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

SModel.Problem

Field Summary

Fields

Modifier and Type	Field	Description
protected TransientSModel	mySModel

Fields inherited from class jetbrains.mps.extapi.model.EditableSModelBase

myTimestampTracker

Method Summary

Modifier and Type	Method	Description
protected void	assertCanChange()	Invoked to check if it's legal to modify the model.
protected void	doUnload()	Perform actual dispose of model data and SModelBase.setLoadingState(ModelLoadingState) changes loading state}.
void	forEach(BiConsumer<String,String> action)	Iterate over all available attributes.
String	getAttribute(String key)	Retrieve extra model data.
int	getBranchSerial()
protected SModel	getCurrentModelInternal()	Likely, shall return SModelData eventually
SModule	getModule()	TODO make final
SModel	getSModelInternal()	Migration to 3.0.
boolean	isChanged()
void	makeRefsMature()
protected void	reloadContents()
void	rename(String newModelName, boolean changeFile)
protected boolean	saveModel()	returns true if the content should be reloaded from storage after save
void	setAttribute(String key, String value)	Record extra data with a model

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

addChangeListener, addRootNode, attach, detach, isReadOnly, needsReloading, reloadFromSource, removeChangeListener, removeRootNode, resolveDiskConflict, save, setChanged, toString, unload, updateTimestamp

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

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

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, wait, wait, wait

Methods inherited from interface jetbrains.mps.extapi.model.ModelWithAttributes

getAttribute

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

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

Field Detail

mySModel

protected volatile TransientSModel mySModel

Method Detail

getBranchSerial

public int getBranchSerial()

getCurrentModelInternal

protected SModel getCurrentModelInternal()

Description copied from class: SModelBase

Likely, shall return SModelData eventually

Specified by:

getCurrentModelInternal in class SModelBase

Returns:

actual model data or null if not initialized yet

getSModelInternal

public final SModel getSModelInternal()

Description copied from class: SModelDescriptorStub

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.

Specified by:

getSModelInternal in class SModelDescriptorStub

assertCanChange

protected void assertCanChange()

Description copied from class: SModelDescriptorStub

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

Overrides:

assertCanChange in class SModelBase

doUnload

protected void doUnload()

Description copied from class: SModelBase

Perform actual dispose of model data and SModelBase.setLoadingState(ModelLoadingState) changes loading state}. No loading state event is sent (responsibility of SModelBase.unload(). Subclasses shall override to clean instance fields and generally shall delegate to this implementation first to dispose model data.

Overrides:

doUnload in class SModelBase

getModule

public SModule getModule()

Description copied from class: SModelBase

TODO make final

Specified by:

getModule in interface SModel

Overrides:

getModule in class SModelBase

isChanged

public boolean isChanged()

Specified by:

isChanged in interface EditableSModel

Overrides:

isChanged in class EditableSModelBase

saveModel

protected boolean saveModel()

Description copied from class: EditableSModelBase

returns true if the content should be reloaded from storage after save

Specified by:

saveModel in class EditableSModelBase

rename

public void rename(String newModelName,
                   boolean changeFile)

Specified by:

rename in interface EditableSModel

Overrides:

rename in class EditableSModelBase

reloadContents

protected void reloadContents()

Specified by:

reloadContents in class EditableSModelBase

makeRefsMature

public void makeRefsMature()

setAttribute

public void setAttribute(@NotNull
                         String key,
                         @Nullable
                         String value)

Description copied from interface: ModelWithAttributes

Record extra data with a model

Specified by:

setAttribute in interface ModelWithAttributes

Parameters:

key - attribute identity

value - attribute value, or null do remove an attribute, if any.

getAttribute

@Nullable
public String getAttribute(@NotNull
                           String key)

Description copied from interface: ModelWithAttributes

Retrieve extra model data.

Specified by:

getAttribute in interface ModelWithAttributes

Parameters:

key - attribute identity. There's no penalty if the key is unknown/unsupported with this model implementation

Returns:

null if there's no value for the key.

forEach

public void forEach(@NotNull
                    BiConsumer<String,String> action)

Description copied from interface: ModelWithAttributes

Iterate over all available attributes. Generally, not present attributes are not reported, however, clients shall expect null values, and implementation may report missing/deleted attributes. For now, the contract is action shall not modify attributes, we might relax this in future (i.e. iterate over a copy of internal storage), if there are scenarios we find it handy.

Specified by:

forEach in interface ModelWithAttributes

Parameters:

action - action to perform for each key-value attribute pair