org.polarsys.capella.common.ef.command

Class AbstractCommand

java.lang.Object

org.polarsys.capella.common.ef.command.AbstractCommand

All Implemented Interfaces:

java.lang.Runnable, ICommand

Direct Known Subclasses:

AbstractCompoundCommand, AbstractReadWriteCommand

public abstract class AbstractCommand
extends java.lang.Object
implements ICommand

Base class to implement ICommand.

Constructor Summary

Constructors

Constructor and Description
AbstractCommand()

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() Default behavior returns an empty list.
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	isInterrupted()
boolean	isRolledBack()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.polarsys.capella.common.ef.command.ICommand

isReadOnly

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

AbstractCommand

public AbstractCommand()

Method Detail

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

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

isInterrupted

public boolean isInterrupted()

Returns:

true if command has been interrupted

isRolledBack

public boolean isRolledBack()

Returns:

true if command has been rolled back

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()

getName

public java.lang.String getName()

Get readable command name.

Specified by:

getName in interface ICommand

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getAffectedObjects

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

Default behavior returns an empty list.

Specified by:

getAffectedObjects in interface ICommand

Returns:

an empty list.