org::ros::model::ros::diagram::MyAddCommand Class Reference

Inheritance diagram for org::ros::model::ros::diagram::MyAddCommand:

Public Member Functions
void	doExecute ()
Collection<?>	doGetAffectedObjects ()
Collection<?>	doGetResult ()
void	doRedo ()
void	doUndo ()
Collection<?>	getCollection ()
EStructuralFeature	getFeature ()
int	getIndex ()
EObject	getOwner ()
EList<?>	getOwnerList ()
	MyAddCommand (EditingDomain domain, EList<?> list, Collection<?> collection, int index)
	MyAddCommand (EditingDomain domain, EList<?> list, Collection<?> collection)
	MyAddCommand (EditingDomain domain, EList<?> list, Object value, int index)
	MyAddCommand (EditingDomain domain, EList<?> list, Object value)
	MyAddCommand (EditingDomain domain, EObject owner, EStructuralFeature feature, Collection<?> collection, int index)
	MyAddCommand (EditingDomain domain, EObject owner, EStructuralFeature feature, Collection<?> collection)
	MyAddCommand (EditingDomain domain, EObject owner, EStructuralFeature feature, Object value, int index)
	MyAddCommand (EditingDomain domain, EObject owner, EStructuralFeature feature, Object value)
String	toString ()
Static Public Member Functions
static Command	create (EditingDomain domain, Object owner, Object feature, Collection<?> collection, int index)
static Command	create (EditingDomain domain, Object owner, Object feature, Collection<?> collection)
static Command	create (EditingDomain domain, Object owner, Object feature, Object value, int index)
static Command	create (EditingDomain domain, Object owner, Object feature, Object value)
Protected Member Functions
boolean	isUserElement (EStructuralFeature entryFeature)
boolean	prepare ()
Protected Attributes
Collection<?>	affectedObjects
Collection<?>	collection
EStructuralFeature	feature
int	index
EObject	owner
EList< Object >	ownerList
Static Protected Attributes
static final String	DESCRIPTION = EMFEditPlugin.INSTANCE.getString("_UI_AddCommand_description")
static final String	DESCRIPTION_FOR_LIST = EMFEditPlugin.INSTANCE.getString("_UI_AddCommand_description_for_list")
static final String	LABEL = EMFEditPlugin.INSTANCE.getString("_UI_AddCommand_label")

Detailed Description

The add command logically acts upon an owner object that has a collection-based feature to which other objects can be added. The static create methods delegate command creation to EditingDomain.createCommand, which may or may not result in the actual creation of an instance of this class.

The implementation of this class is low-level and EMF specific; it allows one or more objects to be added to a many-valued feature of an owner, i.e., it is equivalent of the call

   ((EList)((EObject)owner).eGet((EStructuralFeature)feature)).addAll(index, (Collection)collection);

It can also be used as an equivalent to the call

   ((EList)extent).addAll(index, (Collection)collection);

which is how root objects are added into the contents of a resource. Like all the low-level commands in this package, the add command is undoable.

An add command is an OverrideableCommand.

Definition at line 49 of file MyAddCommand.java.

Constructor & Destructor Documentation

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EObject	owner,
		EStructuralFeature	feature,
		Object	value
	)			`[inline]`

This constructs a primitive command to add a particular value to the specified many-valued feature of the owner.

Definition at line 138 of file MyAddCommand.java.

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EObject	owner,
		EStructuralFeature	feature,
		Object	value,
		int	index
	)			`[inline]`

This constructs a primitive command to insert particular value into the specified many-valued feature of the owner.

Definition at line 146 of file MyAddCommand.java.

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EObject	owner,
		EStructuralFeature	feature,
		Collection<?>	collection
	)			`[inline]`

This constructs a primitive command to add a collection of values to the specified many-valued feature of the owner.

Definition at line 154 of file MyAddCommand.java.

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EObject	owner,
		EStructuralFeature	feature,
		Collection<?>	collection,
		int	index
	)			`[inline]`

This constructs a primitive command to insert a collection of values into the specified many-valued feature of the owner.

Definition at line 162 of file MyAddCommand.java.

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EList<?>	list,
		Object	value
	)			`[inline]`

This constructs a primitive command to add a particular value into the specified extent.

Definition at line 177 of file MyAddCommand.java.

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EList<?>	list,
		Object	value,
		int	index
	)			`[inline]`

This constructs a primitive command to insert particular value into the specified extent.

Definition at line 185 of file MyAddCommand.java.

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EList<?>	list,
		Collection<?>	collection
	)			`[inline]`

This constructs a primitive command to insert a collection of values into the specified extent.

Definition at line 193 of file MyAddCommand.java.

org::ros::model::ros::diagram::MyAddCommand::MyAddCommand	(	EditingDomain	domain,
		EList<?>	list,
		Collection<?>	collection,
		int	index
	)			`[inline]`

This constructs a primitive command to insert a collection of values into the specified extent.

Definition at line 201 of file MyAddCommand.java.

Member Function Documentation

static Command org::ros::model::ros::diagram::MyAddCommand::create	(	EditingDomain	domain,
		Object	owner,
		Object	feature,
		Collection<?>	collection,
		int	index
	)			`[inline, static]`

This creates a command to insert a collection of values at a particular index in the specified feature of the owner. The feature will often be null because the domain will deduce it.

Definition at line 82 of file MyAddCommand.java.

