Record Class Topic<T>

java.lang.Object
java.lang.Record
com.iantapply.relay.api.Topic<T>
Type Parameters:
T - payload type
Record Components:
name - stable topic name shared by publishers and subscribers
codec - payload codec
public record Topic<T>(String name, MessageCodec<T> codec) extends Record
A named messaging route paired with the codec for its payload type.

  • Constructor Details

    • Topic

      public Topic(String name, MessageCodec<T> codec)
      Validates a topic name and codec.
      Parameters:
      name - topic name
      codec - payload codec

  • Method Details

    • of

      public static <T> Topic<T> of(String name, MessageCodec<T> codec)
      Creates and validates a topic.
      Type Parameters:
      T - payload type
      Parameters:
      name - topic name
      codec - payload codec
      Returns:
      validated topic

    • isValidName

      public static boolean isValidName(String name)
      Tests whether a name can be used as a Relay topic.
      Parameters:
      name - candidate name
      Returns:
      true if the name is valid

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

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • codec

      public MessageCodec<T> codec()
      Returns the value of the codec record component.
      Returns:
      the value of the codec record component