org.radix.common.tuples

Class Pair<F,S>

java.lang.Object

org.radix.common.tuples.Pair<F,S>

Type Parameters:

F - Type of the first element

S - Type of the second element

public final class Pair<F,S>
extends java.lang.Object

An immutable pair of elements.

Note that in reality, as for all containers, instances of this class are only immutable if their contained objects are also immutable.

Constructor Summary

Constructors

Constructor and Description
Pair(F first, S second) Constructor for a pair of items.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
F	getFirst() Retrieve the first element from this pair.
S	getSecond() Retrieve the second element from this pair.
int	hashCode()
static <A,B> Pair<A,B>	of(A first, B second) Create a pair from the specified arguments.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(F first,
            S second)

Constructor for a pair of items.

Please consider using the factory method of(Object, Object) instead of this constructor.

Parameters:

first - The first element of the pair.

second - The second element of the pair.

Method Detail

of

public static <A,B> Pair<A,B> of(A first,
                                 B second)

Create a pair from the specified arguments.

Parameters:

first - The first element of the pair.

second - The second element of the pair.

Returns:

A Pair containing first and second.

getFirst

public F getFirst()

Retrieve the first element from this pair.

Returns:

The first element.

getSecond

public S getSecond()

Retrieve the second element from this pair.

Returns:

The second element.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object