Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.utils.thread/src/org/simantics/utils/threads/ua/StatefulExecutor.java b/bundles/org.simantics.utils.thread/src/org/simantics/utils/threads/ua/StatefulExecutor.java
new file mode 100644 (file)
index 0000000..5ecd1cf
--- /dev/null
+++ b/bundles/org.simantics.utils.thread/src/org/simantics/utils/threads/ua/StatefulExecutor.java
@@ -0,0 +1,37 @@
+/*******************************************************************************\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
+import java.util.concurrent.Executor;\r
+\r
+/**\r
+ *\r
+ * \r
+ * @author Toni Kalajainen (toni.kalajainen@vtt.fi)\r
+ */\r
+public interface StatefulExecutor extends IStatefulObject<ExecutorState, RuntimeException>, Executor {\r
+\r
+       /**\r
+        * Change the status of the executor. \r
+        * <p>\r
+        * To close the executor set the state to <tt>WorkerState.Shutdown</tt>.\r
+        * When all work has been executed and all threads are shut down, \r
+        * the executor will shift to WorkerState.Terminated state.\r
+        * <p>\r
+        * Once worker is terminated it cannot be re-activated.\r
+        *  \r
+        * @param newStatus \r
+        */\r
+       boolean setState(ExecutorState newStatus);      \r
+       \r
+}\r