org.eclipse.emf.mapping.command
Class AddMappingCommand

java.lang.Object
  org.eclipse.emf.common.command.AbstractCommand
      org.eclipse.emf.mapping.command.AddMappingCommand

All Implemented Interfaces:

Command

public class AddMappingCommand
extends AbstractCommand

The create mapping command creates a new mapping in a MappingDomain from a set of the domain's input and output objects.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.emf.common.command.AbstractCommand

AbstractCommand.NonDirtying

Field Summary

protected java.util.Collection<?>	collection This keeps track of the input and output objects that are to be mapped.
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

AddMappingCommand(MappingDomain domain, java.util.Collection<?> collection)
This creates a command instance that adds the new mappings in the collection into the appropriate place in the mapping root's.

Method Summary

static Command	create(MappingDomain domain, java.util.Collection<?> collection) This creates a command that adds the new mappings in the collection into the appropriate place in the mapping root's.
static Command	create(MappingDomain domain, Mapping mapping) This creates a command that adds the new mappings in the collection into the appropriate place in the mapping root's.
void	dispose() Called to indicate that the command will never be used again.
void	execute() Performs the command activity required for the effect.
java.util.Collection<?>	getAffectedObjects() Returns an empty list.
java.util.Collection<?>	getResult() Returns an empty list.
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, getDescription, getLabel, setDescription, setLabel

Methods inherited from class java.lang.Object

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

Field Detail

LABEL

protected static final java.lang.String LABEL

This caches the label.

DESCRIPTION

protected static final java.lang.String DESCRIPTION

This cachaes the description.

domain

protected MappingDomain domain

This keeps track of the mapping domain in which the command operates.

collection

protected java.util.Collection<?> collection

This keeps track of the input and output objects that are to be mapped.

Constructor Detail

AddMappingCommand

public AddMappingCommand(MappingDomain domain,
                         java.util.Collection<?> collection)

This creates a command instance that adds the new mappings in the collection into the appropriate place in the mapping root's.

Method Detail

create

public static Command create(MappingDomain domain,
                             java.util.Collection<?> collection)

This creates a command that adds the new mappings in the collection into the appropriate place in the mapping root's.

create

public static Command create(MappingDomain domain,
                             Mapping mapping)

This creates a command that adds the new mappings in the collection into the appropriate place in the mapping root's.

prepare

protected boolean prepare()

Description copied from class: AbstractCommand

Called at most once in AbstractCommand.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.

Overrides:

prepare in class AbstractCommand

Returns:

whether the command is executable.

execute

public void execute()

Description copied from interface: Command

Performs the command activity required for the effect. The effect of calling execute when canExecute returns false, or when canExecute hasn't been called, is undefined.

undo

public void undo()

Description copied from class: AbstractCommand

Throws a runtime exception.

Specified by:

undo in interface Command

Overrides:

undo in class AbstractCommand

redo

public void redo()

Description copied from interface: Command

Performs the command activity required to redo 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.

getResult

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

Description copied from class: AbstractCommand

Returns an empty list.

Specified by:

getResult in interface Command

Overrides:

getResult in class AbstractCommand

Returns:

an empty list.

getAffectedObjects

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

Description copied from class: AbstractCommand

Returns an empty list.

Specified by:

getAffectedObjects in interface Command

Overrides:

getAffectedObjects in class AbstractCommand

Returns:

an empty list.

dispose

public void dispose()

Description copied from interface: Command

Called to indicate that the command will never be used again. Calling any other method after this one has undefined results.

Specified by:

dispose in interface Command

Overrides:

dispose in class AbstractCommand

toString

public 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.

Overrides:

toString in class AbstractCommand

Returns:

string representation.