com.io7m.jfunctional

Class Pair<A,B>

java.lang.Object

com.io7m.jfunctional.Pair<A,B>

Type Parameters:

A - The type of left values.

B - The type of right values.

All Implemented Interfaces:

Serializable

@EqualityStructural
public final class Pair<A,B>
extends Object
implements Serializable

Immutable generic pair type.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
A	getLeft()
B	getRight()
int	hashCode()
static <A,B> Pair<A,B>	pair(A left, B right) Return a new pair (left, right).
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

pair

public static <A,B> Pair<A,B> pair(A left,
                                   B right)

Return a new pair (left, right).

Type Parameters:

A - The type of left values.

B - The type of right values.

Parameters:

left - The left value

right - The right value

Returns:

A new pair

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

getLeft

public A getLeft()

Returns:

The left value of the pair.

getRight

public B getRight()

Returns:

The right value of the pair.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object