Package jetbrains.mps.persistence.java.library

Class JavaClassStubsModelRoot

java.lang.Object

jetbrains.mps.extapi.persistence.ModelRootBase

jetbrains.mps.extapi.persistence.FileBasedModelRoot

jetbrains.mps.persistence.java.library.JavaClassStubsModelRoot

All Implemented Interfaces:

CopyableModelRoot<JavaClassStubsModelRoot>, FileListener, FileSystemListener, ModelRoot

public class JavaClassStubsModelRoot
extends FileBasedModelRoot
implements CopyableModelRoot<JavaClassStubsModelRoot>

Field Summary

Fields inherited from class jetbrains.mps.extapi.persistence.FileBasedModelRoot

CONTENT_PATH, EXCLUDED, LOCATION, SOURCE_ROOTS

Constructor Summary

Constructors

Constructor	Description
JavaClassStubsModelRoot()

Method Summary

Modifier and Type	Method	Description
boolean	canCreateModel(String string)
boolean	canCreateModels()	There are model roots which are read-only and fix the result of ModelRoot.getModels() right away from the construction FIXME it is strange to have two similar methods: we are better to merge this method into the method ModelRoot.canCreateModel(java.lang.String).
void	copyTo(JavaClassStubsModelRoot targetModelRoot)	Copies this model root contents to the targetModelRoot.
SModel	createModel(String string)	Creates a new model with the given name.
SModel	getModel(SModelId id)
void	getModelDescriptors(List<SModel> result, IFile file, String prefix, SModule module)
String	getType()	A customizable categorization identifier, such as JavaStubs
void	load(Memento memento)	Allows the model root to read its previously saved configuration information
Iterable<SModel>	loadModels()	returns all models under the model root if some model is already loaded and registered, it is recommended to return the loaded one instead of loading another time
void	save(Memento memento)	Gives the model root the opportunity to persist into the supplied memento whatever configuration information may be needed to restore the models in the future.

Methods inherited from class jetbrains.mps.extapi.persistence.FileBasedModelRoot

addFile, addSourceRoot, attach, containsFile, deleteFile, dispose, equals, getContentDirectory, getContentRoot, getFiles, getFileSystem, getFileToListen, getPresentation, getSourceRoots, getSupportedFileKinds, getSupportedFileKinds1, hashCode, relativize, relativize, removeSourceRoot, setContentDirectory, setContentRoot, update

Methods inherited from class jetbrains.mps.extapi.persistence.ModelRootBase

assertCanChange, assertCanRead, getModels, getModule, getRepository, isRegistered, registerModel, setModule, toString, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jetbrains.mps.vfs.refresh.FileListener

listeningPreferences

Methods inherited from interface jetbrains.mps.vfs.refresh.FileSystemListener

getListenerDependencies

Constructor Detail

JavaClassStubsModelRoot

public JavaClassStubsModelRoot()

Method Detail

getType

public String getType()

Description copied from interface: ModelRoot

A customizable categorization identifier, such as JavaStubs

Specified by:

getType in interface ModelRoot

getModel

public SModel getModel(@NotNull
                       SModelId id)

Specified by:

getModel in interface ModelRoot

Returns:

the model with a given id one-to-one relation is assumed

load

public void load(@NotNull
                 Memento memento)

Description copied from interface: ModelRoot

Allows the model root to read its previously saved configuration information

Specified by:

load in interface ModelRoot

Overrides:

load in class FileBasedModelRoot

save

public void save(@NotNull
                 Memento memento)

Description copied from interface: ModelRoot

Gives the model root the opportunity to persist into the supplied memento whatever configuration information may be needed to restore the models in the future.

Specified by:

save in interface ModelRoot

Overrides:

save in class FileBasedModelRoot

loadModels

@NotNull
public Iterable<SModel> loadModels()

Description copied from class: ModelRootBase

returns all models under the model root if some model is already loaded and registered, it is recommended to return the loaded one instead of loading another time

Specified by:

loadModels in class ModelRootBase

Returns:

a sequence of models

canCreateModels

public boolean canCreateModels()

Description copied from interface: ModelRoot

There are model roots which are read-only and fix the result of ModelRoot.getModels() right away from the construction FIXME it is strange to have two similar methods: we are better to merge this method into the method ModelRoot.canCreateModel(java.lang.String).

Specified by:

canCreateModels in interface ModelRoot

Overrides:

canCreateModels in class ModelRootBase

Returns:

whether this model root is read-only in the way described above

canCreateModel

public boolean canCreateModel(@NotNull
                              String string)

Specified by:

canCreateModel in interface ModelRoot

Parameters:

string - -- the same as in the ModelRoot.createModel(String)

Returns:

whether a model with a name modelName can be created under this model root.

createModel

public SModel createModel(@NotNull
                          String string)

Description copied from interface: ModelRoot

Creates a new model with the given name. The new model will be contained in this model root (methods #getModel, #getModels).

Specified by:

createModel in interface ModelRoot

Parameters:

string - -- might fq name or just simple short model name. Up to implementor

See Also:

// * @deprecated // * @return null if failed, for instance returned false.

getModelDescriptors

public void getModelDescriptors(List<SModel> result,
                                IFile file,
                                String prefix,
                                SModule module)

copyTo

public void copyTo(@NotNull
                   JavaClassStubsModelRoot targetModelRoot)
            throws CopyNotSupportedException

Description copied from interface: CopyableModelRoot

Copies this model root contents to the targetModelRoot. the resulting model root must be equal to the prototype

Specified by:

copyTo in interface CopyableModelRoot<JavaClassStubsModelRoot>

Throws:

CopyNotSupportedException