Package org.atmosphere.room

Record Class PresenceEvent

java.lang.Object

java.lang.Record

org.atmosphere.room.PresenceEvent

Record Components:

type - the event type (JOIN or LEAVE)

room - the room where the event occurred

member - the resource that joined or left (null for virtual members)

memberInfo - the application-level member identity, or null if not provided

public record PresenceEvent(PresenceEvent.Type type, Room room, AtmosphereResource member, RoomMember memberInfo)
extends Record

Event fired when a member joins or leaves a Room.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PresenceEvent.Type

Constructor Summary

Constructors

Constructor	Description
PresenceEvent(PresenceEvent.Type type, Room room, AtmosphereResource member)	Convenience constructor without member info.
PresenceEvent(PresenceEvent.Type type, Room room, AtmosphereResource member, RoomMember memberInfo)	Creates an instance of a PresenceEvent record class.
PresenceEvent(PresenceEvent.Type type, Room room, RoomMember memberInfo)	Constructor for virtual member events (no AtmosphereResource).

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.
boolean	isVirtual()
AtmosphereResource	member()	Returns the value of the member record component.
RoomMember	memberInfo()	Returns the value of the memberInfo record component.
Room	room()	Returns the value of the room record component.
final String	toString()	Returns a string representation of this record class.
PresenceEvent.Type	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PresenceEvent

public PresenceEvent(PresenceEvent.Type type,
 Room room,
 AtmosphereResource member)

Convenience constructor without member info.

PresenceEvent

public PresenceEvent(PresenceEvent.Type type,
 Room room,
 RoomMember memberInfo)

Constructor for virtual member events (no AtmosphereResource).

PresenceEvent

public PresenceEvent(PresenceEvent.Type type,
 Room room,
 AtmosphereResource member,
 RoomMember memberInfo)

Creates an instance of a PresenceEvent record class.

Parameters:

type - the value for the type record component

room - the value for the room record component

member - the value for the member record component

memberInfo - the value for the memberInfo record component

Method Details

isVirtual

public boolean isVirtual()

Returns:

true if this event is for a virtual (non-connection) member

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.

type

public PresenceEvent.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

room

public Room room()

Returns the value of the room record component.

Returns:

the value of the room record component

member

public AtmosphereResource member()

Returns the value of the member record component.

Returns:

the value of the member record component

memberInfo

public RoomMember memberInfo()

Returns the value of the memberInfo record component.

Returns:

the value of the memberInfo record component