Package com.opencqrs.framework.serialization

Record Class EventData<E>

java.lang.Object
java.lang.Record
com.opencqrs.framework.serialization.EventData<E>
Type Parameters:
E - the generic object type
Record Components:
metaData - the meta-data stored within EventCandidate.data() or Event.data()
payload - the Java object payload stored within EventCandidate.data() or Event.data()
public record EventData<E>(@NotNull Map<String,?> metaData, E payload) extends Record
Represents unmarshalled EventCandidate.data() or Event.data(), respectively. The framework, in contrast to the EsdbClient, distinguishes between an event's payload and additional meta-data. While the former is used for storing actual Java objects, the latter one can store additional key-value pairs, if needed.

Implementations of this interface may choose to ignore the meta-data when marshalling, if there is no need for meta-data support within the application. However, be aware of event immutability which may render events non-marshallable, in case the EventDataMarshaller implementation needs to be changed, after events have already been stored.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    EventData(@NotNull Map<String,?> metaData, E payload)
    Creates an instance of a EventData record class.

  • 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.
    @NotNull Map<String,?>
    metaData()
    Returns the value of the metaData record component.
    E
    payload()
    Returns the value of the payload record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EventData

      public EventData(@NotNull @NotNull Map<String,?> metaData, @NotNull E payload)
      Creates an instance of a EventData record class.
      Parameters:
      metaData - the value for the metaData record component
      payload - the value for the payload 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.

    • metaData

      @NotNull public @NotNull Map<String,?> metaData()
      Returns the value of the metaData record component.
      Returns:
      the value of the metaData record component

    • payload

      @NotNull public E payload()
      Returns the value of the payload record component.
      Returns:
      the value of the payload record component