org.eclipse.emf.edit.command

Class CreateCopyCommand

java.lang.Object

org.eclipse.emf.common.command.AbstractCommand

org.eclipse.emf.edit.command.AbstractOverrideableCommand

org.eclipse.emf.edit.command.CreateCopyCommand

All Implemented Interfaces:

Command, ChildrenToCopyProvider, OverrideableCommand

public class CreateCopyCommand
extends AbstractOverrideableCommand
implements ChildrenToCopyProvider

The create copy command is used to create an uninitialized object of the same type as owner which will later be initialized using InitializeCopyCommand.

A create copy command is an OverrideableCommand.

Nested Class Summary

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

AbstractCommand.NonDirtying

Field Summary

Fields

Modifier and Type	Field and Description
protected EObject	copy This is the copy.
protected CopyCommand.Helper	copyHelper This is a map of objects to their copies
protected static java.lang.String	DESCRIPTION This caches the description.
protected static java.lang.String	LABEL This caches the label.
protected EObject	owner This is the object being copied.

Fields inherited from class org.eclipse.emf.edit.command.AbstractOverrideableCommand

domain, overrideCommand

Fields inherited from class org.eclipse.emf.common.command.AbstractCommand

description, isExecutable, isPrepared, label

Constructor Summary

Constructors

Constructor and Description
CreateCopyCommand(EditingDomain domain, EObject owner, CopyCommand.Helper copyHelper) This constructs a command that will create an object that is a copy of the given object.

Method Summary

Methods

Modifier and Type	Method and Description
static Command	create(EditingDomain domain, java.lang.Object owner, CopyCommand.Helper copyHelper) This creates a command that will create and object for copying the given object
void	doExecute() This is overrideable command's implementation of execute.
java.util.Collection<?>	doGetChildrenToCopy()
java.util.Collection<?>	doGetResult() This is overrideable command's implementation of getResult.
void	doRedo() This is overrideable command's implementation of redo.
void	doUndo() This is overrideable command's implementation of undo.
CopyCommand.Helper	getCopyHelper() This is the map of objects to their copies.
EObject	getOwner() This is the object being copied.
protected boolean	prepare() Called at most once in AbstractCommand.canExecute() to give the command an opportunity to ready itself for execution.
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.

Methods inherited from class org.eclipse.emf.edit.command.AbstractOverrideableCommand

canExecute, canUndo, dispose, doCanExecute, doCanUndo, doDispose, doGetAffectedObjects, doGetDescription, doGetLabel, execute, getAffectedObjects, getChildrenToCopy, getDescription, getDomain, getLabel, getOverride, getOwnerList, getResult, redo, setOverride, undo, updateEMap

Methods inherited from class org.eclipse.emf.common.command.AbstractCommand

chain, setDescription, setLabel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.emf.edit.command.ChildrenToCopyProvider

getChildrenToCopy

Methods inherited from interface org.eclipse.emf.common.command.Command

chain

Field Detail

LABEL

protected static final java.lang.String LABEL

This caches the label.

DESCRIPTION

protected static final java.lang.String DESCRIPTION

This caches the description.

owner

protected EObject owner

This is the object being copied.

copy

protected EObject copy

This is the copy.

copyHelper

protected CopyCommand.Helper copyHelper

This is a map of objects to their copies

Constructor Detail

CreateCopyCommand

public CreateCopyCommand(EditingDomain domain,
                 EObject owner,
                 CopyCommand.Helper copyHelper)

This constructs a command that will create an object that is a copy of the given object.

Method Detail

create

public static Command create(EditingDomain domain,
             java.lang.Object owner,
             CopyCommand.Helper copyHelper)

This creates a command that will create and object for copying the given object

getOwner

public EObject getOwner()

This is the object being copied.

getCopyHelper

public CopyCommand.Helper getCopyHelper()

This is the map of objects to their copies.

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.

doExecute

public void doExecute()

Description copied from interface: OverrideableCommand

This is overrideable command's implementation of execute.

Specified by:

doExecute in interface OverrideableCommand

Specified by:

doExecute in class AbstractOverrideableCommand

doUndo

public void doUndo()

Description copied from interface: OverrideableCommand

This is overrideable command's implementation of undo.

Specified by:

doUndo in interface OverrideableCommand

Specified by:

doUndo in class AbstractOverrideableCommand

doRedo

public void doRedo()

Description copied from interface: OverrideableCommand

This is overrideable command's implementation of redo.

Specified by:

doRedo in interface OverrideableCommand

Specified by:

doRedo in class AbstractOverrideableCommand

doGetResult

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

Description copied from interface: OverrideableCommand

This is overrideable command's implementation of getResult.

Specified by:

doGetResult in interface OverrideableCommand

Overrides:

doGetResult in class AbstractOverrideableCommand

doGetChildrenToCopy

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

Overrides:

doGetChildrenToCopy in class AbstractOverrideableCommand

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 AbstractOverrideableCommand

Returns:

string representation.