|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.emf.common.command.AbstractCommand
org.eclipse.emf.mapping.command.RestoreInitialStateCommand
public class RestoreInitialStateCommand
The restore initial state command ensures that the mapping root is ready to begin a mapping session from a defined initial state. This implementation just deletes all the mappings, which is good for pure meet-in-the-middle mapping. For pure top down mapping, a derived implementation will want to reset the outputs.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.eclipse.emf.common.command.AbstractCommand |
|---|
AbstractCommand.NonDirtying |
| Field Summary | |
|---|---|
protected static java.lang.String |
DESCRIPTION
This cachaes the description. |
protected MappingDomain |
domain
This keeps track of the mapping domain in which the command operates. |
protected static java.lang.String |
LABEL
This caches the label. |
| Fields inherited from class org.eclipse.emf.common.command.AbstractCommand |
|---|
description, isExecutable, isPrepared, label |
| Constructor Summary | |
|---|---|
RestoreInitialStateCommand(MappingDomain domain)
This creates a command instance that removes the mappings in the collection from the mapping root. |
|
| Method Summary | |
|---|---|
static Command |
create(MappingDomain domain)
This creates a command that removes the mapping from the mapping root. |
void |
dispose()
Called to indicate that the command will never be used again. |
void |
execute()
Performs the command activity required for the effect. |
protected boolean |
prepare()
Called at most once in AbstractCommand.canExecute() to give the command an opportunity to ready itself for execution. |
void |
redo()
Performs the command activity required to redo the effect after undoing the effect. |
java.lang.String |
toString()
This gives an abbreviated name using this object's own class' name, without package qualification, followed by a space separated list of field:value pairs. |
void |
undo()
Throws a runtime exception. |
| Methods inherited from class org.eclipse.emf.common.command.AbstractCommand |
|---|
canExecute, canUndo, chain, getAffectedObjects, getDescription, getLabel, getResult, setDescription, setLabel |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected static final java.lang.String LABEL
protected static final java.lang.String DESCRIPTION
protected MappingDomain domain
| Constructor Detail |
|---|
public RestoreInitialStateCommand(MappingDomain domain)
| Method Detail |
|---|
public static Command create(MappingDomain domain)
protected boolean prepare()
AbstractCommandAbstractCommand.canExecute() to give the command an opportunity to ready itself for execution.
The returned value is stored in AbstractCommand.canExecute().
In other words, you can override this method to initialize
and to yield a cached value for the all subsequent calls to canExecute.
prepare in class AbstractCommandpublic void execute()
Commandexecute when canExecute returns false,
or when canExecute hasn't been called, is undefined.
public void undo()
AbstractCommand
undo in interface Commandundo in class AbstractCommandpublic void redo()
Commandredo the effect after undoing the effect.
The effect, if any, of calling redo before undo is called is undefined.
Note that if you implement redo to call execute
then any derived class will be restricted by that decision also.
public void dispose()
Command
dispose in interface Commanddispose in class AbstractCommandpublic java.lang.String toString()
toString in class AbstractCommand
|
Copyright 2001-2006 IBM Corporation and others. All Rights Reserved. |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||