diff org.eclipse.equinox.common/src/org/eclipse/core/runtime/ProgressMonitorWrapper.d @ 12:bc29606a740c

Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children bbe49769ec18
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/org.eclipse.equinox.common/src/org/eclipse/core/runtime/ProgressMonitorWrapper.d	Sat Mar 14 18:23:29 2009 +0100
@@ -0,0 +1,179 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2006 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 org.eclipse.core.runtime.ProgressMonitorWrapper;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+import org.eclipse.core.runtime.IProgressMonitorWithBlocking;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Assert;
+
+import java.lang.all;
+
+/**
+ * An abstract wrapper around a progress monitor which,
+ * unless overridden, forwards <code>IProgressMonitor</code>
+ * and <code>IProgressMonitorWithBlocking</code> methods to the wrapped progress monitor.
+ * <p>
+ * This class can be used without OSGi running.
+ * </p><p>
+ * Clients may subclass.
+ * </p>
+ */
+public abstract class ProgressMonitorWrapper : IProgressMonitor, IProgressMonitorWithBlocking {
+
+    /** The wrapped progress monitor. */
+    private IProgressMonitor progressMonitor;
+
+    /**
+     * Creates a new wrapper around the given monitor.
+     *
+     * @param monitor the progress monitor to forward to
+     */
+    protected this(IProgressMonitor monitor) {
+        Assert.isNotNull(cast(Object)monitor);
+        progressMonitor = monitor;
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#beginTask(String, int)
+     */
+    public void beginTask(String name, int totalWork) {
+        progressMonitor.beginTask(name, totalWork);
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitorWithBlocking</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitorWithBlocking#clearBlocked()
+     * @since 3.0
+     */
+    public void clearBlocked() {
+        if ( auto mon = cast(IProgressMonitorWithBlocking)progressMonitor )
+            mon.clearBlocked();
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#done()
+     */
+    public void done() {
+        progressMonitor.done();
+    }
+
+    /**
+     * Returns the wrapped progress monitor.
+     *
+     * @return the wrapped progress monitor
+     */
+    public IProgressMonitor getWrappedProgressMonitor() {
+        return progressMonitor;
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#internalWorked(double)
+     */
+    public void internalWorked(double work) {
+        progressMonitor.internalWorked(work);
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#isCanceled()
+     */
+    public bool isCanceled() {
+        return progressMonitor.isCanceled();
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitorWithBlocking</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitorWithBlocking#setBlocked(IStatus)
+     * @since 3.0
+     */
+    public void setBlocked(IStatus reason) {
+        if ( auto mon = cast(IProgressMonitorWithBlocking)progressMonitor)
+            mon.setBlocked(reason);
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#setCanceled(bool)
+     */
+    public void setCanceled(bool b) {
+        progressMonitor.setCanceled(b);
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#setTaskName(String)
+     */
+    public void setTaskName(String name) {
+        progressMonitor.setTaskName(name);
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#subTask(String)
+     */
+    public void subTask(String name) {
+        progressMonitor.subTask(name);
+    }
+
+    /**
+     * This implementation of a <code>IProgressMonitor</code>
+     * method forwards to the wrapped progress monitor.
+     * Clients may override this method to do additional
+     * processing.
+     *
+     * @see IProgressMonitor#worked(int)
+     */
+    public void worked(int work) {
+        progressMonitor.worked(work);
+    }
+}