net.java.sip.communicator.impl.protocol.icq
Class ContactGroupIcqImpl

java.lang.Object
  net.java.sip.communicator.impl.protocol.icq.AbstractContactGroupIcqImpl
      net.java.sip.communicator.impl.protocol.icq.ContactGroupIcqImpl

All Implemented Interfaces:

ContactGroup

public class ContactGroupIcqImpl
extends AbstractContactGroupIcqImpl

The ICQ implementation of the ContactGroup interface. Instances of this class (contrary to RootContactGroupIcqImpl) may only contain buddies and cannot have sub groups. Note that instances of this class only use the corresponding joust sim source group for reading their names and only initially fill their buddies java.util.List with the ContactIcqImpl objects corresponding to those contained in the source group at the moment it is being created. They would, however, never try to sync or update their contents ulteriorly. This would have to be done through the addContact()/removeContact() methods.

Author:

Emil Ivov

Constructor Summary

ContactGroupIcqImpl(net.kano.joustsim.oscar.oscar.service.ssi.MutableGroup joustSimGroup, Iterable<? extends net.kano.joustsim.oscar.oscar.service.ssi.Buddy> groupMembers, ServerStoredContactListIcqImpl ssclCallback, boolean isResolved, boolean isPersistent)
Creates an ICQ group using the specified joustSimGroup as a source.

Method Summary

