rocks.xmpp.im.roster.model

Class ContactGroup

java.lang.Object

rocks.xmpp.im.roster.model.ContactGroup

All Implemented Interfaces:

java.lang.Comparable<ContactGroup>

public final class ContactGroup
extends java.lang.Object
implements java.lang.Comparable<ContactGroup>

Represents a contact group in the user’s roster. A group consists of contacts and may contain nested sub-groups.

This class is conditionally thread-safe.

Constructor Summary

Constructors

Constructor and Description
ContactGroup(java.lang.String name, java.lang.String fullName, ContactGroup parentGroup)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ContactGroup o)
boolean	equals(java.lang.Object o)
java.util.Collection<Contact>	getContacts() Gets the contacts in this group.
java.lang.String	getFullName() Gets the full name of the group.
java.util.Collection<ContactGroup>	getGroups() Gets the nested sub-groups of this group.
java.lang.String	getName() Gets the name of the group.
ContactGroup	getParentGroup() Gets the parent group.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContactGroup

public ContactGroup(java.lang.String name,
                    java.lang.String fullName,
                    ContactGroup parentGroup)

Method Detail

getName

public final java.lang.String getName()

Gets the name of the group.

Returns:

The name.

getFullName

public final java.lang.String getFullName()

Gets the full name of the group.

Returns:

The full name.

getGroups

public final java.util.Collection<ContactGroup> getGroups()

Gets the nested sub-groups of this group. The returned collection is mutable and not thread-safe.

Returns:

The nested groups.

getContacts

public final java.util.Collection<Contact> getContacts()

Gets the contacts in this group. The returned collection is mutable and not thread-safe.

Returns:

The contacts.

getParentGroup

public final ContactGroup getParentGroup()

Gets the parent group.

Returns:

The parent group or null, if it has no parent.

compareTo

public final int compareTo(ContactGroup o)

Specified by:

compareTo in interface java.lang.Comparable<ContactGroup>

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object