lib.easyjava.type

Class Pair<T1,T2>

java.lang.Object

lib.easyjava.type.Pair<T1,T2>

Type Parameters:

T1 - the type of the left item in the pair

T2 - the type of the right item in the pair

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Pair<T1,T2>>, java.util.Map.Entry<T1,T2>

Direct Known Subclasses:

UnmodifiablePair

public class Pair<T1,T2>
extends java.lang.Object
implements java.util.Map.Entry<T1,T2>, java.lang.Comparable<Pair<T1,T2>>, java.io.Serializable

A simple Pair implementation

Author:

Rob Rua (robrua@alumni.cmu.edu)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pair(Pair<T1,T2> pair)
Pair(T1 left, T2 right)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<T1,T2> other)
boolean	equals(java.lang.Object obj)
T1	getKey()
T1	getLeft() Gets the left item in the pair
T2	getRight() Gets the right item in the pair
T2	getValue()
int	hashCode()
void	setKey(T1 key) Replaces the key corresponding to this entry with the specified key (optional operation).
void	setLeft(T1 left) Sets the left item in the pair
void	setRight(T2 right) Sets the right item in the pair
T2	setValue(T2 value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

Pair

public Pair(Pair<T1,T2> pair)

Parameters:

pair - a Pair to copy a new one from

Pair

public Pair(T1 left,
            T2 right)

Parameters:

left - the left item in the pair

right - the right item in the pair

Method Detail

compareTo

public int compareTo(Pair<T1,T2> other)

Specified by:

compareTo in interface java.lang.Comparable<Pair<T1,T2>>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map.Entry<T1,T2>

Overrides:

equals in class java.lang.Object

getKey

public T1 getKey()

Specified by:

getKey in interface java.util.Map.Entry<T1,T2>

getLeft

public T1 getLeft()

Gets the left item in the pair

Returns:

the left item in the pair

getRight

public T2 getRight()

Gets the right item in the pair

Returns:

the right item in the pair

getValue

public T2 getValue()

Specified by:

getValue in interface java.util.Map.Entry<T1,T2>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map.Entry<T1,T2>

Overrides:

hashCode in class java.lang.Object

setKey

public void setKey(T1 key)

Replaces the key corresponding to this entry with the specified key (optional operation).

Parameters:

key - the new key for the pair

setLeft

public void setLeft(T1 left)

Sets the left item in the pair

Parameters:

left - the new left item for the pair

setRight

public void setRight(T2 right)

Sets the right item in the pair

Parameters:

right - the new right item for the pair

setValue

public T2 setValue(T2 value)

Specified by:

setValue in interface java.util.Map.Entry<T1,T2>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object