Record Class Pair

java.lang.Object
java.lang.Record
com.nerjal.ip_range_parser.Pair
All Implemented Interfaces:
Comparable<Pair>
public record Pair(BigInteger i1, BigInteger i2) extends Record implements Comparable<Pair>
Represents an immutable pair of BigInteger values. A Pair is a record used to encapsulate two BigInteger values, referred to as i1 and i2. Instances of this class are immutable and thread-safe. The Pair class implements Comparable, allowing pairs to be naturally ordered based on the value of their i1 component. The comparison is performed using the natural ordering of BigInteger.

  • Constructor Details

    • Pair

      public Pair(BigInteger i1, BigInteger i2)
      Creates an instance of a Pair record class.
      Parameters:
      i1 - the value for the i1 record component
      i2 - the value for the i2 record component

  • Method Details

    • compareTo

      public int compareTo(Pair other)
      Specified by:
      compareTo in interface Comparable<Pair>

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

    • i1

      public BigInteger i1()
      Returns the value of the i1 record component.
      Returns:
      the value of the i1 record component

    • i2

      public BigInteger i2()
      Returns the value of the i2 record component.
      Returns:
      the value of the i2 record component