com.github.signaflo.data

Class Pair<T extends Comparable<T>,S extends Comparable<S>>

java.lang.Object

com.github.signaflo.data.Pair<T,S>

Type Parameters:

T - the type of the first element.

S - the type of the second element.

All Implemented Interfaces:

Comparable<Pair<T,S>>

public final class Pair<T extends Comparable<T>,S extends Comparable<S>>
extends Object
implements Comparable<Pair<T,S>>

Represents a 2-tuple. This class is immutable and thread-safe only if the runtime classes represented by the type parameters are.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Pair<T,S> otherPair) Compare this pair to another pair for lexicographic ordering.
boolean	equals(Object o)
T	first()
int	hashCode()
static <T extends Comparable<T>,S extends Comparable<S>> Pair<T,S>	newPair(T first, S second)
S	second()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newPair

public static <T extends Comparable<T>,S extends Comparable<S>> Pair<T,S> newPair(T first,
                                                                                  S second)

first

public T first()

second

public S second()

compareTo

public int compareTo(@NonNull
                     Pair<T,S> otherPair)

Compare this pair to another pair for lexicographic ordering. The algorithm was adapted from the top answer here.

Specified by:

compareTo in interface Comparable<Pair<T extends Comparable<T>,S extends Comparable<S>>>

Parameters:

otherPair - the pair to compare this one to.

Returns:

an integer value satisfying the Comparable.compareTo(Object) contract.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object