|
Smack | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.smack.RosterGroup
public class RosterGroup
A group of roster entries.
Roster.getGroup(String)
Method Summary | |
---|---|
void |
addEntry(RosterEntry entry)
Adds a roster entry to this group. |
boolean |
contains(RosterEntry entry)
Returns true if the specified entry is part of this group. |
boolean |
contains(java.lang.String user)
Returns true if the specified XMPP address is an entry in this group. |
java.util.Collection<RosterEntry> |
getEntries()
Returns an unmodifiable collection of all entries in the group. |
RosterEntry |
getEntry(java.lang.String user)
Returns the roster entry associated with the given XMPP address 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(RosterEntry 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 |
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name of the group.public int getEntryCount()
public java.util.Collection<RosterEntry> getEntries()
public RosterEntry getEntry(java.lang.String user)
user
- the XMPP address of the user (eg "jsmith@example.com").
public boolean contains(RosterEntry entry)
entry
- a roster entry.
public boolean contains(java.lang.String user)
user
- the XMPP address of the user.
public void addEntry(RosterEntry entry) throws XMPPException
entry
- a roster entry.
XMPPException
- if an error occured while trying to add the entry to the group.public void removeEntry(RosterEntry entry) throws XMPPException
entry
- a roster entry.
XMPPException
- if an error occured while trying to remove the entry from the group.
|
Smack | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |