Record Class MessageLease

java.lang.Object

java.lang.Record

org.j7m.middleware.api.messaging.MessageLease

Record Components:

envelope - leased message envelope

leaseId - lease identity

consumerId - owning consumer

leaseUntil - lease expiration instant

All Implemented Interfaces:

Serializable

public record MessageLease(MessageEnvelope envelope, LeaseId leaseId, ConsumerId consumerId, Instant leaseUntil)
extends Record
implements Serializable

Leased message returned to a consumer.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MessageLease(MessageEnvelope envelope, LeaseId leaseId, ConsumerId consumerId, Instant leaseUntil)	Creates a message lease.

Method Summary

Modifier and Type	Method	Description
ConsumerId	consumerId()	Returns the value of the consumerId record component.
MessageEnvelope	envelope()	Returns the value of the envelope record component.
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.
Instant	leaseUntil()	Returns the value of the leaseUntil 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

MessageLease

public MessageLease(MessageEnvelope envelope,
 LeaseId leaseId,
 ConsumerId consumerId,
 Instant leaseUntil)

Creates a message lease.

Throws:

IllegalArgumentException - when any component is null

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.

envelope

public MessageEnvelope envelope()

Returns the value of the envelope record component.

Returns:

the value of the envelope record component

leaseId

public LeaseId leaseId()

Returns the value of the leaseId record component.

Returns:

the value of the leaseId record component

consumerId

public ConsumerId consumerId()

Returns the value of the consumerId record component.

Returns:

the value of the consumerId record component

leaseUntil

public Instant leaseUntil()

Returns the value of the leaseUntil record component.

Returns:

the value of the leaseUntil record component