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

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