Smack

org.jivesoftware.smack.packet
Class RosterPacket.Item

java.lang.Object
  extended by org.jivesoftware.smack.packet.RosterPacket.Item
Enclosing class:
RosterPacket

public static class RosterPacket.Item
extends Object

A roster item, which consists of a JID, their name, the type of subscription, and the groups the roster item belongs to.


Constructor Summary
RosterPacket.Item(String user, String name)
          Creates a new roster item.
 
Method Summary
 void addGroupName(String groupName)
          Adds a group name.
 Set<String> getGroupNames()
          Returns an unmodifiable set of the group names that the roster item belongs to.
 RosterPacket.ItemStatus getItemStatus()
          Returns the roster item status.
 RosterPacket.ItemType getItemType()
          Returns the roster item type.
 String getName()
          Returns the user's name.
 String getUser()
          Returns the user.
 void removeGroupName(String groupName)
          Removes a group name.
 void setItemStatus(RosterPacket.ItemStatus itemStatus)
          Sets the roster item status.
 void setItemType(RosterPacket.ItemType itemType)
          Sets the roster item type.
 void setName(String name)
          Sets the user's name.
 String toXML()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RosterPacket.Item

public RosterPacket.Item(String user,
                         String name)
Creates a new roster item.

Parameters:
user - the user.
name - the user's name.
Method Detail

getUser

public String getUser()
Returns the user.

Returns:
the user.

getName

public String getName()
Returns the user's name.

Returns:
the user's name.

setName

public void setName(String name)
Sets the user's name.

Parameters:
name - the user's name.

getItemType

public RosterPacket.ItemType getItemType()
Returns the roster item type.

Returns:
the roster item type.

setItemType

public void setItemType(RosterPacket.ItemType itemType)
Sets the roster item type.

Parameters:
itemType - the roster item type.

getItemStatus

public RosterPacket.ItemStatus getItemStatus()
Returns the roster item status.

Returns:
the roster item status.

setItemStatus

public void setItemStatus(RosterPacket.ItemStatus itemStatus)
Sets the roster item status.

Parameters:
itemStatus - the roster item status.

getGroupNames

public Set<String> getGroupNames()
Returns an unmodifiable set of the group names that the roster item belongs to.

Returns:
an unmodifiable set of the group names.

addGroupName

public void addGroupName(String groupName)
Adds a group name.

Parameters:
groupName - the group name.

removeGroupName

public void removeGroupName(String groupName)
Removes a group name.

Parameters:
groupName - the group name.

toXML

public String toXML()

Smack

Copyright © 2003-2007 Jive Software.