Package org.atmosphere.room.protocol

Record Class RoomProtocolMessage.Broadcast

java.lang.Object
java.lang.Record
org.atmosphere.room.protocol.RoomProtocolMessage.Broadcast
Record Components:
room - the target room
data - the message payload
All Implemented Interfaces:
RoomProtocolMessage
Enclosing interface:
RoomProtocolMessage
public static record RoomProtocolMessage.Broadcast(String room, Object data) extends Record implements RoomProtocolMessage
Broadcast a message to all room members.

  • Constructor Details

    • Broadcast

      public Broadcast(String room, Object data)
      Creates an instance of a Broadcast record class.
      Parameters:
      room - the value for the room record component
      data - the value for the data 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.

    • room

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

    • data

      public Object data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component