cz.auderis.tools.collection.tuple

Class Pair<L,R>

java.lang.Object

cz.auderis.tools.collection.tuple.Pair<L,R>

Type Parameters:

L - the type parameter

R - the type parameter

All Implemented Interfaces:

Serializable, Map.Entry<L,R>

Direct Known Subclasses:

AtomicPair, BasicPair, ImmutablePair

public abstract class Pair<L,R>
extends Object
implements Map.Entry<L,R>, Serializable

The type Pair.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Pair()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
L	getKey()
abstract L	getLeft() Gets left.
abstract R	getRight() Gets right.
R	getValue()
int	hashCode() Generates hash code conforming with Map.Entry.hashCode() specification.
static <L,R> Pair<L,R>	immutable(L left, R right) Immutable pair.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, setValue

Constructor Detail

Pair

public Pair()

Method Detail

immutable

public static <L,R> Pair<L,R> immutable(L left,
                                        R right)

Immutable pair.

Type Parameters:

L - the type parameter

R - the type parameter

Parameters:

left - the left

right - the right

Returns:

the pair

getLeft

public abstract L getLeft()

Gets left.

Returns:

the left

getRight

public abstract R getRight()

Gets right.

Returns:

the right

getKey

public final L getKey()

Specified by:

getKey in interface Map.Entry<L,R>

getValue

public final R getValue()

Specified by:

getValue in interface Map.Entry<L,R>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map.Entry<L,R>

Overrides:

equals in class Object

hashCode

public int hashCode()

Generates hash code conforming with Map.Entry.hashCode() specification.

Specified by:

hashCode in interface Map.Entry<L,R>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object