View Javadoc

1   /*
2    *   Magic-Project is a turn based strategy simulator
3    *   Copyright (C) 2003-2007 Fabrice Daugan
4    *
5    *   This program is free software; you can redistribute it and/or modify it 
6    * under the terms of the GNU General Public License as published by the Free 
7    * Software Foundation; either version 2 of the License, or (at your option) any
8    * later version.
9    *
10   *   This program is distributed in the hope that it will be useful, but WITHOUT 
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
13   * details.
14   *
15   *   You should have received a copy of the GNU General Public License along  
16   * with this program; if not, write to the Free Software Foundation, Inc., 
17   * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   * 
19   */
20  package net.sf.magicproject.tools;
21  
22  /***
23   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
24   * @param <K>
25   *          key
26   * @param <V>
27   *          value
28   * @since 0.80
29   */
30  public class Pair<K extends Comparable<K>, V> implements Comparable<Pair<K, V>> {
31  
32  	/***
33  	 * The stored string instance. (key)
34  	 */
35  	public K key;
36  
37  	/***
38  	 * The stored string instance. (value)
39  	 */
40  	public V value;
41  
42  	/***
43  	 * Creates a new instance of this class <br>
44  	 * 
45  	 * @param key
46  	 * @param value
47  	 */
48  	public Pair(K key, V value) {
49  		this.key = key;
50  		this.value = value;
51  	}
52  
53  	public int compareTo(Pair<K, V> arg0) {
54  		return key.compareTo(arg0.key);
55  	}
56  
57  	@Override
58  	public boolean equals(Object arg0) {
59  		if (arg0 instanceof String) {
60  			return key.toString().equals(arg0);
61  		} else if (arg0 instanceof Pair) {
62  			Pair<?, ?> pair = (Pair) arg0;
63  			return key.equals(pair.key);
64  		}
65  		return false;
66  	}
67  
68  	@Override
69  	public String toString() {
70  		return "{" + key + ":" + value + "}";
71  	}
72  
73  	@Override
74  	public int hashCode() {
75  		return key.hashCode();
76  	}
77  }