Pair

  • The Pair class is a container for holding two objects of any type, referred to as first and second.

  • It provides a convenient way to group related data together and pass it around as a single unit.

  • Equality between Pair objects is determined by the equality of their respective first and second elements.

  • A create method offers a simplified approach to creating Pair instances with automatic type inference.

  • hashCode is implemented based on the hash codes of the contained objects for efficient use in hash-based collections.
public class Pair extends 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

public final F first
public final S second

Public Constructor Summary

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

Public Method Summary

static <A, B> Pair<A, B>
create(A a, B b)
Convenience method for creating an appropriately typed pair.
boolean
equals(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

Inherited Method Summary

Fields

public final F first

public final S second

Public Constructors

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

Public Methods

public static 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

public boolean equals (Object o)

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

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

public int hashCode ()

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

Returns
  • a hashcode of the Pair