Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/EnumeratedValue.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/EnumeratedValue.java
new file mode 100644 (file)
index 0000000..8f2c1dd
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/EnumeratedValue.java
@@ -0,0 +1,116 @@
+/*******************************************************************************\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.modifiers;\r
+\r
+import java.util.Comparator;\r
+\r
+/**\r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @param <T>\r
+ */\r
+public class EnumeratedValue<T> implements Comparable<EnumeratedValue<T>>{\r
+\r
+    private static class InvalidEnumeratedValue<T> extends EnumeratedValue<T> {\r
+        public InvalidEnumeratedValue(String name) {\r
+            super(name, null);\r
+        }\r
+    }\r
+\r
+    public static final <T> EnumeratedValue<T> invalid(String name) {\r
+        return new InvalidEnumeratedValue<T>(name);\r
+    }\r
+\r
+    public static final boolean isInvalid(EnumeratedValue<?> value) {\r
+        return value instanceof InvalidEnumeratedValue<?>;\r
+    }\r
+\r
+    public static final Comparator<EnumeratedValue<? extends Object>> CASE_INSENSITIVE_NAME_ORDER = new Comparator<EnumeratedValue<? extends Object>>() {\r
+        @Override\r
+        public int compare(EnumeratedValue<? extends Object> o1, EnumeratedValue<? extends Object> o2) {\r
+            return o1.getName().compareToIgnoreCase(o2.getName());\r
+        }\r
+    };\r
+\r
+    private final String name;\r
+\r
+    private final T      object;\r
+\r
+    public static EnumeratedValue<String> make(String name) {\r
+        return new EnumeratedValue<String>(name, name);\r
+    }\r
+\r
+    public static <T> EnumeratedValue<T> make(String name, T object) {\r
+        return new EnumeratedValue<T>(name, object);\r
+    }\r
+\r
+    public EnumeratedValue(String name, T object) {\r
+        if (name == null)\r
+            throw new NullPointerException("null enumerated value name");\r
+        this.name = name;\r
+        this.object = object;\r
+    }\r
+\r
+    /**\r
+     * @return the name of the enumerated value\r
+     */\r
+    public String getName() {\r
+        return name;\r
+    }\r
+\r
+    /**\r
+     * @return the object bound to this enumerated value, may be\r
+     *         <code>null</code>\r
+     */\r
+    public T getObject() {\r
+        return object;\r
+    }\r
+\r
+    @Override\r
+    public String toString() {\r
+        return name + "[" + object + "]";\r
+    }\r
+\r
+    @Override\r
+    public int compareTo(EnumeratedValue<T> o) {\r
+        return getName().compareTo(o.getName());\r
+    }\r
+\r
+    @Override\r
+    public int hashCode() {\r
+        final int prime = 31;\r
+        int result = 1;\r
+        result = prime * result + name.hashCode();\r
+        result = prime * result + ((object == null) ? 0 : object.hashCode());\r
+        return result;\r
+    }\r
+\r
+    @Override\r
+    public boolean equals(Object obj) {\r
+        if (this == obj)\r
+            return true;\r
+        if (obj == null)\r
+            return false;\r
+        if (getClass() != obj.getClass())\r
+            return false;\r
+        EnumeratedValue<?> other = (EnumeratedValue<?>) obj;\r
+        if (!name.equals(other.name))\r
+            return false;\r
+        if (object == null) {\r
+            if (other.object != null)\r
+                return false;\r
+        } else if (!object.equals(other.object))\r
+            return false;\r
+        return true;\r
+    }\r
+\r
+}\r