pawn.messages
Class PresenceQuery

java.lang.Object
  |
  +--pawn.messages.PresenceQueryMessage
        |
        +--pawn.messages.PresenceQuery

public class PresenceQuery

extends PresenceQueryMessage

An implementation of the PresenceQueryMessage abstract class. This class is responsible for parsing and formatting the XML document used to define a query for presence information.

Constructor Summary

PresenceQuery(java.io.InputStream stream)
Creates a new Presence Query Message by parsing the given stream.

Method Summary

net.jxta.document.Document	getDocument(net.jxta.document.MimeMediaType asMimeType) Returns a Document object containing the query's document tree.
void	readDocument(net.jxta.document.TextElement document) Parses the given document tree for the presence query.
java.lang.String	toString() Returns an XML String representation of the query.

Methods inherited from class pawn.messages.PresenceQueryMessage

getEmailAddress, setEmailAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PresenceQuery

public PresenceQuery(java.io.InputStream stream)
              throws java.io.IOException,
                     java.lang.IllegalArgumentException

Creates a new Presence Query Message by parsing the given stream.

Parameters:

stream - the InputStream source of the query data.

Throws:

java.io.IOException - if the query can't be parsed from the stream.

java.lang.IllegalArgumentException - thrown if the data does not contain a Presence Query Message.

Method Detail

getDocument

public net.jxta.document.Document getDocument(net.jxta.document.MimeMediaType asMimeType)
                                       throws java.lang.IllegalArgumentException

Returns a Document object containing the query's document tree.

Specified by:

getDocument in class PresenceQueryMessage

Parameters:

asMimeType - the desired MIME type for the query rendering.

Returns:

the Document containing the query's document object tree.

Throws:

java.lang.IllegalArgumentException - thrown if the email address is null.

readDocument

public void readDocument(net.jxta.document.TextElement document)
                  throws java.lang.IllegalArgumentException

Parses the given document tree for the presence query.

Parameters:

document - the object containing the presence query data.

Throws:

java.lang.IllegalArgumentException - if the document is not a presence query, as expected.

toString

public java.lang.String toString()

Returns an XML String representation of the query.

Overrides:

toString in class java.lang.Object

Returns:

the XML String representing this query.