org.incava.ijdk.lang

Class Pair<FirstType extends java.lang.Comparable<? super FirstType>,SecondType extends java.lang.Comparable<? super SecondType>>

java.lang.Object

org.incava.ijdk.lang.Pair<FirstType,SecondType>

All Implemented Interfaces:

java.lang.Comparable<Pair<FirstType,SecondType>>

public class Pair<FirstType extends java.lang.Comparable<? super FirstType>,SecondType extends java.lang.Comparable<? super SecondType>>
extends java.lang.Object
implements java.lang.Comparable<Pair<FirstType,SecondType>>

A two-element tuple, for classes that are comparable. Consider using KeyValue instead, which is more flexible in variable types.

See Also:

KeyValue

Constructor Summary

Constructors

Constructor and Description
Pair(FirstType first, SecondType second)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<FirstType,SecondType> other) Compares this pair to the other.
boolean	equals(java.lang.Object obj) Compares this pair to the object, which should be of type Pair, or otherwise false is returned.
FirstType	first() Returns the first element, with a shorter method name than getFirst.
FirstType	getFirst() Returns the first element.
SecondType	getSecond() Returns the second element.
int	hashCode() Returns a hash code for the pair.
static <X extends java.lang.Comparable<? super X>,Y extends java.lang.Comparable<? super Y>> Pair<X,Y>	of(X first, Y second) Class method that allows inference of the parameterized type.
SecondType	second() Returns the second element, with a shorter method name than getSecond~.
java.lang.String	toString() Returns the pair as a string in the form "first, second".

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(FirstType first,
            SecondType second)

Parameters:

first - the first value in the pair

second - the second value in the pair

Method Detail

of

public static <X extends java.lang.Comparable<? super X>,Y extends java.lang.Comparable<? super Y>> Pair<X,Y> of(X first,
                                                                                                                 Y second)

Class method that allows inference of the parameterized type. The parameters must implement Comparable.

     // compare:
     Pair<String, Integer> pair = new Pair<String, Integer>("Homer", 34);
     Pair<String, Integer> pair = Pair.create("Homer", 34);
 

Type Parameters:

X - the type of the first value; must be Comparable

Y - the type of the second value; must be Comparable

Parameters:

first - the first value in the pair

second - the second value in the pair

Returns:

the created pair

getFirst

public FirstType getFirst()

Returns the first element.

Returns:

the first elememt

getSecond

public SecondType getSecond()

Returns the second element.

Returns:

the second elememt

first

public FirstType first()

Returns the first element, with a shorter method name than getFirst.

Returns:

the first elememt

second

public SecondType second()

Returns the second element, with a shorter method name than getSecond~.

Returns:

the second elememt

equals

public boolean equals(java.lang.Object obj)

Compares this pair to the object, which should be of type Pair, or otherwise false is returned.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to; can be null

Returns:

whether the object equals this pair

compareTo

public int compareTo(Pair<FirstType,SecondType> other)

Compares this pair to the other.

Specified by:

compareTo in interface java.lang.Comparable<Pair<FirstType extends java.lang.Comparable<? super FirstType>,SecondType extends java.lang.Comparable<? super SecondType>>>

Parameters:

other - the other object

Returns:

the comparison value

toString

public java.lang.String toString()

Returns the pair as a string in the form "first, second".

Overrides:

toString in class java.lang.Object

Returns:

the pair in the form "first, second".

hashCode

public int hashCode()

Returns a hash code for the pair.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code