Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.utils.thread / src / org / simantics / utils / threads / ua / Worker.java

diff --git a/bundles/org.simantics.utils.thread/src/org/simantics/utils/threads/ua/Worker.java b/bundles/org.simantics.utils.thread/src/org/simantics/utils/threads/ua/Worker.java
new file mode 100644 (file)
index 0000000..1fc3667
--- /dev/null
+++ b/bundles/org.simantics.utils.thread/src/org/simantics/utils/threads/ua/Worker.java
@@ -0,0 +1,46 @@
+/*******************************************************************************\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
+package org.simantics.utils.threads.ua;\r
+\r
+import java.util.Collection;\r
+\r
+/**\r
+ * Worker executes tasks. \r
+ * <p>\r
+ * Hint! To execute work synchronously use: <BR>\r
+ *  Worker.asyncExec(runnable, null).waitForState(WorkState.FINAL_STATES);\r
+ * <p>\r
+ * To cancel all work get the work with getQueuedWork() and invoke cancel() to each.\r
+ * \r
+ * @see SynchronizedWorker\r
+ * @see ThreadPool\r
+ * @author Toni Kalajainen (toni.kalajainen@vtt.fi)\r
+ */\r
+public interface Worker extends StatefulExecutor {\r
+       \r
+       /**\r
+        * Execute work (async).\r
+        * \r
+        * @param runnable\r
+        * @param initialListener listener initially set on monitor object or null\r
+        * @return async work monitor object\r
+        */\r
+       WorkMonitor asyncExec(Runnable runnable, StateListener<WorkState> initialListener)\r
+       throws WorkerClosedException;\r
+\r
+       /**\r
+        * Get a list of all queued work.\r
+        * @param result queued work.\r
+        */\r
+       void getQueuedWork(Collection<WorkMonitor> result);\r
+\r
+}\r