net.java.sip.communicator.service.protocol.event
Class LocalUserAdHocChatRoomPresenceChangeEvent

java.lang.Object
  java.util.EventObject
      net.java.sip.communicator.service.protocol.event.LocalUserAdHocChatRoomPresenceChangeEvent

All Implemented Interfaces:

Serializable

public class LocalUserAdHocChatRoomPresenceChangeEvent
extends EventObject

Dispatched to notify interested parties that a change in our presence in the source ad-hoc chat room has occurred. Changes may include us being join, left, etc.

Author:

Valentin Martinet

See Also:

Serialized Form

Field Summary

static String	LOCAL_USER_DROPPED Indicates that this event was triggered as a result of the local participant being disconnected from the server brutally, or ping timeout.
static String	LOCAL_USER_JOIN_FAILED Indicates that this event was triggered as a result of the local participant failed to join an ad-hoc chat room.
static String	LOCAL_USER_JOINED Indicates that this event was triggered as a result of the local participant joining an ad-hoc chat room.
static String	LOCAL_USER_LEFT Indicates that this event was triggered as a result of the local participant leaving an ad-hoc chat room.

Fields inherited from class java.util.EventObject

source

Constructor Summary

LocalUserAdHocChatRoomPresenceChangeEvent(OperationSetAdHocMultiUserChat source, AdHocChatRoom adHocChatRoom, String eventType, String reason)
Creates an AdHocChatRoomLocalUserPresenceChangeEvent representing that a change in local participant presence in the source ad-hoc chat room has occurred.

Method Summary

AdHocChatRoom	getAdHocChatRoom() Returns the AdHocChatRoom, that this event is about.
OperationSetAdHocMultiUserChat	getAdHocMultiUserChatOpSet() Returns the OperationSetAdHocMultiUserChat, where this event has occurred.
String	getEventType() Returns the type of this event which could be one of the LOCAL_USER_XXX member fields.
String	getReason() A reason string indicating a human readable reason for this event.
String	toString() Returns a String representation of this event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LOCAL_USER_JOINED

public static final String LOCAL_USER_JOINED

Indicates that this event was triggered as a result of the local participant joining an ad-hoc chat room.

See Also:

Constant Field Values

LOCAL_USER_JOIN_FAILED

public static final String LOCAL_USER_JOIN_FAILED

Indicates that this event was triggered as a result of the local participant failed to join an ad-hoc chat room.

See Also:

Constant Field Values

LOCAL_USER_LEFT

public static final String LOCAL_USER_LEFT

Indicates that this event was triggered as a result of the local participant leaving an ad-hoc chat room.

See Also:

Constant Field Values

LOCAL_USER_DROPPED

public static final String LOCAL_USER_DROPPED

Indicates that this event was triggered as a result of the local participant being disconnected from the server brutally, or ping timeout.

See Also:

Constant Field Values

Constructor Detail

LocalUserAdHocChatRoomPresenceChangeEvent

public LocalUserAdHocChatRoomPresenceChangeEvent(OperationSetAdHocMultiUserChat source,
                                                 AdHocChatRoom adHocChatRoom,
                                                 String eventType,
                                                 String reason)

Creates an AdHocChatRoomLocalUserPresenceChangeEvent representing that a change in local participant presence in the source ad-hoc chat room has occurred.

Parameters:

source - the OperationSetAdHocMultiUserChat, which produced this event

adHocChatRoom - the AdHocChatRoom that this event is about

eventType - the type of this event.

reason - the reason explaining why this event might have occurred

Method Detail

getAdHocMultiUserChatOpSet

public OperationSetAdHocMultiUserChat getAdHocMultiUserChatOpSet()

Returns the OperationSetAdHocMultiUserChat, where this event has occurred.

Returns:

the OperationSetAdHocMultiUserChat, where this event has occurred

getAdHocChatRoom

public AdHocChatRoom getAdHocChatRoom()

Returns the AdHocChatRoom, that this event is about.

Returns:

the AdHocChatRoom, that this event is about

getReason

public String getReason()

A reason string indicating a human readable reason for this event.

Returns:

a human readable String containing the reason for this event, or null if no particular reason was specified

getEventType

public String getEventType()

Returns the type of this event which could be one of the LOCAL_USER_XXX member fields.

Returns:

one of the LOCAL_USER_XXX fields indicating the type of this event.

toString

public String toString()

Returns a String representation of this event.

Overrides:

toString in class EventObject

Returns:

a String for representing this event.