Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.db / src / org / simantics / db / event / ChangeListener.java

diff --git a/bundles/org.simantics.db/src/org/simantics/db/event/ChangeListener.java b/bundles/org.simantics.db/src/org/simantics/db/event/ChangeListener.java
new file mode 100644 (file)
index 0000000..cbe855e
--- /dev/null
+++ b/bundles/org.simantics.db/src/org/simantics/db/event/ChangeListener.java
@@ -0,0 +1,36 @@
+/*******************************************************************************\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.db.event;\r
+\r
+import org.simantics.db.ReadGraph;\r
+import org.simantics.db.Session;\r
+import org.simantics.db.exception.DatabaseException;\r
+\r
+/**\r
+ * A listener added to a Session for receiving notifications for completed\r
+ * write transactions.\r
+ * \r
+ * @see GraphChangeEvent\r
+ * @see Session\r
+ */\r
+public interface ChangeListener {\r
+\r
+    /**\r
+     * The listener gets a read lock along with the event (a {@link ReadGraph}\r
+     * instance). This method should be implemented so that it never blocks.\r
+     * \r
+     * The ChangeSet contained by the received event should only contain the\r
+     * changes that intersect with the working set of the listener's Session.\r
+     */\r
+    void graphChanged(ChangeEvent e) throws DatabaseException;\r
+\r
+}\r