Package org.atmosphere.room.protocol

Record Class RoomProtocolMessage.Join

java.lang.Object

java.lang.Record

org.atmosphere.room.protocol.RoomProtocolMessage.Join

Record Components:

room - the room to join

memberId - application-level member identifier

metadata - optional key-value pairs

All Implemented Interfaces:

RoomProtocolMessage

Enclosing interface:

RoomProtocolMessage

public static record RoomProtocolMessage.Join(String room, String memberId, Map<String,Object> metadata)
extends Record
implements RoomProtocolMessage

Join a room with optional member metadata.

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.room.protocol.RoomProtocolMessage

RoomProtocolMessage.Broadcast, RoomProtocolMessage.Direct, RoomProtocolMessage.Join, RoomProtocolMessage.Leave, RoomProtocolMessage.Typing

Constructor Summary

Constructors

Constructor	Description
Join(String room, String memberId, Map<String,Object> metadata)	Creates an instance of a Join 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	memberId()	Returns the value of the memberId record component.
Map<String,Object>	metadata()	Returns the value of the metadata record component.
String	room()	Returns the value of the room record component.
final 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

Join

public Join(String room,
 String memberId,
 Map<String,Object> metadata)

Creates an instance of a Join record class.

Parameters:

room - the value for the room record component

memberId - the value for the memberId record component

metadata - the value for the metadata 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

memberId

public String memberId()

Returns the value of the memberId record component.

Returns:

the value of the memberId record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component