com.github.jparkie.promise.extras

Class Pair<F,S>

java.lang.Object

com.github.jparkie.promise.extras.Pair<F,S>

public class Pair<F,S>
extends java.lang.Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
F	first
S	second

Constructor Summary

Constructors

Constructor and Description
Pair(F first, S second) Constructor for a Pair.

Method Summary

Modifier and Type	Method and Description
static <A,B> Pair<A,B>	create(A a, B b) Convenience method for creating an appropriately typed pair.
boolean	equals(java.lang.Object o) Checks the two objects for equality by delegating to their respective Object.equals(Object) methods.
int	hashCode() Compute a hash code using the hash codes of the underlying objects

Methods inherited from class java.lang.Object

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

Field Detail

first

public final F first

second

public final S second

Constructor Detail

Pair

public Pair(F first,
            S second)

Constructor for a Pair.

Parameters:

first - the first object in the Pair

second - the second object in the pair

Method Detail

equals

public boolean equals(java.lang.Object o)

Checks the two objects for equality by delegating to their respective Object.equals(Object) methods.

Overrides:

equals in class java.lang.Object

Parameters:

o - the Pair to which this one is to be checked for equality

Returns:

true if the underlying objects of the Pair are both considered equal

hashCode

public int hashCode()

Compute a hash code using the hash codes of the underlying objects

Overrides:

hashCode in class java.lang.Object

Returns:

a hashcode of the Pair

create

public static <A,B> Pair<A,B> create(A a,
                                     B b)

Convenience method for creating an appropriately typed pair.

Parameters:

a - the first object in the Pair

b - the second object in the pair

Returns:

a Pair that is templatized with the types of a and b