Migrated source code from Simantics SVN

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

diff --git a/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/Enumeration.java b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/Enumeration.java
new file mode 100644 (file)
index 0000000..29ec0d8
--- /dev/null
+++ b/bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/Enumeration.java
@@ -0,0 +1,139 @@
+/*******************************************************************************\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.Arrays;\r
+import java.util.List;\r
+\r
+/**\r
+ * @author Tuukka Lehtonen\r
+ * \r
+ * @param <T>\r
+ */\r
+public class Enumeration<T> {\r
+\r
+    private final List<EnumeratedValue<T>> values;\r
+    private final transient int hash;\r
+\r
+    public static <T> Enumeration<T> make(List<EnumeratedValue<T>> values) {\r
+        return new Enumeration<T>(values);\r
+    }\r
+\r
+    public static <T> Enumeration<T> make(EnumeratedValue<T>... values) {\r
+        return new Enumeration<T>(Arrays.asList(values));\r
+    }\r
+\r
+    public Enumeration(List<EnumeratedValue<T>> values) {\r
+        assert values != null;\r
+        this.values = values;\r
+        hash = values.hashCode();\r
+    }\r
+\r
+    public List<EnumeratedValue<T>> values() {\r
+        return values;\r
+    }\r
+\r
+    public boolean contains(EnumeratedValue<T> value) {\r
+        return values.contains(value);\r
+    }\r
+\r
+    public int indexOf(EnumeratedValue<T> value) {\r
+        return values.indexOf(value);\r
+    }\r
+\r
+    public int size() {\r
+        return values.size();\r
+    }\r
+\r
+    /**\r
+     * @param object\r
+     * @return the enumerated value matching the specified object\r
+     * @throws IllegalArgumentException if matching EnumeratedValue not found\r
+     * @throws NullPointerException if null object is specified\r
+     */\r
+    public EnumeratedValue<T> get(T object) {\r
+        if (object == null)\r
+            throw new NullPointerException("null object");\r
+        for (EnumeratedValue<T> value : values)\r
+            if (object.equals(value.getObject()))\r
+                return value;\r
+        throw new IllegalArgumentException("object '" + object + "' not found among enumeration " + values);\r
+    }\r
+\r
+    /**\r
+     * Find an EnumeratedValue<T> matching the specified name.\r
+     * \r
+     * @param name\r
+     * @return <code>null</code> if corresponding EnumeratedValue not found\r
+     */\r
+    public EnumeratedValue<T> findByName(String name) {\r
+        if (name == null)\r
+            return null;\r
+        for (EnumeratedValue<T> value : values)\r
+            if (name.equals(value.getName()))\r
+                return value;\r
+        return null;\r
+    }\r
+\r
+    /**\r
+     * Find an EnumeratedValue<T> matching the specified name.\r
+     * \r
+     * @param name\r
+     * @return <code>null</code> if corresponding EnumeratedValue not found\r
+     */\r
+    public EnumeratedValue<T> findByNameStartsWith(String name) {\r
+        if (name == null)\r
+            return null;\r
+        for (EnumeratedValue<T> value : values)\r
+            if (value.getName().startsWith(name))\r
+                return value;\r
+        return null;\r
+    }\r
+\r
+    /**\r
+     * Find an EnumeratedValue<T> matching the specified object.\r
+     * \r
+     * @param object\r
+     * @return <code>null</code> if corresponding EnumeratedValue not found\r
+     */\r
+    public EnumeratedValue<T> find(T object) {\r
+        if (object == null)\r
+            return null;\r
+        for (EnumeratedValue<T> value : values)\r
+            if (object.equals(value.getObject()))\r
+                return value;\r
+        return null;\r
+    }\r
+\r
+    @Override\r
+    public String toString() {\r
+        return values.toString();\r
+    }\r
+\r
+    @Override\r
+    public int hashCode() {\r
+        return hash;\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
+        Enumeration<?> other = (Enumeration<?>) obj;\r
+        return values.equals(other.values);\r
+    }\r
+\r
+}\r