Smack

org.jivesoftware.smack
Class RosterGroup

java.lang.Object
  extended byorg.jivesoftware.smack.RosterGroup

public class RosterGroup
extends Object

A group of roster entries.

Author:
Matt Tucker
See Also:
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(String user)
          Returns true if the specified XMPP address is an entry in this group.
 Iterator getEntries()
          Returns an iterator for the entries in the group.
 int getEntryCount()
          Returns the number of entries in the group.
 String getName()
          Returns the name of the group.
 void removeEntry(RosterEntry entry)
          Removes a roster entry from this group.
 void setName(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

getName

public String getName()
Returns the name of the group.

Returns:
the name of the group.

setName

public void setName(String name)
Sets the name of the group.

Parameters:
name - the name of the group.

getEntryCount

public int getEntryCount()
Returns the number of entries in the group.

Returns:
the number of entries in the group.

getEntries

public Iterator getEntries()
Returns an iterator for the entries in the group.

Returns:
an iterator for the entries in the group.

contains

public boolean contains(RosterEntry entry)
Returns true if the specified entry is part of this group.

Parameters:
entry - a roster entry.
Returns:
true if the entry is part of this group.

contains

public boolean contains(String user)
Returns true if the specified XMPP address is an entry in this group.

Parameters:
user - the XMPP address of the user.
Returns:
true if the XMPP address is an entry in this group.

addEntry

public void addEntry(RosterEntry entry)
Adds a roster entry to this group.

Parameters:
entry - a roster entry.

removeEntry

public void removeEntry(RosterEntry entry)
Removes a roster entry from this group.

Parameters:
entry - a roster entry.

Smack

Copyright © 2003 Jive Software.