bundles/org.simantics.browsing.ui.common/src/org/simantics/browsing/ui/common/Preference.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;\r
  13 \r
  14 /**\r
  15  * A generic wrapper that associates a double-based preference indicator value\r
  16  * for any object. This class can be used make objects comparable.\r
  17  * \r
  18  * @author Tuukka Lehtonen\r
  19  * \r
  20  * @param <T> the type of the object to be made comparable\r
  21  */\r
  22 public class Preference<T> implements Comparable<Preference<T>> {\r
  23     public final T      object;\r
  24     public final double preference;\r
  25 \r
  26     public Preference(T object, double preference) {\r
  27         this.object = object;\r
  28         this.preference = preference;\r
  29     }\r
  30 \r
  31     @Override\r
  32     public int compareTo(Preference<T> other) {\r
  33         if (preference == other.preference)\r
  34             return 0;\r
  35         return (preference > other.preference) ? -1 : 1;\r
  36     }\r
  37     \r
  38     @Override\r
  39     public String toString() {\r
  40         return object + " with preference " + preference;\r
  41     }\r
  42     \r
  43 }