|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jabber.jabberbeans.XMLData | +--org.jabber.jabberbeans.RosterItem
A RosterItem
is a single user item in Jabber. A roster item
contains the following information:
Serializable
,
Serialized FormConstructor Summary | |
RosterItem(RosterItemBuilder builder)
Creates a new RosterItem instance based on the builder
being passed in |
Method Summary | |
void |
appendItem(java.lang.StringBuffer sb)
appendItem outputs an XML-style representation of the
current roster item, appending it to a Stringbuffer. |
java.util.Enumeration |
enumerateGroups()
enumerateGroups enumerates the group(s) which the user
is entered. |
java.lang.String |
getFriendlyName()
getFriendlyName returns the 'friendly name' associated with
this roster item |
JID |
getJID()
getJID gets the JID contained in this roster element |
java.lang.String |
getSubscriptionType()
getSubscriptionType gets the subscription type of this
roster element |
java.lang.String |
getWaitingStateType()
getWaitingStateType returns a state that you are waiting
for, such as 'subscribe' (waiting for other user to approve your
subscription). |
Methods inherited from class org.jabber.jabberbeans.XMLData |
appendAttrib, appendAttrib, appendChild, appendChild, escapeString, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public RosterItem(RosterItemBuilder builder) throws java.lang.InstantiationException
RosterItem
instance based on the builder
being passed in
builder
- a valid RosterItemBuilder
java.lang.InstantiationException
- if an error occursMethod Detail |
public JID getJID()
getJID
gets the JID contained in this roster element
JID
valuepublic java.lang.String getSubscriptionType()
getSubscriptionType
gets the subscription type of this
roster element
String
holding subscription type, or null if none
specified.public java.lang.String getWaitingStateType()
getWaitingStateType
returns a state that you are waiting
for, such as 'subscribe' (waiting for other user to approve your
subscription). This value is not directly changable by clients.
String
value, with null representing 'none'.public java.lang.String getFriendlyName()
getFriendlyName
returns the 'friendly name' associated with
this roster item
String
value, or null if no friendly name was
specifiedpublic java.util.Enumeration enumerateGroups()
enumerateGroups
enumerates the group(s) which the user
is entered. If no groups are specified or an 'empty' group is
specified, the user is on the top level.
Enumeration
valuepublic void appendItem(java.lang.StringBuffer sb)
appendItem
outputs an XML-style representation of the
current roster item, appending it to a Stringbuffer.
appendItem
in class XMLData
sb
- The StringBuffer
to append to
StringBuffer
with XML
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |