Package jetbrains.mps.generator

Class TransientModelsModule

java.lang.Object

jetbrains.mps.extapi.module.SModuleBase

jetbrains.mps.project.AbstractModule

jetbrains.mps.generator.TransientModelsModule

All Implemented Interfaces:

EditableSModule, TransientSModule, SModule

public class TransientModelsModule
extends AbstractModule
implements TransientSModule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TransientModelsModule.TransientSModelDescriptor

Nested classes/interfaces inherited from class jetbrains.mps.project.AbstractModule

AbstractModule.LangAndDevkits

Field Summary

Fields inherited from class jetbrains.mps.project.AbstractModule

CLASSES, CLASSES_GEN, MODULE_DIR

Fields inherited from class jetbrains.mps.extapi.module.SModuleBase

MODEL_BY_NAME_COMPARATOR

Method Summary

Modifier and Type	Method	Description
boolean	addModelToKeep(SModelReference modelReference, boolean force)
void	changeModelReference(SModel transientModel, SModelReference newRef)
void	clearAll()
void	clearUnused()
SModel	createTransientModel(SModelReference modelReference)
SModel	createTransientModel(SModelReference modelReference, int branchSerial)
void	dispose()
void	forgetModel(SModel model, boolean forgetDependants)
Iterable<SDependency>	getDeclaredDependencies()	Module of any referenced model we can access through our repository (one of TransientModelsProvider) is deemed declared dependency.
SModel	getModel(SModelId id)	FIXME document whether this method required model read Retrieves a module's model by id
GenerationTrace	getTrace(SModelReference model)
boolean	hasPublished()
boolean	isMyTransientModel(SModelReference modelRef)
SModelId.IntegerSModelId	nextModelId(int idHint)
void	publishAll()
void	publishTrace(SModelReference model, GenerationTrace trace)
void	removeAll()
void	removeModel(SModel md)
String	toString()

Methods inherited from class jetbrains.mps.project.AbstractModule

addDependency, attach, collectLanguagesAndDevkits, collectMandatoryFacetTypes, dependenciesChanged, doSetModuleDescriptor, getDependencyVersion, getDependencyVersion, getDescriptorFile, getFacet, getFacets, getFileSystem, getModelRoots, getModuleDescriptor, getModuleId, getModuleName, getModuleReference, getModuleSourceDir, getModuleVersion, getOutputPath, getScope, getSourcePaths, getUsedLanguages, getUsedLanguageVersion, getUsedLanguageVersion, handleReadProblem, isChanged, isPackaged, isReadOnly, loadRoots, onModuleLoad, reloadAfterDescriptorChange, removeDependency, rename, renameModels, save, setChanged, setModuleDescriptor, setModuleDescriptor, setModuleReference, setModuleVersion, setupFacet, updateExternalReferences, updateFacets, updateModelsSet, updatePackagedDescriptor

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

addModuleListener, assertCanChange, assertCanRead, fireBeforeModelRenamed, fireChanged, fireModelRenamed, fireModuleRenamed, getModels, getRepository, registerModel, removeModuleListener, unregisterModel

Methods inherited from class java.lang.Object

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

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

addModuleListener, getFacet, getFacets, getModelRoots, getModels, getModels, getModuleId, getModuleName, getModuleReference, getRepository, getUsedLanguages, getUsedLanguageVersion, isPackaged, isReadOnly, removeModuleListener

Method Detail

hasPublished

public boolean hasPublished()

dispose

public void dispose()

Overrides:

dispose in class AbstractModule

clearAll

public void clearAll()

removeAll

public void removeAll()

clearUnused

public void clearUnused()

addModelToKeep

public boolean addModelToKeep(@NotNull
                              SModelReference modelReference,
                              boolean force)

forgetModel

public void forgetModel(SModel model,
                        boolean forgetDependants)

removeModel

public void removeModel(SModel md)

publishAll

public void publishAll()

createTransientModel

public SModel createTransientModel(SModelReference modelReference)

createTransientModel

public SModel createTransientModel(SModelReference modelReference,
                                   int branchSerial)

toString

public String toString()

Overrides:

toString in class AbstractModule

getModel

public SModel getModel(SModelId id)

Description copied from interface: SModule

FIXME document whether this method required model read Retrieves a module's model by id

Specified by:

getModel in interface SModule

Overrides:

getModel in class SModuleBase

isMyTransientModel

public boolean isMyTransientModel(SModelReference modelRef)

nextModelId

public SModelId.IntegerSModelId nextModelId(int idHint)

Parameters:

idHint - 5 hex digits for your own use, not necessarily unique for models from this module

Returns:

simple integer id unique within this module, with value from MPS reserved range SModelId.IntegerSModelId

getDeclaredDependencies

public Iterable<SDependency> getDeclaredDependencies()

Module of any referenced model we can access through our repository (one of TransientModelsProvider) is deemed declared dependency. There's little value to show 'out of scope' errors for transient nodes, that's why everything is here. It used to be GMDM(originalModule, Compile), but I don't see any reason for that.

Specified by:

getDeclaredDependencies in interface SModule

Overrides:

getDeclaredDependencies in class AbstractModule

getTrace

public GenerationTrace getTrace(SModelReference model)

publishTrace

public void publishTrace(@NotNull
                         SModelReference model,
                         @NotNull
                         GenerationTrace trace)

changeModelReference

public void changeModelReference(@NotNull
                                 SModel transientModel,
                                 @NotNull
                                 SModelReference newRef)