IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.emf.msl
Class ResourceSetModifyOperation

java.lang.Object
  extended bycom.ibm.xtools.emf.msl.ResourceSetOperation
      extended bycom.ibm.xtools.emf.msl.ResourceSetModifyOperation
All Implemented Interfaces:
org.eclipse.jface.operation.IRunnableWithProgress

public abstract class ResourceSetModifyOperation
extends ResourceSetOperation

A ResourceSetOperation whose execution can potentially modify models.

API clients are expected to extend this class and provide their own implementation of ResourceSetOperation.execute

Example:

 
  	editingDomain.run( new ResourceSetModifyOperation("MyOperationTitle") {
  
  		protected void execute(IProgressMonitor monitor)
  			throws InvocationTargetException, InterruptedException {
  			
  			// Perform modifications to the editing domain's models
  			...
  		}
  	}, new NullProgressMonitor());
  
 

See Also:
EditingDomain.run(ResourceSetOperation, org.eclipse.core.runtime.IProgressMonitor)

Constructor Summary
ResourceSetModifyOperation(String label)
          Constructs a ResourceSetModifyOperation with a short description of what the operation does.
 
Method Summary
 String getLabel()
          Returns a short description of what the operation does.
 
Methods inherited from class com.ibm.xtools.emf.msl.ResourceSetOperation
execute, getResult, run, setResult
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceSetModifyOperation

public ResourceSetModifyOperation(String label)
Constructs a ResourceSetModifyOperation with a short description of what the operation does. This label is used as a format parameter presented to users under the Edit > Undo and Edit > Redo menus.

An ResourceSetModifyOperation ran from within an OperationListener.done(IOperationEvent) implementation may not see its label honoured in the Edit menu. Regardless of this fact, always provide a valid user consumable title.

Parameters:
label - the operation's label.
Method Detail

getLabel

public final String getLabel()
Returns a short description of what the operation does. This label is used as a format parameter presented to users under the Edit > Undo and Edit > Redo menus.

Returns:
The operation's label

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.