(package private) void	addContact(ContactIcqImpl contact) Adds the specified contact to the end of this group.
boolean	canContainSubgroups() Determines whether the group may contain subgroups or not.
Iterator<Contact>	contacts() Returns an Iterator over all contacts, member of this ContactGroup.
int	countContacts() Returns the number of Contact members of this ContactGroup
int	countSubgroups() Returns the number of subgroups contained by this group, which is always 0 since sub groups in the icq protocol may only be contained by the root group - RootContactGroupIcqImpl.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this group.
(package private) ContactIcqImpl	findContact(net.kano.joustsim.oscar.oscar.service.ssi.Buddy joustSimBuddy) Returns the icq contact encapsulating the specified joustSim buddy or null if no such buddy was found.
(package private) ContactIcqImpl	findContact(String screenName) Returns the icq contact encapsulating with the specified screen name or null if no such contact was found.
(package private) int	findContactIndex(Contact contact) Returns the index of contact in this group -1 if no such contact was found.
Contact	getContact(String id) Returns the Contact with the specified address or identifier.
ContactGroup	getGroup(int index) Returns the subgroup with the specified index (i.e.
ContactGroup	getGroup(String groupName) Returns the subgroup with the specified name.
String	getGroupName() Returns the name of this group.
(package private) net.kano.joustsim.oscar.oscar.service.ssi.MutableGroup	getJoustSimSourceGroup() Returns the JoustSIM group that this class is encapsulating.
(package private) String	getNameCopy() Returns the name of the group as it was at the last call of initNameCopy.
ContactGroup	getParentContactGroup() Returns a reference to the root icq group which in ICQ is the parent of any other group since the protocol does not support subgroups.
String	getPersistentData() Returns null as no persistent data is required and the contact address is sufficient for restoring the contact.
ProtocolProviderService	getProtocolProvider() Returns the protocol provider that this group belongs to.
String	getUID() Returns a String that uniquely represents the group.
int	hashCode() Returns a hash code value for the object, which is actually the hashcode value of the groupname.
(package private) void	initNameCopy() Sets the name copy field that we use as a means of detecting changes in the group name.
boolean	isPersistent() Determines whether or not this contact group is being stored by the server.
boolean	isResolved() Determines whether or not this contact group has been resolved against the server.
(package private) void	removeContact(ContactIcqImpl contact) Removes the specified contact from this contact group
(package private) void	setResolved(boolean resolved) Specifies whether or not this contact group is to be considered resolved against the server.
Iterator<ContactGroup>	subgroups() Returns an empty iterator.
String	toString() Returns a string representation of this group, in the form IcqGroup.GroupName[size]{ buddy1.toString(), buddy2.toString(), ...}.
(package private) void	updateGroup(net.kano.joustsim.oscar.oscar.service.ssi.MutableGroup joustSimGroup, List<? extends net.kano.joustsim.oscar.oscar.service.ssi.Buddy> serverBuddies, List<Contact> newContacts, List<ContactIcqImpl> removedContacts) Sets this group and contacts corresponding to buddies in the serverBuddies list as resolved.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContactGroupIcqImpl

ContactGroupIcqImpl(net.kano.joustsim.oscar.oscar.service.ssi.MutableGroup joustSimGroup,
                    Iterable<? extends net.kano.joustsim.oscar.oscar.service.ssi.Buddy> groupMembers,
                    ServerStoredContactListIcqImpl ssclCallback,
                    boolean isResolved,
                    boolean isPersistent)

Creates an ICQ group using the specified joustSimGroup as a source. The newly created group will always return the name of the underlying joustSimGroup and would thus automatically adapt to changes. It would, however, not receive or try to poll for modifications of the buddies it contains and would therefore have to be updated manually by ServerStoredContactListImpl.

Note that we MUST NOT use the list of buddies obtained through the getBuddiesCopy() of the joustSimGroup arg as we'd later need to be able to directly compare ( == ) instances of buddies we've stored and others that are returned by the framework.

Parameters:

joustSimGroup - the JoustSIM Group corresponding to the group

groupMembers - the group members that we should add to the group.

ssclCallback - a callback to the server stored contact list we're creating.

isResolved - a boolean indicating whether or not the group has been resolved against the server.

Method Detail

countContacts

public int countContacts()

Returns the number of Contact members of this ContactGroup

Returns:

an int indicating the number of Contacts, members of this ContactGroup.

getParentContactGroup

public ContactGroup getParentContactGroup()

Returns a reference to the root icq group which in ICQ is the parent of any other group since the protocol does not support subgroups.

Returns:

a reference to the root icq group.

addContact

void addContact(ContactIcqImpl contact)

Adds the specified contact to the end of this group.

Parameters:

contact - the new contact to add to this group

removeContact

void removeContact(ContactIcqImpl contact)

Removes the specified contact from this contact group

Parameters:

contact - the contact to remove.

contacts

public Iterator<Contact> contacts()

Returns an Iterator over all contacts, member of this ContactGroup.

Returns:

a java.util.Iterator over all contacts inside this ContactGroup. In case the group doesn't contain any members it will return an empty iterator.

getContact

public Contact getContact(String id)

Returns the Contact with the specified address or identifier.

Parameters:

id - the address or identifier of the Contact we are looking for.

Returns:

the Contact with the specified id or address.

getGroupName

public String getGroupName()

Returns the name of this group.

Returns:

a String containing the name of this group.

canContainSubgroups

public boolean canContainSubgroups()

Determines whether the group may contain subgroups or not.

Returns:

always false since only the root group may contain subgroups.

getGroup

public ContactGroup getGroup(int index)

Returns the subgroup with the specified index (i.e. always null since this group may not contain subgroups).

Parameters:

index - the index of the ContactGroup to retrieve.

Returns:

always null

getGroup

public ContactGroup getGroup(String groupName)

Returns the subgroup with the specified name.

Parameters:

groupName - the name of the ContactGroup to retrieve.

Returns:

the ContactGroup with the specified index.

subgroups

public Iterator<ContactGroup> subgroups()

Returns an empty iterator. Subgroups may only be present in the root group.

Returns:

an empty iterator

countSubgroups

public int countSubgroups()

Returns the number of subgroups contained by this group, which is always 0 since sub groups in the icq protocol may only be contained by the root group - RootContactGroupIcqImpl.

Returns:

a 0 int.

hashCode

public int hashCode()

Returns a hash code value for the object, which is actually the hashcode value of the groupname.

Overrides:

hashCode in class Object

Returns:

a hash code value for this ContactGroup.

getJoustSimSourceGroup

net.kano.joustsim.oscar.oscar.service.ssi.MutableGroup getJoustSimSourceGroup()

Returns the JoustSIM group that this class is encapsulating.

Returns:

the JoustSIM group corresponding to this SC group.

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this group. A group is considered equal to another group if it hase the same sets of (equal) contacts.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

getProtocolProvider

public ProtocolProviderService getProtocolProvider()

Returns the protocol provider that this group belongs to.

Returns:

a regerence to the ProtocolProviderService instance that this ContactGroup belongs to.

toString

public String toString()

Returns a string representation of this group, in the form IcqGroup.GroupName[size]{ buddy1.toString(), buddy2.toString(), ...}.

Overrides:

toString in class Object

Returns:

a String representation of the object.

findContact

ContactIcqImpl findContact(net.kano.joustsim.oscar.oscar.service.ssi.Buddy joustSimBuddy)

Returns the icq contact encapsulating the specified joustSim buddy or null if no such buddy was found.

Parameters:

joustSimBuddy - the buddy whose encapsulating contact we're looking for.

Returns:

the ContactIcqImpl corresponding to the specified joustSimBuddy or null if no such contact was found.

findContactIndex

int findContactIndex(Contact contact)

Returns the index of contact in this group -1 if no such contact was found.

Parameters:

contact - the contact whose index we're looking for.

Returns:

the index of contact in this group.

findContact

ContactIcqImpl findContact(String screenName)

Returns the icq contact encapsulating with the specified screen name or null if no such contact was found.

Parameters:

screenName - the screenName (or icq UIN) for the contact we're looking for.

Returns:

the ContactIcqImpl corresponding to the specified screnname or null if no such contact existed.

initNameCopy

void initNameCopy()

Sets the name copy field that we use as a means of detecting changes in the group name.

getNameCopy

String getNameCopy()

Returns the name of the group as it was at the last call of initNameCopy.

Returns:

a String containing a copy of the name of this group as it was last time when we called initNameCopy.

isPersistent

public boolean isPersistent()

Determines whether or not this contact group is being stored by the server. Non persistent contact groups exist for the sole purpose of containing non persistent contacts.

Returns:

true if the contact group is persistent and false otherwise.

getPersistentData

public String getPersistentData()

Returns null as no persistent data is required and the contact address is sufficient for restoring the contact.

Returns:

null as no such data is needed.

isResolved

public boolean isResolved()

Determines whether or not this contact group has been resolved against the server. Unresolved group are used when initially loading a contact list that has been stored in a local file until the presence operation set has managed to retrieve all the contact list from the server and has properly mapped contacts and groups to their corresponding on-line buddies.

Returns:

true if the contact has been resolved (mapped against a buddy) and false otherwise.

setResolved

void setResolved(boolean resolved)

Specifies whether or not this contact group is to be considered resolved against the server. Note that no actions are to be undertaken against group buddies in this method.

Parameters:

resolved - true if this group hase been resolved against the server and false otherwise.

updateGroup

void updateGroup(net.kano.joustsim.oscar.oscar.service.ssi.MutableGroup joustSimGroup,
                 List<? extends net.kano.joustsim.oscar.oscar.service.ssi.Buddy> serverBuddies,
                 List<Contact> newContacts,
                 List<ContactIcqImpl> removedContacts)

Sets this group and contacts corresponding to buddies in the serverBuddies list as resolved.

Parameters:

joustSimGroup - the joustSimGroup sent by the server that we should use to replace the volatile group with.

serverBuddies - a List of joust sim Buddy objects as they were returned by the server

newContacts - a list of ContactIcqImpl objects containing contacts that were present as joust sim buddies in the serverBuddies list but were not present in the group itself.

removedContacts - contacts assumed deleted because they were in the local group but were not in the serverBuddies list.

getUID

public String getUID()

Returns a String that uniquely represents the group. In this we use the name of the group as an identifier. This may cause problems though, in case the name is changed by some other application between consecutive runs of the sip-communicator.

Returns:

a String representing this group in a unique and persistent way.