Module overrungl.core
Package overrungl.util.value

Record Class Pair<T>

java.lang.Object
java.lang.Record
overrungl.util.value.Pair<T>
Type Parameters:
T - the type.
Record Components:
x - the first value.
y - the second value.
public record Pair<T>(T x, T y) extends Record
A pair of the same type objects.
Since:
0.1.0
Author:
squid233

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    Pair.OfDouble
    A pair of doubles.
    static final record 
    Pair.OfFloat
    A pair of floats.
    static final record 
    Pair.OfInt
    A pair of integers.
    static final record 
    Pair.OfLong
    A pair of longs.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Pair(T x, T y)
    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.
    T
    first()
    Returns x.
    final int
    hashCode()
    Returns a hash code value for this object.
    T
    key()
    Returns x.
    T
    left()
    Returns x.
    T
    right()
    Returns y.
    T
    second()
    Returns y.
    final String
    toString()
    Returns a string representation of this record class.
    T
    value()
    Returns y.
    T
    x()
    Returns the value of the x record component.
    T
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Pair

      public Pair(T x, T y)
      Creates an instance of a Pair record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component

  • Method Details

    • first

      public T first()
      Returns x.
      Returns:
      x

    • second

      public T second()
      Returns y.
      Returns:
      y

    • left

      public T left()
      Returns x.
      Returns:
      x

    • right

      public T right()
      Returns y.
      Returns:
      y

    • key

      public T key()
      Returns x.
      Returns:
      x

    • value

      public T value()
      Returns y.
      Returns:
      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.

    • x

      public T x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public T y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component