Package jetbrains.mps.tool.environment

Class AbstractEnvironment

java.lang.Object

jetbrains.mps.tool.environment.AbstractEnvironment

All Implemented Interfaces:

Environment

public abstract class AbstractEnvironment
extends Object
implements Environment

Base implementation class for Environment without project handling or reference count, with mostly no-op or UnsupportedOperationException implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEnvironment(Platform mpsPlatform)

Method Summary

Modifier and Type	Method	Description
void	closeProject(Project project)	Discards previously opened project.
Project	createEmptyProject()	Creates and opens an empty project
Project	createProject(ProjectStrategy strategy)	Creates a project and opens it according to the given strategy
void	dispose()	disposes the environment for real, does not consider ref counts
void	flushAllEvents()	flushes all #invokeAndLater calls and all ModelAccess event queue if needed
Platform	getPlatform()
Project	openProject(File projectFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEnvironment

protected AbstractEnvironment(Platform mpsPlatform)

Method Detail

getPlatform

public Platform getPlatform()

Specified by:

getPlatform in interface Environment

Returns:

MPS (its platform aspect) of this tooling environment, not null when initialized.

createEmptyProject

@NotNull
public Project createEmptyProject()

Description copied from interface: Environment

Creates and opens an empty project

Specified by:

createEmptyProject in interface Environment

Returns:

newly created Project.

createProject

@NotNull
public Project createProject(@NotNull
                             ProjectStrategy strategy)

Description copied from interface: Environment

Creates a project and opens it according to the given strategy

Specified by:

createProject in interface Environment

Returns:

newly created Project constructed as the strategy suggests. It is already opened.

openProject

@NotNull
public Project openProject(@NotNull
                           File projectFile)

Specified by:

openProject in interface Environment

closeProject

public void closeProject(@NotNull
                         Project project)

Description copied from interface: Environment

Discards previously opened project. Environment does its best to close the project but may choose to ignore request in certain scenarions (like in-process test execution, when closing an active project may affect user experience)

Specified by:

closeProject in interface Environment

Parameters:

project - an instance obtained from Environment.openProject(java.io.File)

dispose

public void dispose()

Description copied from interface: Environment

disposes the environment for real, does not consider ref counts

Specified by:

dispose in interface Environment

flushAllEvents

public void flushAllEvents()

Description copied from interface: Environment

flushes all #invokeAndLater calls and all ModelAccess event queue if needed

Specified by:

flushAllEvents in interface Environment