diff org.eclipse.equinox.common/src/org/eclipse/core/runtime/NullProgressMonitor.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/NullProgressMonitor.d	Sat Mar 14 18:23:29 2009 +0100
@@ -0,0 +1,131 @@
+/*******************************************************************************
+ * 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.NullProgressMonitor;
+
+import org.eclipse.core.runtime.IProgressMonitor;
+
+import java.lang.all;
+
+/**
+ * A default progress monitor implementation suitable for
+ * subclassing.
+ * <p>
+ * This implementation supports cancelation. The default
+ * implementations of the other methods do nothing.
+ * </p><p>
+ * This class can be used without OSGi running.
+ * </p>
+ */
+public class NullProgressMonitor : IProgressMonitor {
+
+    /**
+     * Indicates whether cancel has been requested.
+     */
+    private bool cancelled = false;
+
+    /**
+     * Constructs a new progress monitor.
+     */
+    public this() {
+    }
+
+    /**
+     * This implementation does nothing.
+     * Subclasses may override this method to do interesting
+     * processing when a task begins.
+     *
+     * @see IProgressMonitor#beginTask(String, int)
+     */
+    public void beginTask(String name, int totalWork) {
+        // do nothing
+    }
+
+    /**
+     * This implementation does nothing.
+     * Subclasses may override this method to do interesting
+     * processing when a task is done.
+     *
+     * @see IProgressMonitor#done()
+     */
+    public void done() {
+        // do nothing
+    }
+
+    /**
+     * This implementation does nothing.
+     * Subclasses may override this method.
+     *
+     * @see IProgressMonitor#internalWorked(double)
+     */
+    public void internalWorked(double work) {
+        // do nothing
+    }
+
+    /**
+     * This implementation returns the value of the internal
+     * state variable set by <code>setCanceled</code>.
+     * Subclasses which override this method should
+     * override <code>setCanceled</code> as well.
+     *
+     * @see IProgressMonitor#isCanceled()
+     * @see IProgressMonitor#setCanceled(bool)
+     */
+    public bool isCanceled() {
+        return cancelled;
+    }
+
+    /**
+     * This implementation sets the value of an internal state variable.
+     * Subclasses which override this method should override
+     * <code>isCanceled</code> as well.
+     *
+     * @see IProgressMonitor#isCanceled()
+     * @see IProgressMonitor#setCanceled(bool)
+     */
+    public void setCanceled(bool cancelled) {
+        this.cancelled = cancelled;
+    }
+
+    /**
+     * This implementation does nothing.
+     * Subclasses may override this method to do something
+     * with the name of the task.
+     *
+     * @see IProgressMonitor#setTaskName(String)
+     */
+    public void setTaskName(String name) {
+        // do nothing
+    }
+
+    /**
+     * This implementation does nothing.
+     * Subclasses may override this method to do interesting
+     * processing when a subtask begins.
+     *
+     * @see IProgressMonitor#subTask(String)
+     */
+    public void subTask(String name) {
+        // do nothing
+    }
+
+    /**
+     * This implementation does nothing.
+     * Subclasses may override this method to do interesting
+     * processing when some work has been completed.
+     *
+     * @see IProgressMonitor#worked(int)
+     */
+    public void worked(int work) {
+        // do nothing
+    }
+}