net.java.sip.communicator.impl.msghistory
Class MessageHistoryServiceImpl.ChatRoomMemberImpl

java.lang.Object
  net.java.sip.communicator.impl.msghistory.MessageHistoryServiceImpl.ChatRoomMemberImpl

All Implemented Interfaces:

ChatRoomMember

Enclosing class:

MessageHistoryServiceImpl

static class MessageHistoryServiceImpl.ChatRoomMemberImpl
extends Object
implements ChatRoomMember

Simple ChatRoomMember implementation.

Constructor Summary

MessageHistoryServiceImpl.ChatRoomMemberImpl(String name, ChatRoom chatRoom, ChatRoomMemberRole role)

Method Summary

byte[]	getAvatar() Returns the avatar of this member, that can be used when including it in user interface.
ChatRoom	getChatRoom() Returns the chat room that this member is participating in.
Contact	getContact() Returns the protocol contact corresponding to this member in our contact list.
String	getContactAddress() Returns the contact identifier representing this contact.
String	getName() Returns the name of this member as it is known in its containing chatroom (aka a nickname).
ProtocolProviderService	getProtocolProvider() Returns the protocol provider instance that this member has originated in.
ChatRoomMemberRole	getRole() Returns the role of this chat room member in its containing room.
void	setRole(ChatRoomMemberRole newRole) Sets the role of this chat room member in its containing room.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageHistoryServiceImpl.ChatRoomMemberImpl

public MessageHistoryServiceImpl.ChatRoomMemberImpl(String name,
                                                    ChatRoom chatRoom,
                                                    ChatRoomMemberRole role)

Method Detail

getChatRoom

public ChatRoom getChatRoom()

Description copied from interface: ChatRoomMember

Returns the chat room that this member is participating in.

Specified by:

getChatRoom in interface ChatRoomMember

Returns:

the ChatRoom instance that this member belongs to.

getProtocolProvider

public ProtocolProviderService getProtocolProvider()

Description copied from interface: ChatRoomMember

Returns the protocol provider instance that this member has originated in.

Specified by:

getProtocolProvider in interface ChatRoomMember

Returns:

the ProtocolProviderService instance that created this member and its containing cht room

getContactAddress

public String getContactAddress()

Description copied from interface: ChatRoomMember

Returns the contact identifier representing this contact. In protocols like IRC this method would return the same as getName() but in others like Jabber, this method would return a full contact id uri.

Specified by:

getContactAddress in interface ChatRoomMember

Returns:

a String (contact address), uniquely representing the contact over the service the service being used by the associated protocol provider instance/

getName

public String getName()

Description copied from interface: ChatRoomMember

Returns the name of this member as it is known in its containing chatroom (aka a nickname). The name returned by this method, may sometimes match the string returned by getContactID() which is actually the address of a contact in the realm of the corresponding protocol.

Specified by:

getName in interface ChatRoomMember

Returns:

the name of this member as it is known in the containing chat room (aka a nickname).

getRole

public ChatRoomMemberRole getRole()

Description copied from interface: ChatRoomMember

Returns the role of this chat room member in its containing room.

Specified by:

getRole in interface ChatRoomMember

Returns:

a ChatRoomMemberRole instance indicating the role the this member in its containing chat room.

getAvatar

public byte[] getAvatar()

Description copied from interface: ChatRoomMember

Returns the avatar of this member, that can be used when including it in user interface.

Specified by:

getAvatar in interface ChatRoomMember

Returns:

an avatar (e.g. user photo) of this member.

setRole

public void setRole(ChatRoomMemberRole newRole)

Description copied from interface: ChatRoomMember

Sets the role of this chat room member in its containing room.

Specified by:

setRole in interface ChatRoomMember

Parameters:

newRole - ChatRoomMemberRole instance indicating the role to set for this member in its containing chat room.

getContact

public Contact getContact()

Description copied from interface: ChatRoomMember

Returns the protocol contact corresponding to this member in our contact list. The contact returned here could be used by the user interface to check if this member is contained in our contact list and in function of this to show additional information add additional functionality.

Specified by:

getContact in interface ChatRoomMember

Returns:

the protocol contact corresponding to this member in our contact list.