Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.browsing.ui.common / src / org / simantics / browsing / ui / common / processors / ProcessorLifecycle.java

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ProcessorLifecycle.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ProcessorLifecycle.java
new file mode 100644 (file)
index 0000000..1cade91
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/processors/ProcessorLifecycle.java
@@ -0,0 +1,56 @@
+/*******************************************************************************\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.browsing.ui.common.processors;\r
+\r
+import org.simantics.browsing.ui.GraphExplorer;\r
+import org.simantics.browsing.ui.PrimitiveQueryProcessor;\r
+\r
+/**\r
+ * An interface that {@link PrimitiveQueryProcessor} implementations may\r
+ * implement in order to receive lifecycle-related notifications that can be\r
+ * used e.g. for internal housekeeping.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public interface ProcessorLifecycle {\r
+\r
+    /**\r
+     * This processor has been attached to the specified {@link GraphExplorer}\r
+     * via {@link GraphExplorer#setPrimitiveProcessor(PrimitiveQueryProcessor)}\r
+     * \r
+     * @param explorer the explorer to which this processor was just attached\r
+     */\r
+    void attached(GraphExplorer explorer);\r
+\r
+    /**\r
+     * This processor has been detached from the specified {@link GraphExplorer}\r
+     * for one of these reasons:\r
+     * <ul>\r
+     * <li>replaced by another {@link PrimitiveQueryProcessor} through an\r
+     * invocation to\r
+     * {@link GraphExplorer#setPrimitiveProcessor(PrimitiveQueryProcessor)}</li>\r
+     * <li>the graph explorer was disposed and all primitive processors are\r
+     * being detached from it</li>\r
+     * </ul>\r
+     * \r
+     * @param explorer the explorer from which this processor was just detached\r
+     */\r
+    void detached(GraphExplorer explorer);\r
+\r
+    /**\r
+     * Invoked by GraphExplorer when its input is reset through\r
+     * {@link GraphExplorer#setRoot(Object)}. Allows the processor to do\r
+     * cleanup if necessary, e.g. for internal caches.\r
+     */\r
+    void clear();\r
+\r
+}\r