Record Class PublishOptions

java.lang.Object
java.lang.Record
com.iantapply.relay.api.PublishOptions
Record Components:
correlationId - related message identifier, or null
headers - immutable application metadata
public record PublishOptions(MessageId correlationId, Map<String,String> headers) extends Record
Optional metadata attached to a published message.

  • Constructor Details

    • PublishOptions

      public PublishOptions(MessageId correlationId, Map<String,String> headers)
      Creates options and defensively copies application headers.

  • Method Details

    • defaults

      public static PublishOptions defaults()
      Returns options with no correlation identifier or application headers.
      Returns:
      empty publish 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.

    • correlationId

      public MessageId correlationId()
      Returns the value of the correlationId record component.
      Returns:
      the value of the correlationId record component

    • headers

      public Map<String,String> headers()
      Returns the value of the headers record component.
      Returns:
      the value of the headers record component