Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.ui / src / org / simantics / ui / workbench / preferences / PreferencePropertyTester.java

diff --git a/bundles/org.simantics.ui/src/org/simantics/ui/workbench/preferences/PreferencePropertyTester.java b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/preferences/PreferencePropertyTester.java
new file mode 100644 (file)
index 0000000..16fe4b6
--- /dev/null
+++ b/bundles/org.simantics.ui/src/org/simantics/ui/workbench/preferences/PreferencePropertyTester.java
@@ -0,0 +1,72 @@
+/*******************************************************************************\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.ui.workbench.preferences;\r
+\r
+import org.eclipse.core.expressions.PropertyTester;\r
+import org.eclipse.core.runtime.preferences.DefaultScope;\r
+import org.eclipse.core.runtime.preferences.InstanceScope;\r
+import org.osgi.service.prefs.Preferences;\r
+import org.simantics.utils.ObjectUtils;\r
+\r
+/**\r
+ * A JFace property tester extension for the Eclipse command framework for\r
+ * testing Eclipse preference values according to the specified arguments.\r
+ * \r
+ * <p>\r
+ * The tester first tries to find the specified property from the instance scope\r
+ * (see {@link InstanceScope}) and if no value is found, it falls back to using\r
+ * the default scope (see {@link DefaultScope})\r
+ * \r
+ * <p>\r
+ * The tester expects to receive:\r
+ * <ul>\r
+ * <li><b>args</b>: two strings separated by comma, args[0] = bundle id, args[1] =\r
+ * preference to test</li>\r
+ * <li><b>expected value</b>: the value that the preference is expected to have to\r
+ * evaluate to <code>true</code></li>\r
+ * </ul>\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @see InstanceScope\r
+ * @see DefaultScope\r
+ */\r
+public class PreferencePropertyTester extends PropertyTester {\r
+\r
+    @Override\r
+    public boolean test(Object receiver, String property, Object[] args, Object expectedValue) {\r
+        //System.out.println("TEST: " + receiver + ", " + property + ", " + Arrays.toString(args) + ", " + expectedValue);\r
+\r
+        if (args.length == 2) {\r
+            String bundle = (String) args[0];\r
+            String preference = (String) args[1];\r
+            String expected = null;\r
+            if (expectedValue instanceof Boolean)\r
+                expected = ((Boolean) expectedValue).toString();\r
+            else\r
+                expected = (String) expectedValue;\r
+\r
+            Preferences prefs = InstanceScope.INSTANCE.getNode(bundle);\r
+            String value = prefs.get(preference, null);\r
+            if (value == null) {\r
+                // Get the default value only if there is no instance value.\r
+                prefs = DefaultScope.INSTANCE.getNode(bundle);\r
+                value = prefs.get(preference, null);\r
+            }\r
+            //System.out.println("TESTING VALUE: " + value);\r
+            return ObjectUtils.objectEquals(value, expected);\r
+        }\r
+\r
+        return false;\r
+    }\r
+\r
+}\r