org.hps.util

Class Pair<T,S>

java.lang.Object

org.hps.util.Pair<T,S>

All Implemented Interfaces:

Comparable<Pair<T,S>>

public class Pair<T,S>
extends Object
implements Comparable<Pair<T,S>>

A Class to hold a pair of immutable objects

Version:

$Id: Pair.java,v 1.1 2012/03/26 07:05:28 omoreno Exp $

Author:

Omar Moreno

Field Summary

Fields

Modifier and Type	Field and Description
private T	firstElement
private S	secondElement

Constructor Summary

Constructors

Constructor and Description
Pair(T firstElement, S secondElement) Default constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<T,S> pair) Compares this pair to the specified pair
boolean	equals(Object obj) Checks if the elements in this pair are equal to the elements of the specified pair
T	getFirstElement() Get the first element in the pair
S	getSecondElement() Get the second element in the pair
int	hashCode() The hash code for the pair

Methods inherited from class java.lang.Object

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

Field Detail

firstElement

private final T firstElement

secondElement

private final S secondElement

Constructor Detail

Pair

public Pair(T firstElement,
            S secondElement)

Default constructor

Parameters:

firstElement - The first element in the pair

secondElement - The second element in the pair

Method Detail

getFirstElement

public T getFirstElement()

Get the first element in the pair

Returns:

firstElement The first element in the pair

getSecondElement

public S getSecondElement()

Get the second element in the pair

Returns:

secondElement The second element in the pair

compareTo

public int compareTo(Pair<T,S> pair)

Compares this pair to the specified pair

Specified by:

compareTo in interface Comparable<Pair<T,S>>

Parameters:

pair - The pair to compare to

Returns:

returns 0, 1 or -1 if the hash code of the pair is equal, greater than or less than the specified pair

hashCode

public int hashCode()

The hash code for the pair

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Checks if the elements in this pair are equal to the elements of the specified pair

Overrides:

equals in class Object

Parameters:

obj - The pair to compare to

Returns:

true if both elements are equal, false otherwise