Record Class ReadResponse

java.lang.Object
java.lang.Record
io.umadb.client.ReadResponse
Record Components:
events - the list of sequenced events returned by the read
head - the position of the latest event in the store when the response was generated; may be null if unknown
public record ReadResponse(List<SequencedEvent> events, Long head) extends Record
Represents the response returned from a read operation.

Contains a list of sequenced events and optionally the head position of the event stream at the time the response was generated.

If head is provided, it can be used as a reference point for subsequent reads or for subscribing to new events.

  • Constructor Details

    • ReadResponse

      public ReadResponse(List<SequencedEvent> events, Long head)
      Creates an instance of a ReadResponse record class.
      Parameters:
      events - the value for the events record component
      head - the value for the head 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. 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.

    • events

      public List<SequencedEvent> events()
      Returns the value of the events record component.
      Returns:
      the value of the events record component

    • head

      public Long head()
      Returns the value of the head record component.
      Returns:
      the value of the head record component