static Command org::ros::model::ros::diagram::MyAddCommand::create	(	EditingDomain	domain,
		Object	owner,
		Object	feature,
		Collection<?>	collection
	)			`[inline, static]`

This creates a command to add a collection of values to the specified feature of the owner. The feature will often be null because the domain will deduce it.

Definition at line 73 of file MyAddCommand.java.

static Command org::ros::model::ros::diagram::MyAddCommand::create	(	EditingDomain	domain,
		Object	owner,
		Object	feature,
		Object	value,
		int	index
	)			`[inline, static]`

This creates a command to insert particular value at a particular index in the specified feature of the owner. The feature will often be null because the domain will deduce it.

Definition at line 64 of file MyAddCommand.java.

static Command org::ros::model::ros::diagram::MyAddCommand::create	(	EditingDomain	domain,
		Object	owner,
		Object	feature,
		Object	value
	)			`[inline, static]`

This creates a command to add a particular value to the specified feature of the owner. The feature will often be null because the domain will deduce it.

Definition at line 55 of file MyAddCommand.java.

void org::ros::model::ros::diagram::MyAddCommand::doExecute ( ) [inline]

Definition at line 385 of file MyAddCommand.java.

Collection<?> org::ros::model::ros::diagram::MyAddCommand::doGetAffectedObjects ( ) [inline]

Definition at line 464 of file MyAddCommand.java.

Collection<?> org::ros::model::ros::diagram::MyAddCommand::doGetResult ( ) [inline]

Definition at line 458 of file MyAddCommand.java.

void org::ros::model::ros::diagram::MyAddCommand::doRedo ( ) [inline]

Definition at line 435 of file MyAddCommand.java.

void org::ros::model::ros::diagram::MyAddCommand::doUndo ( ) [inline]

Definition at line 418 of file MyAddCommand.java.

Collection<?> org::ros::model::ros::diagram::MyAddCommand::getCollection ( ) [inline]

This returns the collection of objects being added.

Definition at line 242 of file MyAddCommand.java.

EStructuralFeature org::ros::model::ros::diagram::MyAddCommand::getFeature ( ) [inline]

This returns the feature of the owner object upon the command will act. It could be null, in the case that we are dealing with an org.eclipse.emf.common.util.EList.

Definition at line 226 of file MyAddCommand.java.

int org::ros::model::ros::diagram::MyAddCommand::getIndex ( ) [inline]

This returns the position at which the objects will be added.

Definition at line 250 of file MyAddCommand.java.

EObject org::ros::model::ros::diagram::MyAddCommand::getOwner ( ) [inline]

This returns the owner object upon which the command will act. It could be null in the case that we are dealing with an org.eclipse.emf.common.util.EList.

Definition at line 217 of file MyAddCommand.java.

EList<?> org::ros::model::ros::diagram::MyAddCommand::getOwnerList ( ) [inline]

This returns the list to which the command will add.

Definition at line 234 of file MyAddCommand.java.

boolean org::ros::model::ros::diagram::MyAddCommand::isUserElement ( EStructuralFeature entryFeature ) [inline, protected]

Definition at line 255 of file MyAddCommand.java.

boolean org::ros::model::ros::diagram::MyAddCommand::prepare ( ) [inline, protected]

Definition at line 265 of file MyAddCommand.java.

String org::ros::model::ros::diagram::MyAddCommand::toString ( ) [inline]

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.

Definition at line 474 of file MyAddCommand.java.

Member Data Documentation

Collection<?> org::ros::model::ros::diagram::MyAddCommand::affectedObjects [protected]

This is the value returned by Command#getAffectedObjects. The affected objects are different after an execute than after an undo, so we record it.

Definition at line 133 of file MyAddCommand.java.

Collection<?> org::ros::model::ros::diagram::MyAddCommand::collection [protected]

This is the collection of objects being added to the owner list.

Definition at line 122 of file MyAddCommand.java.

final String org::ros::model::ros::diagram::MyAddCommand::DESCRIPTION = EMFEditPlugin.INSTANCE.getString("_UI_AddCommand_description") [static, protected]

This caches the description.

Definition at line 95 of file MyAddCommand.java.

final String org::ros::model::ros::diagram::MyAddCommand::DESCRIPTION_FOR_LIST = EMFEditPlugin.INSTANCE.getString("_UI_AddCommand_description_for_list") [static, protected]

This caches the description for a list-based addition.

Definition at line 100 of file MyAddCommand.java.

EStructuralFeature org::ros::model::ros::diagram::MyAddCommand::feature [protected]

This is the feature of the owner object upon the command will act. It could be null, in the case that we are dealing with an org.eclipse.emf.common.util.EList.

Definition at line 112 of file MyAddCommand.java.

int org::ros::model::ros::diagram::MyAddCommand::index [protected]

This is the position at which the objects will be inserted.

Definition at line 127 of file MyAddCommand.java.

final String org::ros::model::ros::diagram::MyAddCommand::LABEL = EMFEditPlugin.INSTANCE.getString("_UI_AddCommand_label") [static, protected]

This caches the label.

Definition at line 90 of file MyAddCommand.java.

EObject org::ros::model::ros::diagram::MyAddCommand::owner [protected]

This is the owner object upon which the command will act. It could be null in the case that we are dealing with an org.eclipse.emf.common.util.EList.

Definition at line 106 of file MyAddCommand.java.

EList<Object> org::ros::model::ros::diagram::MyAddCommand::ownerList [protected]

This is the list to which the command will add the collection.