org.polarsys.capella.common.ef.command

Class AbstractReadOnlyCommand

java.lang.Object

org.eclipse.emf.transaction.RunnableWithResult.Impl

org.polarsys.capella.common.ef.command.AbstractReadOnlyCommand

All Implemented Interfaces:

java.lang.Runnable, org.eclipse.emf.transaction.RunnableWithResult, ICommand

public abstract class AbstractReadOnlyCommand
extends org.eclipse.emf.transaction.RunnableWithResult.Impl
implements ICommand

A command that accesses model objects in read-only mode.
Also allows to set a result through the RunnableWithResult.Impl.setResult(Object) method in the Runnable.run() method implementation.
This result can then be read at the end of the call, using the RunnableWithResult.Impl.getResult() method.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.transaction.RunnableWithResult

org.eclipse.emf.transaction.RunnableWithResult.Impl<T>

Constructor Summary

Constructors

Constructor and Description
AbstractReadOnlyCommand()

Method Summary

Modifier and Type	Method and Description
void	commandInterrupted() Command has been interrupted. Implementation is free to take any action that seems necessary.
void	commandRolledBack() Command has been rolled back. Implementation is free to take any action that seems necessary.
java.util.Collection<?>	getAffectedObjects() Not applicable for read only command.
java.util.Map	getExecutionOptions() Get the execution options map. TransactionalCommandStack.execute(org.eclipse.emf.common.command.Command, Map).
java.lang.String	getName() Get readable command name.
boolean	isReadOnly() Is the command only reading model objects or is it modifying any of them ?
java.lang.String	toString()

Methods inherited from class org.eclipse.emf.transaction.RunnableWithResult.Impl

getResult, getStatus, setStatus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

AbstractReadOnlyCommand

public AbstractReadOnlyCommand()

Method Detail

isReadOnly

public boolean isReadOnly()

Description copied from interface: ICommand

Is the command only reading model objects or is it modifying any of them ?

Specified by:

isReadOnly in interface ICommand

Returns:

true if read only, false if any model object is modified by the command.

See Also:

ICommand.isReadOnly()

commandInterrupted

public void commandInterrupted()

Description copied from interface: ICommand

Command has been interrupted.
Implementation is free to take any action that seems necessary.

Specified by:

commandInterrupted in interface ICommand

See Also:

ICommand.commandInterrupted()

commandRolledBack

public void commandRolledBack()

Description copied from interface: ICommand

Command has been rolled back.
Implementation is free to take any action that seems necessary.

Specified by:

commandRolledBack in interface ICommand

See Also:

ICommand.commandRolledBack()

getExecutionOptions

public java.util.Map getExecutionOptions()

Description copied from interface: ICommand

Get the execution options map.
TransactionalCommandStack.execute(org.eclipse.emf.common.command.Command, Map).

Specified by:

getExecutionOptions in interface ICommand

Returns:

can be null if default options are acceptable.

See Also:

ICommand.getExecutionOptions()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getName

public java.lang.String getName()

Description copied from interface: ICommand

Get readable command name.

Specified by:

getName in interface ICommand

Returns:

See Also:

ICommand.getName()

getAffectedObjects

public final java.util.Collection<?> getAffectedObjects()

Not applicable for read only command.

Specified by:

getAffectedObjects in interface ICommand

Returns:

an empty list.