Package io.outbox

Record Class StringAggregateType

java.lang.Object
java.lang.Record
io.outbox.StringAggregateType
All Implemented Interfaces:
AggregateType

public record StringAggregateType(String name) extends Record implements AggregateType
A simple string-based aggregate type for dynamic scenarios.

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


 AggregateType type = StringAggregateType.of("Order");
 EventEnvelope envelope = EventEnvelope.builder(eventType)
     .aggregateType(type)
     .aggregateId("123")
     .payloadJson("{}")
     .build();
 
  • Constructor Details

    • StringAggregateType

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

    • of

      public static StringAggregateType of(String name)
      Creates an aggregate type from a string.
      Parameters:
      name - the aggregate type name
      Returns:
      the aggregate 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 AggregateType
      Returns:
      the value of the name record component