Package jetbrains.mps.smodel

Class ModelAccessBase

java.lang.Object

jetbrains.mps.smodel.ModelAccessBase

All Implemented Interfaces:

ModelAccess

Direct Known Subclasses:

GlobalModelAccess, ProjectModelAccess

public abstract class ModelAccessBase
extends Object
implements ModelAccess

ModelAccess basic implementation: all non-command methods are implemented here. Currently it delegates everything to the ModelAccess, it is planned to rewrite this class when multiple repositories are supported. Created by Alex Pyshkin on 9/3/14.

Constructor Summary

Constructors

Constructor	Description
ModelAccessBase()

Method Summary

Modifier and Type	Method	Description
void	addCommandListener(CommandListener listener)	add/remove listeners to listen to the start/finish of command events
void	addReadActionListener(ReadActionListener listener)	Get notified about start/finish of a model read action
void	addWriteActionListener(WriteActionListener listener)	add/remove listeners to listen to the start/finish of write action events
boolean	canRead()	Indicates, whether the current thread holds the read lock
boolean	canWrite()	Indicates, whether the current thread holds the write lock
void	checkReadAccess()	Fails with an exception, if the current thread does not hold the read lock
void	checkWriteAccess()	Fails with an exception, if the current thread does not hold the write lock
protected ModelAccess	getDelegate()
void	removeCommandListener(CommandListener listener)
void	removeReadActionListener(ReadActionListener listener)	Cease notifications about start/finish of a model read action
void	removeWriteActionListener(WriteActionListener listener)
void	runReadAction(Runnable r)	Querying properties of models can only be performed from within managed actions, which hold the appropriate read lock.
void	runReadInEDT(Runnable r)	Querying properties of models can only be performed from within managed actions, which hold the appropriate read lock.
void	runWriteAction(Runnable r)	Modifications to models can only be performed from within managed actions, which hold the appropriate write lock.
void	runWriteInEDT(Runnable r)	Modifications to models can only be performed from within managed actions, which hold the appropriate write lock.

Methods inherited from class java.lang.Object

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

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

executeCommand, executeCommandInEDT, executeUndoTransparentCommand, isCommandAction

Constructor Detail

ModelAccessBase

public ModelAccessBase()

Method Detail

canRead

public boolean canRead()

Description copied from interface: ModelAccess

Indicates, whether the current thread holds the read lock

Specified by:

canRead in interface ModelAccess

checkReadAccess

public void checkReadAccess()

Description copied from interface: ModelAccess

Fails with an exception, if the current thread does not hold the read lock

Specified by:

checkReadAccess in interface ModelAccess

canWrite

public boolean canWrite()

Description copied from interface: ModelAccess

Indicates, whether the current thread holds the write lock

Specified by:

canWrite in interface ModelAccess

checkWriteAccess

public void checkWriteAccess()

Description copied from interface: ModelAccess

Fails with an exception, if the current thread does not hold the write lock

Specified by:

checkWriteAccess in interface ModelAccess

runReadAction

public void runReadAction(Runnable r)

Description copied from interface: ModelAccess

Querying properties of models can only be performed from within managed actions, which hold the appropriate read lock. The method obtains such a lock and executes the provided action.

Specified by:

runReadAction in interface ModelAccess

runReadInEDT

public void runReadInEDT(Runnable r)

Description copied from interface: ModelAccess

Querying properties of models can only be performed from within managed actions, which hold the appropriate read lock. The method obtains such a lock and executes the provided action asynchronously on the EDT UI thread. Inside the action it is safe to touch any UI elements and perform other EDT-bound actions of the IntelliJ platform.

Specified by:

runReadInEDT in interface ModelAccess

runWriteAction

public void runWriteAction(Runnable r)

Description copied from interface: ModelAccess

Modifications to models can only be performed from within managed actions, which hold the appropriate write lock. The method obtains such a lock and executes the provided action. It should not be invoked from EDT, otherwise UI freeze may occur. Note: A lock cannot be upgraded. When owning the read lock it is not allowed to ask for the write lock through the runWriteAction() method.

Specified by:

runWriteAction in interface ModelAccess

runWriteInEDT

public void runWriteInEDT(Runnable r)

Description copied from interface: ModelAccess

Modifications to models can only be performed from within managed actions, which hold the appropriate write lock. The method obtains such a lock and executes the provided action asynchronously on the EDT UI thread. Inside the action it is safe to touch any UI elements and perform other EDT-bound actions of the IntelliJ platform.

Specified by:

runWriteInEDT in interface ModelAccess

addCommandListener

public void addCommandListener(CommandListener listener)

Description copied from interface: ModelAccess

add/remove listeners to listen to the start/finish of command events

Specified by:

addCommandListener in interface ModelAccess

Parameters:

listener - listens to command

See Also:

ModelAccess.executeCommand(Runnable)

removeCommandListener

public void removeCommandListener(CommandListener listener)

Specified by:

removeCommandListener in interface ModelAccess

addWriteActionListener

public void addWriteActionListener(@NotNull
                                   WriteActionListener listener)

Description copied from interface: ModelAccess

add/remove listeners to listen to the start/finish of write action events

Specified by:

addWriteActionListener in interface ModelAccess

Parameters:

listener - listens to write action

See Also:

ModelAccess.runWriteAction(Runnable)

removeWriteActionListener

public void removeWriteActionListener(@NotNull
                                      WriteActionListener listener)

Specified by:

removeWriteActionListener in interface ModelAccess

addReadActionListener

public void addReadActionListener(@NotNull
                                  ReadActionListener listener)

Description copied from interface: ModelAccess

Get notified about start/finish of a model read action

Specified by:

addReadActionListener in interface ModelAccess

removeReadActionListener

public void removeReadActionListener(@NotNull
                                     ReadActionListener listener)

Description copied from interface: ModelAccess

Cease notifications about start/finish of a model read action

Specified by:

removeReadActionListener in interface ModelAccess

getDelegate

protected final ModelAccess getDelegate()