Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/Preference.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/Preference.java
new file mode 100644 (file)
index 0000000..7bd6d90
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/Preference.java
@@ -0,0 +1,43 @@
+/*******************************************************************************\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;\r
+\r
+/**\r
+ * A generic wrapper that associates a double-based preference indicator value\r
+ * for any object. This class can be used make objects comparable.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @param <T> the type of the object to be made comparable\r
+ */\r
+public class Preference<T> implements Comparable<Preference<T>> {\r
+    public final T      object;\r
+    public final double preference;\r
+\r
+    public Preference(T object, double preference) {\r
+        this.object = object;\r
+        this.preference = preference;\r
+    }\r
+\r
+    @Override\r
+    public int compareTo(Preference<T> other) {\r
+        if (preference == other.preference)\r
+            return 0;\r
+        return (preference > other.preference) ? -1 : 1;\r
+    }\r
+    \r
+    @Override\r
+    public String toString() {\r
+       return object + " with preference " + preference;\r
+    }\r
+    \r
+}
\ No newline at end of file