Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.utils.datastructures / src / org / simantics / utils / datastructures / disposable / IDisposable.java

diff --git a/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/disposable/IDisposable.java b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/disposable/IDisposable.java
new file mode 100644 (file)
index 0000000..5a897ed
--- /dev/null
+++ b/bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/disposable/IDisposable.java
@@ -0,0 +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.datastructures.disposable;\r
+\r
+import org.simantics.utils.threads.IThreadWorkQueue;\r
+\r
+/**\r
+ * Interface for disposable objects.\r
+ * \r
+ * @see AbstractDisposable for implementation\r
+ * @author Toni Kalajainen\r
+ */\r
+public interface IDisposable {\r
+    \r
+    /**\r
+     * Starts dispose procedures. The objects goes into Disposing state\r
+     * while dispose listeners are handled. \r
+     */\r
+    void dispose();\r
+    \r
+    /**\r
+     * Dispose if not diposed.\r
+     */\r
+    void safeDispose();\r
+    \r
+    /**\r
+     * Is the object disposed. The return value of this method goes into \r
+     * true status, once dispose() is invoked and all listeners have been\r
+     * processed. \r
+     *  \r
+     * @return <code>true</code> if this object has been disposed\r
+     */\r
+    boolean isDisposed();\r
+\r
+    /**\r
+     * Get objects state in respect to its life cycle.\r
+     * \r
+     * @return current object state\r
+     */\r
+    DisposeState getDisposeState();\r
+    \r
+    void addDisposeListener(IDisposeListener listener);\r
+    void addDisposeListener(IDisposeListener listener, IThreadWorkQueue thread);\r
+    void removeDisposeListener(IDisposeListener listener);\r
+    void removeDisposeListener(IDisposeListener listener, IThreadWorkQueue thread);\r
+    \r
+    \r
+\r
+}\r