Package jetbrains.mps.extapi.persistence

Class FileBasedModelRoot

java.lang.Object

jetbrains.mps.extapi.persistence.ModelRootBase

jetbrains.mps.extapi.persistence.FileBasedModelRoot

All Implemented Interfaces:

FileListener, FileSystemListener, ModelRoot

Direct Known Subclasses:

DefaultModelRoot, JavaClassStubsModelRoot

public abstract class FileBasedModelRoot
extends ModelRootBase
implements FileSystemListener

FileBasedModelRoot contains several SourceRoot which contain models. The source roots might be marked with a SourceRootKind which determine how do we treat the model files/folders we discover under those source roots.

The class is in the state of migration from String source roots to the interface SourceRoot that is why it is such a mess.

Paths represented by string either must have a clear contract (absolute, relative) or (better) replaced with some Path entities. AP

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTENT_PATH	This is a private model root persistence notation, ought to be concealed from the general public
static String	EXCLUDED	Deprecated. use SourceRootKinds.EXCLUDED instead
static String	LOCATION
static String	SOURCE_ROOTS	Deprecated. use SourceRootKinds.SOURCES instead

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileBasedModelRoot()
protected	FileBasedModelRoot(String[] supportedFileKinds)	Deprecated. use FileBasedModelRoot() instead and define your own getSupportedFileKinds1()

Method Summary

Modifier and Type	Method	Description
void	addFile(String kind, String filePath)	Deprecated. use addSourceRoot(SourceRootKind, SourceRoot) instead
void	addSourceRoot(SourceRootKind kind, SourceRoot root)
void	attach()
boolean	containsFile(String kind, String file)	Deprecated. use getSourceRoots(SourceRootKind) + List.contains(java.lang.Object).
void	deleteFile(String kind, String file)	Deprecated. use removeSourceRoot(SourceRoot) instead
void	dispose()
boolean	equals(Object o)
IFile	getContentDirectory()
String	getContentRoot()	Deprecated. use getContentDirectory() instead
Collection<String>	getFiles(String kind)	Deprecated. use getSourceRoots(SourceRootKind) instead
FileSystem	getFileSystem()
IFile	getFileToListen()
String	getPresentation()	A textual representation of the model root TODO what is the difference with the Object.toString()?? TODO very ambiguous in API: is it to be used in UI? somewhere else? TODO one needs to clarify or replace it with a prosy #getName
List<SourceRoot>	getSourceRoots(SourceRootKind kind)
Collection<String>	getSupportedFileKinds()	Deprecated. String is not the best choice.
List<SourceRootKind>	getSupportedFileKinds1()	To become abstract in the 3.5
int	hashCode()
void	load(Memento memento)	Allows the model root to read its previously saved configuration information
static String	relativize(String fullPath, String contentHomePath)
static String	relativize(String fullPath, IFile contentHome)
SourceRootKind	removeSourceRoot(SourceRoot root)
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.
void	setContentDirectory(IFile contentDir)
void	setContentRoot(String path)	Deprecated. use setContentDirectory(IFile) instead
void	update(ProgressMonitor monitor, FileSystemEvent event)	listener gets here all the events

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

assertCanChange, assertCanRead, canCreateModels, getModels, getModule, getRepository, isRegistered, loadModels, 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

Methods inherited from interface org.jetbrains.mps.openapi.persistence.ModelRoot

canCreateModel, createModel, getModel, getType

Field Detail

SOURCE_ROOTS

@Deprecated
public static final String SOURCE_ROOTS

Deprecated.

use SourceRootKinds.SOURCES instead

See Also:

Constant Field Values

EXCLUDED

@Deprecated
public static final String EXCLUDED

Deprecated.

use SourceRootKinds.EXCLUDED instead

See Also:

Constant Field Values

CONTENT_PATH

public static final String CONTENT_PATH

This is a private model root persistence notation, ought to be concealed from the general public

See Also:

Constant Field Values

LOCATION

public static final String LOCATION

See Also:

Constant Field Values

Constructor Detail

FileBasedModelRoot

protected FileBasedModelRoot()

FileBasedModelRoot

@Deprecated
protected FileBasedModelRoot(String[] supportedFileKinds)

Deprecated.

use FileBasedModelRoot() instead and define your own getSupportedFileKinds1()

Method Detail

getContentRoot

@Deprecated
@Nullable
public final String getContentRoot()

Deprecated.

use getContentDirectory() instead

setContentRoot

@Deprecated
public final void setContentRoot(@NotNull
                                 String path)

Deprecated.

use setContentDirectory(IFile) instead

getContentDirectory

@Nullable
public final IFile getContentDirectory()

setContentDirectory

public final void setContentDirectory(@NotNull
                                      IFile contentDir)

getFileSystem

@NotNull
public final FileSystem getFileSystem()

getSupportedFileKinds1

@NotNull
public List<SourceRootKind> getSupportedFileKinds1()

To become abstract in the 3.5

getSourceRoots

@NotNull
public final List<SourceRoot> getSourceRoots(@NotNull
                                             SourceRootKind kind)

Returns:

SourceRoots of the specified kind They might contain relative paths (unlike the legacy counterpart method!!). FBModelRoot is going to store relative path, all we need is some api to provide relative path instances. Now we do not have such abstraction since IFile is effectively absolute (just since the idea's VirtualFile is absolute as well).

AP

addSourceRoot

public final void addSourceRoot(@NotNull
                                SourceRootKind kind,
                                @NotNull
                                SourceRoot root)

removeSourceRoot

@Nullable
public final SourceRootKind removeSourceRoot(@NotNull
                                             SourceRoot root)

Returns:

the FileKind of the removed SourceRoot if it was successfully removed.

getSupportedFileKinds

@Deprecated
public final Collection<String> getSupportedFileKinds()

Deprecated.

String is not the best choice. Consider using getSupportedFileKinds1()

See Also:

SourcePaths

getFiles

@NotNull
@Deprecated
public final Collection<String> getFiles(@NotNull
                                         String kind)

Deprecated.

use getSourceRoots(SourceRootKind) instead

containsFile

@Deprecated
public final boolean containsFile(String kind,
                                  String file)

Deprecated.

use getSourceRoots(SourceRootKind) + List.contains(java.lang.Object).

addFile

@Deprecated
public final void addFile(String kind,
                          String filePath)

Deprecated.

use addSourceRoot(SourceRootKind, SourceRoot) instead

deleteFile

@Deprecated
public final void deleteFile(String kind,
                             String file)

Deprecated.

use removeSourceRoot(SourceRoot) instead

getPresentation

public final String getPresentation()

Description copied from interface: ModelRoot

A textual representation of the model root TODO what is the difference with the Object.toString()?? TODO very ambiguous in API: is it to be used in UI? somewhere else? TODO one needs to clarify or replace it with a prosy #getName

Specified by:

getPresentation in interface ModelRoot

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

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

attach

public void attach()

Overrides:

attach in class ModelRootBase

dispose

public void dispose()

Overrides:

dispose in class ModelRootBase

getFileToListen

public final IFile getFileToListen()

Specified by:

getFileToListen in interface FileSystemListener

update

public void update(ProgressMonitor monitor,
                   @NotNull
                   FileSystemEvent event)

Description copied from interface: FileListener

listener gets here all the events

Specified by:

update in interface FileListener

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

relativize

@NotNull
public static String relativize(@NotNull
                                String fullPath,
                                @NotNull
                                IFile contentHome)

relativize

@NotNull
public static String relativize(@NotNull
                                String fullPath,
                                @NotNull
                                String contentHomePath)