Package com.ontology2.pidove.util

Record Class Pair<X,Y>

java.lang.Object
java.lang.Record
com.ontology2.pidove.util.Pair<X,Y>
Type Parameters:
X - type of first value
Y - type of second value
Record Components:
left - first value
right - second value
All Implemented Interfaces:
Tuple<X,Y>
public record Pair<X,Y>(X left, Y right) extends Record implements Tuple<X,Y>
Tuple of length 2

  • Constructor Summary

    Constructors
    Constructor
    Description
    Pair(X left, Y right)
    Creates an instance of a Pair record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    <Z> Trio<X,Y,Z>
    and(Z right)
    Adds a third value to make this a Trio.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    X
    first()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    Y
    last()
     
    X
    left()
    Returns the value of the left record component.
    static <X, Y> Pair<X,Y>
    of(X l, Y r)
    static factory method
    Pair<Y,X>
    reverse()
     
    Y
    right()
    Returns the value of the right record component.
    int
    size()
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Pair

      public Pair(X left, Y right)
      Creates an instance of a Pair record class.
      Parameters:
      left - the value for the left record component
      right - the value for the right record component

  • Method Details

    • of

      public static <X, Y> Pair<X,Y> of(X l, Y r)
      static factory method
      Type Parameters:
      X - type of first value
      Y - type of second value
      Parameters:
      l - first value
      r - second value
      Returns:
      new pair

    • and

      public <Z> Trio<X,Y,Z> and(Z right)
      Adds a third value to make this a Trio. The current right value becomes the middle
      Type Parameters:
      Z - type of the new value
      Parameters:
      right - new value
      Returns:
      a Trio where the first two values come from here and the third value is the one passed in

    • reverse

      public Pair<Y,X> reverse()
      Returns:
      a new pair with the left and right values switched

    • size

      public int size()
      Specified by:
      size in interface Tuple<X,Y>

    • first

      public X first()
      Specified by:
      first in interface Tuple<X,Y>

    • last

      public Y last()
      Specified by:
      last in interface Tuple<X,Y>

    • 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.

    • left

      public X left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • right

      public Y right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component