Record Class IdempotencyKey

java.lang.Object
java.lang.Record
org.j7m.middleware.api.reliability.IdempotencyKey
Record Components:
value - stable key value
All Implemented Interfaces:
Serializable
public record IdempotencyKey(String value) extends Record implements Serializable
Explicit caller-supplied idempotency key.

The record is immutable, serializable, and thread-safe. The key is never derived from arbitrary method arguments by this API. Callers must supply a deterministic value that is safe for their domain. toString() does not reveal the raw key.

See Also:

  • Constructor Details

    • IdempotencyKey

      public IdempotencyKey(String value)
      Creates a validated idempotency key.
      Throws:
      IllegalArgumentException - when the value is blank, too long, or not log-safe

  • Method Details

    • toString

      public String toString()
      Specified by:
      toString in class Record

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

    • value

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