Package io.outbox

Record Class StringEventType

java.lang.Object
java.lang.Record
io.outbox.StringEventType
All Implemented Interfaces:
EventType
public record StringEventType(String name) extends Record implements EventType
A simple string-based event type for dynamic scenarios.

Use this when event types are determined at runtime or when you prefer string-based configuration over enums. 


 EventType type = StringEventType.of("OrderPlaced");
 EventEnvelope envelope = EventEnvelope.builder(type)
     .payloadJson("{}")
     .build();

  • Constructor Summary

    Constructors
    Constructor
    Description
    StringEventType(String name)
    Creates an instance of a StringEventType 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.
    String
    name()
    Returns the value of the name record component.
    static StringEventType
    of(String name)
    Creates an event type from a string.
    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

    • StringEventType

      public StringEventType(String name)
      Creates an instance of a StringEventType record class.
      Parameters:
      name - the value for the name record component

  • Method Details

    • of

      public static StringEventType of(String name)
      Creates an event type from a string.
      Parameters:
      name - the event type name
      Returns:
      the event type
      Throws:
      NullPointerException - if name is null
      IllegalArgumentException - if name is empty

    • toString

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

    • name

      public String name()
      Returns the value of the name record component.
      Specified by:
      name in interface EventType
      Returns:
      the value of the name record component