Record Class SequencedEvent

java.lang.Object
java.lang.Record
io.umadb.client.SequencedEvent
Record Components:
position - the sequence number of the event in the event stream
event - the event payload
trackingInfo - the tracking info recorded when the event was appended; may be null if none was supplied
public record SequencedEvent(long position, Event event, TrackingInfo trackingInfo) extends Record
Represents a single event along with its position in the event stream.

The position indicates the sequence number of the event in the store, which can be used for ordering, optimistic concurrency, or resuming reads.

  • Constructor Details

    • SequencedEvent

      public SequencedEvent(long position, Event event)
      Creates a SequencedEvent without tracking info.
      Parameters:
      position - the sequence number of the event
      event - the event payload

    • SequencedEvent

      public SequencedEvent(long position, Event event, TrackingInfo trackingInfo)
      Creates an instance of a SequencedEvent record class.
      Parameters:
      position - the value for the position record component
      event - the value for the event record component
      trackingInfo - the value for the trackingInfo record component

  • 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.

    • position

      public long position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • event

      public Event event()
      Returns the value of the event record component.
      Returns:
      the value of the event record component

    • trackingInfo

      public TrackingInfo trackingInfo()
      Returns the value of the trackingInfo record component.
      Returns:
      the value of the trackingInfo record component