Package jetbrains.mps.smodel

Class AbstractModelAccess

java.lang.Object

jetbrains.mps.smodel.AbstractModelAccess

All Implemented Interfaces:

ModelAccess

Direct Known Subclasses:

ModelAccess

public abstract class AbstractModelAccess
extends Object
implements ModelAccess

Base class for implementations of ModelAccess. Unlike ModelAccessBase, is pure implementation of the interface and doesn't care about ModelAccess.instance() existence.

Since:

2017.3

Field Summary

Fields

Modifier and Type	Field	Description
protected jetbrains.mps.smodel.ActionDispatcher<CommandListener>	myCommandActionDispatcher	Implementation of ModelAccess.executeCommand(Runnable) and ModelAccess.executeCommandInEDT(Runnable) shall dispatch actions through ActionDispatcher.dispatch(Runnable) method of this field to get proper notifications for CommandListener
protected jetbrains.mps.smodel.ActionDispatcher<ReadActionListener>	myReadActionDispatcher
protected jetbrains.mps.smodel.ActionDispatcher<WriteActionListener>	myWriteActionDispatcher	Implementation of ModelAccess.runWriteAction(Runnable) and ModelAccess.runWriteInEDT(Runnable) shall dispatch actions through ActionDispatcher.dispatch(Runnable) method of this field to get proper notifications for WriteActionListener

Constructor Summary

Constructors

Constructor	Description
AbstractModelAccess()

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
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 void	onCommandFinished()
protected void	onCommandStarted()
void	removeCommandListener(CommandListener listener)
void	removeReadActionListener(ReadActionListener listener)	Cease notifications about start/finish of a model read action
void	removeWriteActionListener(WriteActionListener listener)

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

canRead, canWrite, executeCommand, executeCommandInEDT, executeUndoTransparentCommand, isCommandAction, runReadAction, runReadInEDT, runWriteAction, runWriteInEDT

Field Detail

myReadActionDispatcher

protected final jetbrains.mps.smodel.ActionDispatcher<ReadActionListener> myReadActionDispatcher

myCommandActionDispatcher

protected final jetbrains.mps.smodel.ActionDispatcher<CommandListener> myCommandActionDispatcher

Implementation of ModelAccess.executeCommand(Runnable) and ModelAccess.executeCommandInEDT(Runnable) shall dispatch actions through ActionDispatcher.dispatch(Runnable) method of this field to get proper notifications for CommandListener

myWriteActionDispatcher

protected final jetbrains.mps.smodel.ActionDispatcher<WriteActionListener> myWriteActionDispatcher

Implementation of ModelAccess.runWriteAction(Runnable) and ModelAccess.runWriteInEDT(Runnable) shall dispatch actions through ActionDispatcher.dispatch(Runnable) method of this field to get proper notifications for WriteActionListener

Constructor Detail

AbstractModelAccess

public AbstractModelAccess()

Method Detail

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

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

onCommandStarted

protected void onCommandStarted()

onCommandFinished

protected void onCommandFinished()

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