com.github.signaflo.data.Pair Maven / Gradle / Ivy
package com.github.signaflo.data;
import lombok.NonNull;
/**
* Represents a 2-tuple. This class is immutable and thread-safe only if the runtime classes
* represented by the type parameters are.
*
* @param the type of the first element.
* @param the type of the second element.
*/
public final class Pair, S extends Comparable>
implements Comparable> {
private final T first;
private final S second;
static Pair intPair(Integer first, Integer second) {
return new Pair<>(first, second);
}
public static , S extends Comparable> Pair newPair(T first, S second) {
return new Pair<>(first, second);
}
private Pair(@NonNull T first, @NonNull S second) {
this.first = first;
this.second = second;
}
public T first() {
return this.first;
}
public S second() {
return this.second;
}
/**
* Compare this pair to another pair for lexicographic ordering.
* The algorithm was adapted from the top answer here.
*
* @param otherPair the pair to compare this one to.
* @return an integer value satisfying the {@link Comparable#compareTo(Object)} contract.
*/
@Override
public int compareTo(@NonNull Pair otherPair) {
int result = this.first.compareTo(otherPair.first);
if (result != 0) {
return result;
}
return this.second.compareTo(otherPair.second);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Pair pair = (Pair) o;
return first.equals(pair.first) && second.equals(pair.second);
}
@Override
public int hashCode() {
int result = first.hashCode();
result = 31 * result + second.hashCode();
return result;
}
@Override
public String toString() {
return "(" + first.toString() + ", " + second.toString() + ")";
}
}