Package de.scravy.bedrock

Class Pair<A,B>

java.lang.Object

de.scravy.bedrock.Pair<A,B>

Type Parameters:

A - The first component of the tuple.

B - The second component of the tuple.

All Implemented Interfaces:

Tuple2<A,B>, Serializable, Comparable<Pair<A,B>>, Map.Entry<A,B>

@Immutable
public class Pair<A,B>
extends Object
implements Map.Entry<A,B>, Serializable, Comparable<Pair<A,B>>, Tuple2<A,B>

An immutable tuple.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Pair()

Method Summary

Modifier and Type	Method	Description
int	compareTo(Pair<A,B> p)
static <A, B, L extends HList<L>> Pair<A,B>	fromHList(C<A,C<B,L>> hlist)
A	fst()
A	getKey()
B	getValue()
<C, D> Pair<C,D>	map(Function<A,C> f, Function<B,D> g)
<C> Pair<C,B>	mapFirst(Function<A,C> f)
<C> Pair<A,C>	mapSecond(Function<B,C> f)
static <A, B> Pair<A,B>	of(A a, B b)
static <A, B> Pair<A,B>	of(Map.Entry<A,B> entry)
static <A, B> Pair<A,B>	pair(A a, B b)
B	setValue(B value)	Since tuples are immutable this method will throw an UnsupportedOperationException.
B	snd()
Pair<B,A>	swapped()
C<A,C<B,Nil>>	toHList()
static <C, A extends C, B extends C> List<C>	toList(Tuple2<A,B> pair)
static <C, A extends C, B extends C> Seq<C>	toSeq(Tuple2<A,B> pair)
<C> Pair<C,B>	withFirst(C v)
<C> Pair<A,C>	withSecond(C v)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

equals, hashCode

Methods inherited from interface de.scravy.bedrock.Tuple2

apply, getFirst, getSecond, toHList2, toList, toSeq

Constructor Details

Pair

public Pair()

Method Details

fst

public A fst()

snd

public B snd()

getKey

public A getKey()

Specified by:

getKey in interface Map.Entry<A,B>

getValue

public B getValue()

Specified by:

getValue in interface Map.Entry<A,B>

setValue

public B setValue(B value) throws UnsupportedOperationException

Since tuples are immutable this method will throw an UnsupportedOperationException. It is only defined to implement the Map.Entry interface.

Specified by:

setValue in interface Map.Entry<A,B>

Parameters:

value - No matter what you throw in, this method is not supported.

Returns:

Nothing, it throws an UnsupportedOperationException.

Throws:

UnsupportedOperationException - Thrown always.

compareTo

public int compareTo(@Nonnull Pair<A,B> p)

Specified by:

compareTo in interface Comparable<A>

pair

@Nonnull public static <A, B> Pair<A,B> pair(A a, B b)

of

@Nonnull public static <A, B> Pair<A,B> of(A a, B b)

of

@Nonnull public static <A, B> Pair<A,B> of(Map.Entry<A,B> entry)

toList

@Nonnull public static <C, A extends C, B extends C> List<C> toList(@Nonnull Tuple2<A,B> pair)

swapped

@Nonnull public Pair<B,A> swapped()

toHList

@Nonnull public C<A,C<B,Nil>> toHList()

fromHList

public static <A, B, L extends HList<L>> Pair<A,B> fromHList(C<A,C<B,L>> hlist)

toSeq

@Nonnull public static <C, A extends C, B extends C> Seq<C> toSeq(Tuple2<A,B> pair)

map

@Nonnull public <C, D> Pair<C,D> map(Function<A,C> f, Function<B,D> g)

mapFirst

@Nonnull public <C> Pair<C,B> mapFirst(Function<A,C> f)

mapSecond

@Nonnull public <C> Pair<A,C> mapSecond(Function<B,C> f)

withFirst

@Nonnull public <C> Pair<C,B> withFirst(C v)

withSecond

@Nonnull public <C> Pair<A,C> withSecond(C v)