|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.echomine.jabber.msg.RosterItem
public class RosterItem
Represents one entity as saved in the roster list. It contains the jid, the groups the entity is in, and other subscription related information.
Field Summary | |
---|---|
static java.lang.String |
SUBSCRIBE_BOTH
|
static java.lang.String |
SUBSCRIBE_FROM
|
static java.lang.String |
SUBSCRIBE_NONE
|
static java.lang.String |
SUBSCRIBE_REMOVE
|
static java.lang.String |
SUBSCRIBE_TO
|
Constructor Summary | |
---|---|
protected |
RosterItem()
default constructor usually for creating elements from existing data (ie. |
|
RosterItem(JID jid,
java.lang.String name)
default constructor for creating a roster item for use. |
Method Summary | |
---|---|
void |
addGroup(java.lang.String name)
adds a group to the roster item |
static RosterItem |
createRosterItem(Element rosterElem)
used to create a roster item into an object by parsing the elements passed in as the parameter. |
java.lang.String |
getAsk()
|
Element |
getDOM()
encodes the roster item into a XML element for outgoing roster message. |
java.lang.String[] |
getGroups()
retrieves the list of groups that the roster item is in. |
JID |
getJID()
|
java.lang.String |
getName()
|
java.lang.String |
getSubscription()
|
boolean |
isInGroup(java.lang.String name)
is the item/user in the specified group? |
void |
removeGroup(java.lang.String name)
removes a groups from the roster item |
void |
setAsk(java.lang.String ask)
|
void |
setJID(JID jid)
sets the JID to be stored in this roster item |
void |
setName(java.lang.String name)
|
void |
setRemove(boolean remove)
indicates that this item should be removed or not |
void |
setSubscription(java.lang.String subscription)
sets the subscription status of the roster item |
java.lang.String |
toString()
returns a debugging output stream |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SUBSCRIBE_BOTH
public static final java.lang.String SUBSCRIBE_FROM
public static final java.lang.String SUBSCRIBE_NONE
public static final java.lang.String SUBSCRIBE_REMOVE
public static final java.lang.String SUBSCRIBE_TO
Constructor Detail |
---|
protected RosterItem()
public RosterItem(JID jid, java.lang.String name)
jid
- the JID of the roster itemname
- optional nickname for the roster JID (null if none)Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
public JID getJID()
public void setJID(JID jid)
public java.lang.String getSubscription()
public void setSubscription(java.lang.String subscription)
public java.lang.String getAsk()
public void setAsk(java.lang.String ask)
public void addGroup(java.lang.String name)
public void removeGroup(java.lang.String name)
public java.lang.String[] getGroups()
public boolean isInGroup(java.lang.String name)
public void setRemove(boolean remove)
remove
- true if item should be deleted from server, false otherwisepublic Element getDOM()
public static RosterItem createRosterItem(Element rosterElem) throws ParseException
ParseException
- if the JID of the roster item cannot be parsed properlypublic java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |