net.maizegenetics.util

Class Tuple<X,Y>

java.lang.Object

net.maizegenetics.util.Tuple<X,Y>

All Implemented Interfaces:

Comparable<Tuple<X,Y>>

public class Tuple<X,Y>
extends Object
implements Comparable<Tuple<X,Y>>

Based on response in http://stackoverflow.com/questions/2670982/using-pairs-or-2-tuples-in-java

Author:

Eli Rodgers-Melnick

Field Summary

Fields

Modifier and Type	Field and Description
X	x
Y	y

Constructor Summary

Constructors

Constructor and Description
Tuple(X x, Y y) Instantiates a tuple object, which just holds 2 values

Method Summary

Modifier and Type	Method and Description
int	compareTo(Tuple<X,Y> o) Using this method (i.e.
boolean	equals(Object obj)
X	getX()
Y	getY()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public final X x

y

public final Y y

Constructor Detail

Tuple

public Tuple(X x,
             Y y)

Instantiates a tuple object, which just holds 2 values

Parameters:

x - The first object

y - The second object

Method Detail

getX

public X getX()

getY

public Y getY()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Tuple<X,Y> o)

Using this method (i.e. sorting Tuples) seems to imply both x and y are Comparable. If that's not the case, results are unpredictable.

Specified by:

compareTo in interface Comparable<Tuple<X,Y>>