Module toolbox.tuple
Package org.spokbjorn.tuple

Record Class Pentad<T,U,V,W,X>

java.lang.Object
java.lang.Record
org.spokbjorn.tuple.Pentad<T,U,V,W,X>
Type Parameters:
T - the type of the value for the first parameter
U - the type of the value for the second parameter
V - the type of the value for the third parameter
W - the type of the value for the fourth parameter
X - the type of the value for the fifth parameter
All Implemented Interfaces:
Tuple
public record Pentad<T,U,V,W,X>(T first, U second, V third, W fourth, X fifth) extends Record implements Tuple
Represents a pentad of values.

There is no meaning to values in this class, it can be used for any purpose.

Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    Pentad(T first, U second, V third, W fourth, X fifth)
    Creates an instance of a Pentad record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    X
    fifth()
    Returns the value of the fifth record component.
    T
    first()
    Returns the value of the first record component.
    W
    fourth()
    Returns the value of the fourth record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    U
    second()
    Returns the value of the second record component.
    V
    third()
    Returns the value of the third record component.
    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

    • Pentad

      public Pentad(T first, U second, V third, W fourth, X fifth)
      Creates an instance of a Pentad record class.
      Parameters:
      first - the value for the first record component
      second - the value for the second record component
      third - the value for the third record component
      fourth - the value for the fourth record component
      fifth - the value for the fifth 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.

    • first

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

    • second

      public U second()
      Returns the value of the second record component.
      Returns:
      the value of the second record component

    • third

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

    • fourth

      public W fourth()
      Returns the value of the fourth record component.
      Returns:
      the value of the fourth record component

    • fifth

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