Package org.sosy_lab.common.collect

Record Class MapsDifference.Entry<K,V>

java.lang.Object
java.lang.Record
org.sosy_lab.common.collect.MapsDifference.Entry<K,V>
Type Parameters:
K - The type of the key.
V - The type of the values.
Enclosing class:
MapsDifference
@Immutable(containerOf={"K","V"}) public static record MapsDifference.Entry<K,V>(K key, Optional<V> leftValue, Optional<V> rightValue) extends Record
Class representing the difference between two maps for a given key. This class only allows non-null keys and values.

  • Constructor Details

    • Entry

      public Entry(K key, Optional<V> leftValue, Optional<V> rightValue)
      Creates an instance of a Entry record class.
      Parameters:
      key - the value for the key record component
      leftValue - the value for the leftValue record component
      rightValue - the value for the rightValue record component

  • Method Details

    • forLeftValueOnly

      public static <K, V> MapsDifference.Entry<K,V> forLeftValueOnly(K pKey, V pLeftValue)

    • forRightValueOnly

      public static <K, V> MapsDifference.Entry<K,V> forRightValueOnly(K pKey, V pRightValue)

    • forDifferingValues

      public static <K, V> MapsDifference.Entry<K,V> forDifferingValues(K pKey, V pLeftValue, V pRightValue)

    • getKey

      @Deprecated @InlineMe(replacement="this.key()") public K getKey()
      Deprecated.
      Returns the map key.

    • getLeftValue

      @Deprecated @InlineMe(replacement="this.leftValue()") public Optional<V> getLeftValue()
      Deprecated.
      Returns the left value, if present.

    • getRightValue

      @Deprecated @InlineMe(replacement="this.rightValue()") public Optional<V> getRightValue()
      Deprecated.
      Returns the right value, if present.

    • 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

    • leftValue

      public Optional<V> leftValue()
      Returns the value of the leftValue record component.
      Returns:
      the value of the leftValue record component

    • rightValue

      public Optional<V> rightValue()
      Returns the value of the rightValue record component.
      Returns:
      the value of the rightValue record component