Record Class ReceiveResult.Received

java.lang.Object
java.lang.Record
org.mqtt4j.hato.ReceiveResult.Received
Record Components:
delivery - the delivery handed to this caller
All Implemented Interfaces:
ReceiveResult
Enclosing interface:
ReceiveResult
public static record ReceiveResult.Received(MqttDelivery delivery) extends Record implements ReceiveResult
One delivery handed to this caller. Its acknowledgement follows the subscription's AckMode; receiving it does not imply that application processing has finished.

  • Constructor Details

    • Received

      public Received(MqttDelivery delivery)
      Creates the outcome that hands delivery to the caller.
      Parameters:
      delivery - the delivery handed to the caller
      Throws:
      NullPointerException - 
      if `delivery` 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.

    • delivery

      public MqttDelivery delivery()
      Returns the value of the delivery record component.
      Returns:
      the value of the delivery record component