com.quickblox.chat.model

Class QBRosterGroup

java.lang.Object

com.quickblox.chat.model.QBRosterGroup

public class QBRosterGroup
extends java.lang.Object

A group of roster entries.

See Also:

QBRoster.getGroup(String)

Constructor Summary

Constructors

Constructor and Description
QBRosterGroup(RosterGroup rosterGroup)

Method Summary

Modifier and Type	Method and Description
void	addEntry(QBRosterEntry entry) Adds a roster entry to this group.
boolean	contains(int userId) Returns true if the specified user ID is an entry in this group.
boolean	contains(QBRosterEntry entry) Returns true if the specified entry is part of this group.
java.util.Collection<QBRosterEntry>	getEntries() Returns an unmodifiable collection of all entries in the group.
QBRosterEntry	getEntry(int userId) Returns the roster entry associated with the given user ID or null if the user is not an entry in the group.
int	getEntryCount() Returns the number of entries in the group.
java.lang.String	getName() Returns the name of the group.
void	removeEntry(QBRosterEntry entry) Removes a roster entry from this group.
void	setName(java.lang.String name) Sets the name of the group.

Methods inherited from class java.lang.Object

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

Constructor Detail

QBRosterGroup

public QBRosterGroup(RosterGroup rosterGroup)

Method Detail

getName

public java.lang.String getName()

Returns the name of the group.

setName

public void setName(java.lang.String name)
             throws SmackException.NotConnectedException,
                    XMPPException.XMPPErrorException,
                    SmackException.NoResponseException

Sets the name of the group.

Parameters:

name - The name to set.

Throws:

SmackException.NotConnectedException

XMPPException.XMPPErrorException

SmackException.NoResponseException

getEntryCount

public int getEntryCount()

Returns the number of entries in the group.

getEntries

public java.util.Collection<QBRosterEntry> getEntries()

Returns an unmodifiable collection of all entries in the group.

getEntry

public QBRosterEntry getEntry(int userId)

Returns the roster entry associated with the given user ID or null if the user is not an entry in the group.

Parameters:

userId - The ID of a user.

contains

public boolean contains(QBRosterEntry entry)

Returns true if the specified entry is part of this group.

Parameters:

entry - a roster entry.

contains

public boolean contains(int userId)

Returns true if the specified user ID is an entry in this group.

Parameters:

userId - The ID of a user.

addEntry

public void addEntry(QBRosterEntry entry)
              throws XMPPException,
                     SmackException.NotConnectedException,
                     SmackException.NoResponseException

Adds a roster entry to this group.

Parameters:

entry - a roster entry.

Throws:

XMPPException - if an error occured while trying to add the entry to the group.

SmackException.NotConnectedException

SmackException.NoResponseException - if there was no response from the server.

removeEntry

public void removeEntry(QBRosterEntry entry)
                 throws XMPPException,
                        SmackException.NotConnectedException,
                        SmackException.NoResponseException

Removes a roster entry from this group.

Parameters:

entry - a roster entry.

Throws:

XMPPException - if an error occurred while trying to remove the entry from the group.

SmackException.NotConnectedException

SmackException.NoResponseException - if there was no response from the server.