diff dwtx/core/commands/operations/ICompositeOperation.d @ 3:6518c18a01f7

eclipse.core package without osgi dependencies
author Frank Benoit <benoit@tionex.de>
date Wed, 26 Mar 2008 00:57:19 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/core/commands/operations/ICompositeOperation.d	Wed Mar 26 00:57:19 2008 +0100
@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * Copyright (c) 2005 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+module dwtx.core.commands.operations.ICompositeOperation;
+
+import dwtx.core.commands.operations.IUndoableOperation;
+
+import dwt.dwthelper.utils;
+
+/**
+ * <p>
+ * ICompositeOperation defines an undoable operation that is composed of child
+ * operations. Requests to execute, undo, or redo a composite result in the the
+ * execution, undo, or redo of the composite as a whole. Similarly, a request to
+ * dispose the composite should result in all child operations being disposed.
+ * </p>
+ *
+ * @since 3.1
+ */
+public interface ICompositeOperation : IUndoableOperation {
+
+    /**
+     * <p>
+     * Add the specified operation as a child of this operation.
+     * </p>
+     *
+     * @param operation
+     *            the operation to be added. If the operation instance has
+     *            already been added, this method will have no effect.
+     */
+    void add(IUndoableOperation operation);
+
+    /**
+     * <p>
+     * Remove the specified operation from this operation.
+     * </p>
+     * <p>
+     * The composite operation should dispose the operation as part of removing
+     * it.
+     * </p>
+     *
+     * @param operation
+     *            the operation to be removed. The operation should be disposed
+     *            by the receiver. This method will have no effect if the
+     *            operation instance is not already a child.
+     */
+    void remove(IUndoableOperation operation);
+}