com.echomine.jabber.msg
Class RosterXMessage

java.lang.Object
  extended by com.echomine.jabber.JabberMessage
      extended by com.echomine.jabber.JabberJDOMMessage
          extended by com.echomine.jabber.msg.RosterXMessage
All Implemented Interfaces:
JabberMessageParsable

public class RosterXMessage
extends JabberJDOMMessage

The roster message actually doesn't contain any attributes to the tag that it uses. However, it contains a list of roster items.

Current Implementation: JEP-0093 1.0


Field Summary
 
Fields inherited from class com.echomine.jabber.JabberMessage
messageID
 
Constructor Summary
RosterXMessage()
          constructs a default Roster X Message.
 
Method Summary
 void addRosterItem(RosterItem item)
          adds a roster item to the current roster message.
 void addRosterItems(java.util.List items)
          adds a list of roster items
 int getMessageType()
          the default message type is unknown.
 java.util.List getRosterItems()
          retrieves a list of roster items.
 
Methods inherited from class com.echomine.jabber.JabberJDOMMessage
encode, getDOM, getXMLOutputter, parse, setMessageID, toString
 
Methods inherited from class com.echomine.jabber.JabberMessage
getMessageID, getReplyMessage, getTimeout, getXMessage, getXMessages, interrupt, isReplyRequired, isSendXMessages, isSynchronized, replyReceived, setReplyRequired, setSendXMessages, setSynchronized, setTimeout, setXMessage, setXMessages
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RosterXMessage

public RosterXMessage()
constructs a default Roster X Message.

Method Detail

addRosterItem

public void addRosterItem(RosterItem item)
adds a roster item to the current roster message. This will add the item straight into the DOM.


addRosterItems

public void addRosterItems(java.util.List items)
adds a list of roster items


getRosterItems

public java.util.List getRosterItems()
retrieves a list of roster items. The first time it's called, it will parse the data out and cache it. Subsequent calls will use the cached result.


getMessageType

public int getMessageType()
Description copied from class: JabberJDOMMessage
the default message type is unknown. It doesn't mean that there is no type. It just means that there is no known message parser for this particular object.

Overrides:
getMessageType in class JabberJDOMMessage
Returns:
a message code that is unique to the message
See Also:
JabberCode


Copyright © 2001-2005 Echomine. All Rights Reserved.