Package org.apache.spark.util

Record Class Pair<L,R>

Object
Record
org.apache.spark.util.Pair<L,R>
public record Pair<L,R>(L getLeft, R getRight) extends Record
An immutable pair of values. Note that the fields are intentionally designed to be `getLeft` and `getRight` instead of `left` and `right` in order to mitigate the migration burden from `org.apache.commons.lang3.tuple.Pair`.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Pair(L getLeft, R getRight)
    Creates an instance of a Pair record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    L
    getLeft()
    Returns the value of the getLeft record component.
    R
    getRight()
    Returns the value of the getRight record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static <L, R> Pair<L,R>
    of(L left, R right)
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Pair

      public Pair(L getLeft, R getRight)
      Creates an instance of a Pair record class.
      Parameters:
      getLeft - the value for the getLeft record component
      getRight - the value for the getRight record component

  • Method Details

    • of

      public static <L, R> Pair<L,R> of(L left, R right)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • getLeft

      public L getLeft()
      Returns the value of the getLeft record component.
      Returns:
      the value of the getLeft record component

    • getRight

      public R getRight()
      Returns the value of the getRight record component.
      Returns:
      the value of the getRight record component