Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/internal/ComparableWrapper.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/internal/ComparableWrapper.java
new file mode 100644 (file)
index 0000000..1c23685
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/internal/ComparableWrapper.java
@@ -0,0 +1,42 @@
+/*******************************************************************************\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.internal;\r
+\r
+import java.util.TreeSet;\r
+\r
+/**\r
+ * A wrapper Comparable class for allowing the creation of "multisets" with the\r
+ * basic {@link TreeSet} implementation.\r
+ * \r
+ * <p>\r
+ * This class will define the {@link Comparable#compareTo(Object)} method in\r
+ * such a way that the result will only be 0 if both the wrapped object and the\r
+ * {@link #orderNumber} argument match.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public class ComparableWrapper<T extends Comparable<T>> implements Comparable<ComparableWrapper<T>> {\r
+    public final T   t;\r
+    public final int orderNumber;\r
+\r
+    public ComparableWrapper(T t, int orderNumber) {\r
+        assert t != null;\r
+        this.t = t;\r
+        this.orderNumber = orderNumber;\r
+    }\r
+\r
+    @Override\r
+    public int compareTo(ComparableWrapper<T> o) {\r
+        int result = t.compareTo(o.t);\r
+        return result != 0 ? result : (orderNumber - o.orderNumber);\r
+    }\r
+}\r