uk.co.strangeskies.collection.tuple

Class Pair<L,R>

java.lang.Object

uk.co.strangeskies.collection.tuple.Tuple<L,Unit<R>>

uk.co.strangeskies.collection.tuple.Pair<L,R>

Type Parameters:

L - The type of the first, left, item.

R - The type of the second, right, item.

public class Pair<L,R>
extends Tuple<L,Unit<R>>

A two tuple.

Constructor Summary

Constructors

Constructor and Description
Pair(L left, R right) Initialise a pair with the given two values.

Method Summary

Modifier and Type	Method and Description
L	get0()
R	get1()
L	getLeft()
R	getRight()
<I> Pair<I,R>	mapHead(java.util.function.Function<? super L,? extends I> headMap) Map the value of the head entry.

Methods inherited from class uk.co.strangeskies.collection.tuple.Tuple

equals, getHead, getSize, getTail, hasTail, mapTail, next, prepend, setHead, setTail, tailCounter, toString, toSubStrings

Methods inherited from class java.lang.Object

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

Constructor Detail

Pair

public Pair(L left,
            R right)

Initialise a pair with the given two values.

Parameters:

left - The first, left, item.

right - The second, right, item.

Method Detail

get0

public L get0()

Returns:

The head value.

getLeft

public L getLeft()

Returns:

The head value.

get1

public R get1()

Returns:

The tail value.

getRight

public R getRight()

Returns:

The tail value.

mapHead

public <I> Pair<I,R> mapHead(java.util.function.Function<? super L,? extends I> headMap)

Description copied from class: Tuple

Map the value of the head entry.

Overrides:

mapHead in class Tuple<L,Unit<R>>

Type Parameters:

I - The type of the head of the new Tuple.

Parameters:

headMap - A mapping to a new head value. The result should be non-null.

Returns:

A new derived tuple with the head value transformed by the given mapping.