Package jetbrains.mps.project

Class Project

java.lang.Object

jetbrains.mps.project.Project

All Implemented Interfaces:

IProject, MPSModuleOwner, Project

Direct Known Subclasses:

ProjectBase

public abstract class Project
extends Object
implements MPSModuleOwner, IProject

MPS Project abstraction. Project may rely on the idea Project or it may not. It has a scope and a corresponding project repository to store modules in it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Project.ProjectScope

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Project(String name)
protected	Project(String name, Function<Project,ProjectRepository> repoFactory)	Deprecated. this is an ugly way to pass Project instance into ProjectRepository cons

Method Summary

Modifier and Type	Method	Description
void	dispose()	closes and disposes the project
abstract <T> T	getComponent(Class<T> t)	Generic extension mechanism
ModelAccess	getModelAccess()	Shorthand for getRepository().getModelAccess()
Iterable<? extends SModule>	getModules()	Deprecated. use {@link #getProjectModules)} instead AP fixme : why to return Iterable? isn't it easier to give out a collection, e.g.
Iterable<? extends SModule>	getModulesWithGenerators()	Deprecated. use getProjectModulesWithGenerators() instead
abstract String	getName()
File	getProjectFile()	Deprecated. the project is not necessarily backed up by file.
Iterable<SModel>	getProjectModels()
<T extends SModule> List<T>	getProjectModules(Class<T> moduleClass)	Note, call #getProjectModules(SModule.class) is ambiguous, as it doesn't return generators that live under a project's language despite the fact Generator is instaoce of SModule, indeed.
List<SModule>	getProjectModulesWithGenerators()
SRepository	getRepository()
Project.ProjectScope	getScope()
protected void	initRepository(ProjectRepository repository)
boolean	isDisposed()
boolean	isHidden()
boolean	isProjectModule(SModule module)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.mps.project.IProject

addModule, getProjectModules, removeModule

Methods inherited from interface org.jetbrains.mps.openapi.project.Project

isOpened

Constructor Detail

Project

protected Project(String name)

Project

@Deprecated
protected Project(String name,
                  @NotNull
                  Function<Project,ProjectRepository> repoFactory)

Deprecated.

this is an ugly way to pass Project instance into ProjectRepository cons

Method Detail

initRepository

protected final void initRepository(@NotNull
                                    ProjectRepository repository)

getScope

@NotNull
public final Project.ProjectScope getScope()

Specified by:

getScope in interface IProject

Returns:

scope with all the modules from the project, including generators.

getRepository

@NotNull
public final SRepository getRepository()

Specified by:

getRepository in interface IProject

Specified by:

getRepository in interface Project

Returns:

the project repository which contains all the project modules

getModelAccess

@NotNull
public final ModelAccess getModelAccess()

Shorthand for getRepository().getModelAccess()

Specified by:

getModelAccess in interface IProject

Specified by:

getModelAccess in interface Project

Returns:

access facility to models coming from a repository associated with this project.

getName

@NotNull
public abstract String getName()

Specified by:

getName in interface IProject

Specified by:

getName in interface Project

Returns:

the name of the project

getComponent

public abstract <T> T getComponent(Class<T> t)

Description copied from interface: IProject

Generic extension mechanism

Specified by:

getComponent in interface IProject

Returns:

component instance or null if no extension of specified kind found.

getProjectFile

@Deprecated
public File getProjectFile()

Deprecated.

the project is not necessarily backed up by file. Left for compatibility

See Also:

FileBasedProject

getModules

@NotNull
@Deprecated
public final Iterable<? extends SModule> getModules()

Deprecated.

use {@link #getProjectModules)} instead AP fixme : why to return Iterable? isn't it easier to give out a collection, e.g. a list?

getProjectModulesWithGenerators

@NotNull
public final List<SModule> getProjectModulesWithGenerators()

getModulesWithGenerators

@Deprecated
@NotNull
public final Iterable<? extends SModule> getModulesWithGenerators()

Deprecated.

use getProjectModulesWithGenerators() instead

isProjectModule

public final boolean isProjectModule(@NotNull
                                     SModule module)

getProjectModules

@NotNull
public final <T extends SModule> List<T> getProjectModules(Class<T> moduleClass)

Note, call #getProjectModules(SModule.class) is ambiguous, as it doesn't return generators that live under a project's language despite the fact Generator is instaoce of SModule, indeed.

getProjectModels

public final Iterable<SModel> getProjectModels()

isHidden

public final boolean isHidden()

Specified by:

isHidden in interface MPSModuleOwner

Returns:

the 'hidden' status for the different kinds of owners. visibility has strict definition here, however I suppose that the owner is hidden implicates that its modules are not visible to a user (module properties dialog, etc.).

toString

@NotNull
public String toString()

Overrides:

toString in class Object

dispose

public void dispose()

closes and disposes the project

isDisposed

public boolean isDisposed()