ai.eloquent.util

Class Pair<T1,T2>

java.lang.Object

ai.eloquent.util.Pair<T1,T2>

All Implemented Interfaces:

java.lang.Comparable<Pair<T1,T2>>

public class Pair<T1,T2>
extends java.lang.Object
implements java.lang.Comparable<Pair<T1,T2>>

Pair is a Class for holding mutable pairs of objects.

Field Summary

Fields

Modifier and Type	Field and Description
T1	first Direct access is deprecated.
T2	second Direct access is deprecated.

Constructor Summary

Constructors

Constructor and Description
Pair()
Pair(T1 first, T2 second)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<T1,T2> another) Compares this Pair to another object.
boolean	equals(java.lang.Object o)
T1	first()
int	hashCode()
static <X,Y> Pair<X,Y>	makePair(X x, Y y) Returns a Pair constructed from X and Y.
void	save(java.io.DataOutputStream out) Write a string representation of a Pair to a DataStream.
T2	second()
void	setFirst(T1 o)
void	setSecond(T2 o)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

first

public T1 first

Direct access is deprecated. Use first().

second

public T2 second

Direct access is deprecated. Use second().

Constructor Detail

Pair

public Pair()

Pair

public Pair(T1 first,
            T2 second)

Method Detail

first

public T1 first()

second

public T2 second()

setFirst

public void setFirst(T1 o)

setSecond

public void setSecond(T2 o)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

makePair

public static <X,Y> Pair<X,Y> makePair(X x,
                                       Y y)

Returns a Pair constructed from X and Y. Convenience method; the compiler will disambiguate the classes used for you so that you don't have to write out potentially long class names.

save

public void save(java.io.DataOutputStream out)

Write a string representation of a Pair to a DataStream. The toString() method is called on each of the pair of objects and a String representation is written. This might not allow one to recover the pair of objects unless they are of type String.

compareTo

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

Compares this Pair to another object. If the object is a Pair, this function will work providing the elements of the Pair are themselves comparable. It will then return a value based on the pair of objects, where p > q iff p.first() > q.first() || (p.first().equals(q.first()) && p.second() > q.second()). If the other object is not a Pair, it throws a ClassCastException.

Specified by:

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

Parameters:

another - the Object to be compared.

Returns:

the value 0 if the argument is a Pair equal to this Pair; a value less than 0 if the argument is a Pair greater than this Pair; and a value greater than 0 if the argument is a Pair less than this Pair.

Throws:

java.lang.ClassCastException - if the argument is not a Pair.

See Also:

Comparable