Package utils

Record Class Pair<K,V>

java.lang.Object
java.lang.Record
utils.Pair<K,V>
Type Parameters:
K - key
V - value
public record Pair<K,V>(K key, V value) extends Record
Key value pair
Since:
31/07/2023
Author:
Killian Monnier

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final K
    key
    The field for the key record component.
    private final V
    value
    The field for the value record component.

  • Constructor Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • key

      private final K key
      The field for the key record component.

    • value

      private final V value
      The field for the value record component.

  • Constructor Details

    • Pair

      public Pair(K key, V value)
      Creates an instance of a Pair record class.
      Parameters:
      key - the value for the key record component
      value - the value for the value record component

  • Method Details

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

    • key

      public K key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • value

      public V value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component