Package org.atmosphere.room

Record Class RoomMember

java.lang.Object
java.lang.Record
org.atmosphere.room.RoomMember
Record Components:
id - application-level member identifier (e.g. username)
metadata - arbitrary key-value pairs (e.g. avatar URL, display name)
public record RoomMember(String id, Map<String,Object> metadata) extends Record
Application-level identity for a room member. Unlike AtmosphereResource.uuid(), which is connection-scoped, a RoomMember.id is stable across reconnects.
Since:
4.0

  • Constructor Details

    • RoomMember

      public RoomMember(String id, Map<String,Object> metadata)
      Creates an instance of a RoomMember record class.
      Parameters:
      id - the value for the id record component
      metadata - the value for the metadata record component

    • RoomMember

      public RoomMember(String id)
      Convenience constructor with no metadata.
      Parameters:
      id - application-level member identifier

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

    • id

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

    • metadata

      public Map<String,Object> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component