picard.sam.util

Class Pair<X extends java.lang.Comparable<X>,Y extends java.lang.Comparable<Y>>

java.lang.Object

picard.sam.util.Pair<X,Y>

All Implemented Interfaces:

java.lang.Comparable<Pair<X,Y>>

public class Pair<X extends java.lang.Comparable<X>,Y extends java.lang.Comparable<Y>>
extends java.lang.Object
implements java.lang.Comparable<Pair<X,Y>>

Simple Pair class. reimplemented since the commons one is final, and I wanted a different toString function...

Constructor Summary

Constructors

Constructor and Description
Pair(X left, Y right)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<X,Y> o)
boolean	equals(java.lang.Object o) Calculate whether this pair object is equal to another object.
X	getLeft()
Y	getRight()
int	hashCode() Basic hashcode function.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pair

public Pair(X left,
            Y right)

Method Detail

getLeft

public X getLeft()

getRight

public Y getRight()

equals

public boolean equals(java.lang.Object o)

Calculate whether this pair object is equal to another object.

Overrides:

equals in class java.lang.Object

Parameters:

o - The other object (hopefully a pair).

Returns:

True if the two are equal; false otherwise.

hashCode

public int hashCode()

Basic hashcode function. Assume hashcodes of left and right are randomly distributed and return the XOR of the two.

Overrides:

hashCode in class java.lang.Object

Returns:

hashcode of the pair.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

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

Specified by:

compareTo in interface java.lang.Comparable<Pair<X extends java.lang.Comparable<X>,Y extends java.lang.Comparable<Y>>>