Record Class MessageEnvelope

java.lang.Object

java.lang.Record

org.j7m.middleware.api.messaging.MessageEnvelope

Record Components:

queue - source queue

partitionId - queue partition

messageId - durable message id

message - message payload and header

state - current message state

priority - message priority

enqueueSequence - enqueue sequence

retryCount - retry count

All Implemented Interfaces:

Serializable

public record MessageEnvelope(QueueName queue, QueuePartitionId partitionId, MessageId messageId, QueueMessage message, MessageState state, MessagePriority priority, long enqueueSequence, int retryCount)
extends Record
implements Serializable

Message plus durable delivery metadata.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MessageEnvelope(QueueName queue, QueuePartitionId partitionId, MessageId messageId, QueueMessage message, MessageState state, MessagePriority priority, long enqueueSequence, int retryCount)	Creates a message envelope.

Method Summary

Modifier and Type	Method	Description
long	enqueueSequence()	Returns the value of the enqueueSequence 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.
QueueMessage	message()	Returns the value of the message record component.
MessageId	messageId()	Returns the value of the messageId record component.
QueuePartitionId	partitionId()	Returns the value of the partitionId record component.
MessagePriority	priority()	Returns the value of the priority record component.
QueueName	queue()	Returns the value of the queue record component.
int	retryCount()	Returns the value of the retryCount record component.
MessageState	state()	Returns the value of the state 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

MessageEnvelope

public MessageEnvelope(QueueName queue,
 QueuePartitionId partitionId,
 MessageId messageId,
 QueueMessage message,
 MessageState state,
 MessagePriority priority,
 long enqueueSequence,
 int retryCount)

Creates a message envelope.

Throws:

IllegalArgumentException - when required values are null or counters are negative

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

queue

public QueueName queue()

Returns the value of the queue record component.

Returns:

the value of the queue record component

partitionId

public QueuePartitionId partitionId()

Returns the value of the partitionId record component.

Returns:

the value of the partitionId record component

messageId

public MessageId messageId()

Returns the value of the messageId record component.

Returns:

the value of the messageId record component

message

public QueueMessage message()

Returns the value of the message record component.

Returns:

the value of the message record component

state

public MessageState state()

Returns the value of the state record component.

Returns:

the value of the state record component

priority

public MessagePriority priority()

Returns the value of the priority record component.

Returns:

the value of the priority record component

enqueueSequence

public long enqueueSequence()

Returns the value of the enqueueSequence record component.

Returns:

the value of the enqueueSequence record component

retryCount

public int retryCount()

Returns the value of the retryCount record component.

Returns:

the value of the retryCount record component