ProjectAres/Util/core/src/main/java/tc/oc/commons/core/util/Pair.java

82 lines
2.2 KiB
Java

package tc.oc.commons.core.util;
import com.google.common.base.Objects;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
/**
* Container to ease passing around a tuple of two objects. This object provides a sensible
* implementation of equals(), returning true if equals() is true on each of the contained
* objects.
*
* http://stackoverflow.com/a/18586688/6342
*/
public class Pair<F, S> {
public final F first;
public final S second;
/**
* Constructor for a Pair.
*
* @param first the first object in the Pair
* @param second the second object in the pair
*/
public Pair(F first, S second) {
this.first = first;
this.second = second;
}
public void feed(BiConsumer<F, S> block) {
block.accept(first, second);
}
public <R> R transform(BiFunction<F, S, R> block) {
return block.apply(first, second);
}
/**
* Checks the two objects for equality by delegating to their respective
* {@link Object#equals(Object)} methods.
*
* @param o the {@link Pair} to which this one is to be checked for equality
* @return true if the underlying objects of the Pair are both considered
* equal
*/
@Override
public boolean equals(Object o) {
if (!(o instanceof Pair)) {
return false;
}
Pair<?, ?> p = (Pair<?, ?>) o;
return Objects.equal(p.first, first) && Objects.equal(p.second, second);
}
/**
* Compute a hash code using the hash codes of the underlying objects
*
* @return a hashcode of the Pair
*/
@Override
public int hashCode() {
return (first == null ? 0 : first.hashCode()) ^ (second == null ? 0 : second.hashCode());
}
/**
* Convenience method for creating an appropriately typed pair.
* @param a the first object in the Pair
* @param b the second object in the pair
* @return a Pair that is templatized with the types of a and b
*/
public static <A, B> Pair <A, B> create(A a, B b) {
return new Pair<>(a, b);
}
/**
* Alias for {@link #create(Object, Object)}
*/
public static <A, B> Pair <A, B> of(A a, B b) {
return new Pair<>(a, b);
}
}