Record Class InboxStatus

java.lang.Object

java.lang.Record

org.j7m.middleware.api.messaging.InboxStatus

Record Components:

recorded - number of recorded inbound identities

suppressed - number of suppressed duplicates

metrics - queue-wide messaging metrics snapshot

lastError - redacted last error code or message

All Implemented Interfaces:

Serializable

public record InboxStatus(long recorded, long suppressed, QueueMetricsSnapshot metrics, String lastError)
extends Record
implements Serializable

Inbox duplicate suppression status.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InboxStatus(long recorded, long suppressed, QueueMetricsSnapshot metrics, String lastError)	Creates inbox status.

Method Summary

Modifier and Type	Method	Description
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.
String	lastError()	Returns the value of the lastError record component.
QueueMetricsSnapshot	metrics()	Returns the value of the metrics record component.
long	recorded()	Returns the value of the recorded record component.
long	suppressed()	Returns the value of the suppressed 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

InboxStatus

public InboxStatus(long recorded,
 long suppressed,
 QueueMetricsSnapshot metrics,
 String lastError)

Creates inbox status.

Throws:

IllegalArgumentException - when 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.

recorded

public long recorded()

Returns the value of the recorded record component.

Returns:

the value of the recorded record component

suppressed

public long suppressed()

Returns the value of the suppressed record component.

Returns:

the value of the suppressed record component

metrics

public QueueMetricsSnapshot metrics()

Returns the value of the metrics record component.

Returns:

the value of the metrics record component

lastError

public String lastError()

Returns the value of the lastError record component.

Returns:

the value of the lastError record component