Record Class Tuple2<A,B>

java.lang.Object
java.lang.Record
dmx.fun.Tuple2<A,B>
Type Parameters:
A - the type of the first element
B - the type of the second element
Record Components:
_1 - the first element
_2 - the second element
@NullMarked public record Tuple2<A,B>(A _1, B _2) extends Record
An immutable tuple holding two values of potentially different types.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Tuple2(A _1, B _2)
    Creates an instance of a Tuple2 record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    A
    _1()
    Returns the value of the _1 record component.
    B
    _2()
    Returns the value of the _2 record component.
    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.
    <R> R
    map(BiFunction<? super A, ? super B, ? extends R> f)
    Collapses this pair into a single value by applying f to both elements.
    <R> Tuple2<R,B>
    mapFirst(Function<? super A, ? extends R> f)
    Returns a new tuple with f applied to the first element; the second element is unchanged.
    <R> Tuple2<A,R>
    mapSecond(Function<? super B, ? extends R> f)
    Returns a new tuple with f applied to the second element; the first element is unchanged.
    static <A,B> Tuple2<A,B>
    of(A a, B b)
    Creates a new Tuple2 with the given elements.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • Tuple2

      public Tuple2(A _1, B _2)
      Creates an instance of a Tuple2 record class.
      Parameters:
      _1 - the value for the _1 record component
      _2 - the value for the _2 record component

  • Method Details

    • of

      public static <A,B> Tuple2<A,B> of(A a, B b)
      Creates a new Tuple2 with the given elements.
      Type Parameters:
      A - the type of the first element
      B - the type of the second element
      Parameters:
      a - the first element
      b - the second element
      Returns:
      a new Tuple2 containing the two values

    • mapFirst

      public <R> Tuple2<R,B> mapFirst(Function<? super A, ? extends R> f)
      Returns a new tuple with f applied to the first element; the second element is unchanged.
      Type Parameters:
      R - the type of the new first element
      Parameters:
      f - the mapping function; must not be null and must not return null
      Returns:
      a new Tuple2 with the transformed first element
      Throws:
      NullPointerException - if f is null or returns null

    • mapSecond

      public <R> Tuple2<A,R> mapSecond(Function<? super B, ? extends R> f)
      Returns a new tuple with f applied to the second element; the first element is unchanged.
      Type Parameters:
      R - the type of the new second element
      Parameters:
      f - the mapping function; must not be null and must not return null
      Returns:
      a new Tuple2 with the transformed second element
      Throws:
      NullPointerException - if f is null or returns null

    • map

      public <R> R map(BiFunction<? super A, ? super B, ? extends R> f)
      Collapses this pair into a single value by applying f to both elements.
      Type Parameters:
      R - the type of the result
      Parameters:
      f - the combining function
      Returns:
      the non-null result of applying f to _1 and _2

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

    • _1

      public A _1()
      Returns the value of the _1 record component.
      Returns:
      the value of the _1 record component

    • _2

      public B _2()
      Returns the value of the _2 record component.
      Returns:
      the value of the _2 record component