Record Class AckOptions

java.lang.Object
java.lang.Record
org.j7m.middleware.api.messaging.AckOptions
Record Components:
leaseId - expected lease identifier
All Implemented Interfaces:
Serializable
public record AckOptions(LeaseId leaseId) extends Record implements Serializable
Acknowledge options for a currently leased message.

Production queue implementations require the current lease identifier for normal mutation. A null lease identifier is retained only as a source-compatible construction value; implementations must fail safely rather than acknowledge a message without validating the current lease owner.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    AckOptions(LeaseId leaseId)
    Creates an instance of a AckOptions record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AckOptions
    defaults()
    Returns default acknowledge options without an explicit lease id.
    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.
    LeaseId
    leaseId()
    Returns the value of the leaseId record component.
    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

    • AckOptions

      public AckOptions(LeaseId leaseId)
      Creates an instance of a AckOptions record class.
      Parameters:
      leaseId - the value for the leaseId record component

  • Method Details

    • defaults

      public static AckOptions defaults()
      Returns default acknowledge options without an explicit lease id.

      Calling a production queue with this value is expected to fail with a stale fencing or lease-token error unless the implementation documents a narrower internal repair path.

      Returns:
      default acknowledge options

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

    • leaseId

      public LeaseId leaseId()
      Returns the value of the leaseId record component.
      Returns:
      the value of the leaseId record component