Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.db/src/org/simantics/db/MonitorContext.java b/bundles/org.simantics.db/src/org/simantics/db/MonitorContext.java
new file mode 100644 (file)
index 0000000..dade110
--- /dev/null
+++ b/bundles/org.simantics.db/src/org/simantics/db/MonitorContext.java
@@ -0,0 +1,41 @@
+/*******************************************************************************\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;\r
+\r
+import org.simantics.db.service.SessionMonitorSupport;\r
+\r
+/**\r
+ * A context used for accessing {@link Session} internal state information.\r
+ * The context is attained through {@link SessionMonitorSupport}.\r
+ * \r
+ * @see SessionMonitorSupport\r
+ * @see SessionVariables\r
+ */\r
+public interface MonitorContext {\r
+\r
+    /**\r
+     * Get value for specified integer variable.\r
+     * \r
+     * @param key the variable\r
+     * @return value or -1 for unrecognized variables\r
+     */\r
+    int getInteger(String key);\r
+\r
+    /**\r
+     * Get value for specified integer variable.\r
+     * \r
+     * @param key the variable\r
+     * @return value or <code>null</code> for unrecognized variables\r
+     */\r
+    String getString(String key);\r
+\r
+}\r