]> gerrit.simantics Code Review - simantics/platform.git/blobdiff - bundles/org.simantics.utils.thread/src/org/simantics/utils/threads/ua/WorkMonitor.java
Fixed all line endings of the repository
[simantics/platform.git] / bundles / org.simantics.utils.thread / src / org / simantics / utils / threads / ua / WorkMonitor.java
index ed54c88a9e42bdf2afb1071678cea75f8d8d53a6..83ba0c7c191c0ddb91849a9d9b73bd238511e9cf 100644 (file)
@@ -1,59 +1,59 @@
-/*******************************************************************************\r
- * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
- * in Industry THTH ry.\r
- * All rights reserved. This program and the accompanying materials\r
- * are made available under the terms of the Eclipse Public License v1.0\r
- * which accompanies this distribution, and is available at\r
- * http://www.eclipse.org/legal/epl-v10.html\r
- *\r
- * Contributors:\r
- *     VTT Technical Research Centre of Finland - initial API and implementation\r
- *******************************************************************************/\r
-\r
-package org.simantics.utils.threads.ua;\r
-\r
-\r
-/**\r
- * Asynchronous work monitor object.\r
- * \r
- * @author Toni Kalajainen (toni.kalajainen@vtt.fi)\r
- */\r
-public interface WorkMonitor extends IStatefulObject<WorkState, RuntimeException> {\r
-\r
-       /**\r
-        * Get the command\r
-        * \r
-        * @return runnable instance of the work\r
-        */\r
-       Runnable getRunnable();\r
-       \r
-    /**\r
-     * Attempts to cancel execution of this task.  This attempt will\r
-     * fail if the task has already completed, has already been cancelled,\r
-     * or could not be cancelled for some other reason. If successful,\r
-     * and this task has not started when <tt>cancel</tt> is called,\r
-     * this task should never run.  If the task has already started,\r
-     * then the <tt>mayInterruptIfRunning</tt> parameter determines\r
-     * whether the thread executing this task should be interrupted in\r
-     * an attempt to stop the task.\r
-     *\r
-     * <p>After this method returns, subsequent calls to {@link #isDone} will\r
-     * always return <tt>true</tt>.  Subsequent calls to {@link #isCancelled}\r
-     * will always return <tt>true</tt> if this method returned <tt>true</tt>.\r
-     *\r
-     * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this\r
-     * task should be interrupted; otherwise, in-progress tasks are allowed\r
-     * to complete\r
-     * @return <tt>false</tt> if the task could not be cancelled,\r
-     * typically because it has already completed normally;\r
-     * <tt>true</tt> otherwise\r
-     */\r
-    boolean cancel(boolean mayInterruptIfRunning);\r
-\r
-       /**\r
-        * Get error that occured during execution of the runnable.\r
-        * @return run-time exception\r
-        */\r
-    RuntimeException getError();\r
-       \r
-}\r
+/*******************************************************************************
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management
+ * in Industry THTH ry.
+ * 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:
+ *     VTT Technical Research Centre of Finland - initial API and implementation
+ *******************************************************************************/
+
+package org.simantics.utils.threads.ua;
+
+
+/**
+ * Asynchronous work monitor object.
+ * 
+ * @author Toni Kalajainen (toni.kalajainen@vtt.fi)
+ */
+public interface WorkMonitor extends IStatefulObject<WorkState, RuntimeException> {
+
+       /**
+        * Get the command
+        * 
+        * @return runnable instance of the work
+        */
+       Runnable getRunnable();
+       
+    /**
+     * Attempts to cancel execution of this task.  This attempt will
+     * fail if the task has already completed, has already been cancelled,
+     * or could not be cancelled for some other reason. If successful,
+     * and this task has not started when <tt>cancel</tt> is called,
+     * this task should never run.  If the task has already started,
+     * then the <tt>mayInterruptIfRunning</tt> parameter determines
+     * whether the thread executing this task should be interrupted in
+     * an attempt to stop the task.
+     *
+     * <p>After this method returns, subsequent calls to {@link #isDone} will
+     * always return <tt>true</tt>.  Subsequent calls to {@link #isCancelled}
+     * will always return <tt>true</tt> if this method returned <tt>true</tt>.
+     *
+     * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this
+     * task should be interrupted; otherwise, in-progress tasks are allowed
+     * to complete
+     * @return <tt>false</tt> if the task could not be cancelled,
+     * typically because it has already completed normally;
+     * <tt>true</tt> otherwise
+     */
+    boolean cancel(boolean mayInterruptIfRunning);
+
+       /**
+        * Get error that occured during execution of the runnable.
+        * @return run-time exception
+        */
+    RuntimeException getError();
+       
+}