bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/modifiers/EnumeratedValue.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.browsing.ui.common.modifiers;\r
  13 \r
  14 import java.util.Comparator;\r
  15 \r
  16 /**\r
  17  * @author Tuukka Lehtonen\r
  18  * \r
  19  * @param <T>\r
  20  */\r
  21 public class EnumeratedValue<T> implements Comparable<EnumeratedValue<T>>{\r
  22 \r
  23     private static class InvalidEnumeratedValue<T> extends EnumeratedValue<T> {\r
  24         public InvalidEnumeratedValue(String name) {\r
  25             super(name, null);\r
  26         }\r
  27     }\r
  28 \r
  29     public static final <T> EnumeratedValue<T> invalid(String name) {\r
  30         return new InvalidEnumeratedValue<T>(name);\r
  31     }\r
  32 \r
  33     public static final boolean isInvalid(EnumeratedValue<?> value) {\r
  34         return value instanceof InvalidEnumeratedValue<?>;\r
  35     }\r
  36 \r
  37     public static final Comparator<EnumeratedValue<? extends Object>> CASE_INSENSITIVE_NAME_ORDER = new Comparator<EnumeratedValue<? extends Object>>() {\r
  38         @Override\r
  39         public int compare(EnumeratedValue<? extends Object> o1, EnumeratedValue<? extends Object> o2) {\r
  40             return o1.getName().compareToIgnoreCase(o2.getName());\r
  41         }\r
  42     };\r
  43 \r
  44     private final String name;\r
  45 \r
  46     private final T      object;\r
  47 \r
  48     public static EnumeratedValue<String> make(String name) {\r
  49         return new EnumeratedValue<String>(name, name);\r
  50     }\r
  51 \r
  52     public static <T> EnumeratedValue<T> make(String name, T object) {\r
  53         return new EnumeratedValue<T>(name, object);\r
  54     }\r
  55 \r
  56     public EnumeratedValue(String name, T object) {\r
  57         if (name == null)\r
  58             throw new NullPointerException("null enumerated value name");\r
  59         this.name = name;\r
  60         this.object = object;\r
  61     }\r
  62 \r
  63     /**\r
  64      * @return the name of the enumerated value\r
  65      */\r
  66     public String getName() {\r
  67         return name;\r
  68     }\r
  69 \r
  70     /**\r
  71      * @return the object bound to this enumerated value, may be\r
  72      *         <code>null</code>\r
  73      */\r
  74     public T getObject() {\r
  75         return object;\r
  76     }\r
  77 \r
  78     @Override\r
  79     public String toString() {\r
  80         return name + "[" + object + "]";\r
  81     }\r
  82 \r
  83     @Override\r
  84     public int compareTo(EnumeratedValue<T> o) {\r
  85         return getName().compareTo(o.getName());\r
  86     }\r
  87 \r
  88     @Override\r
  89     public int hashCode() {\r
  90         final int prime = 31;\r
  91         int result = 1;\r
  92         result = prime * result + name.hashCode();\r
  93         result = prime * result + ((object == null) ? 0 : object.hashCode());\r
  94         return result;\r
  95     }\r
  96 \r
  97     @Override\r
  98     public boolean equals(Object obj) {\r
  99         if (this == obj)\r
 100             return true;\r
 101         if (obj == null)\r
 102             return false;\r
 103         if (getClass() != obj.getClass())\r
 104             return false;\r
 105         EnumeratedValue<?> other = (EnumeratedValue<?>) obj;\r
 106         if (!name.equals(other.name))\r
 107             return false;\r
 108         if (object == null) {\r
 109             if (other.object != null)\r
 110                 return false;\r
 111         } else if (!object.equals(other.object))\r
 112             return false;\r
 113         return true;\r
 114     }\r
 115 \r
 116 }\r