bundles/org.simantics.utils.datastructures/src/org/simantics/utils/datastructures/Pair.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.utils.datastructures;\r
  13 \r
  14 \r
  15 /**\r
  16  * A generic Pair (2-tuple) structure for containing two object instances of\r
  17  * chosen types.\r
  18  * \r
  19  * @param <T1> type of first element\r
  20  * @param <T2> type of second element\r
  21  */\r
  22 public final class Pair<T1, T2> implements Comparable<Pair<T1, T2>> {\r
  23     public final T1 first;\r
  24     public final T2 second;\r
  25     private final int hash;\r
  26 \r
  27     public static <T1, T2> Pair<T1, T2> make(T1 t1, T2 t2) {\r
  28         return new Pair<T1, T2>(t1, t2);\r
  29     }\r
  30 \r
  31     public Pair(T1 first, T2 second) {\r
  32         //assert(first != null);\r
  33         //assert(second != null);\r
  34         \r
  35         this.first = first;\r
  36         this.second = second;\r
  37         this.hash = makeHash();\r
  38     }\r
  39     \r
  40     @Override\r
  41     public boolean equals(Object obj) {\r
  42         if (obj == null)\r
  43             return false;\r
  44         if (!(obj.getClass().equals(this.getClass())))\r
  45             return false;\r
  46         Pair<?, ?> other = (Pair<?, ?>) obj;\r
  47         if (other.first != first && (other.first == null || !other.first.equals(first)))\r
  48             return false;\r
  49         if (other.second != second && (other.second == null || !other.second.equals(second)))\r
  50             return false;\r
  51         return true;\r
  52     }\r
  53     \r
  54     @Override\r
  55     public int hashCode() {\r
  56         return hash;\r
  57     }\r
  58     \r
  59     @Override\r
  60     public String toString() {\r
  61         return "<"+first+", "+second+">";\r
  62     }\r
  63     \r
  64     private int makeHash() {\r
  65         return (first == null ? 0 : first.hashCode()) + (second == null ? 0 : second.hashCode())*31;\r
  66     }\r
  67 \r
  68         @Override\r
  69         public int compareTo(Pair<T1, T2> arg0) {\r
  70                 return hash - arg0.hash;\r
  71         }\r
  72         \r
  73 }\r