org.jivesoftware.smack.util

Class PacketParserUtils

java.lang.Object

org.jivesoftware.smack.util.PacketParserUtils

public class PacketParserUtils
extends java.lang.Object

Utility class that helps to parse packets. Any parsing packets method that must be shared between many clients must be placed in this utility class.

Author:

Gaston Dombiak

Constructor Summary

Constructors

Constructor and Description
PacketParserUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static XMPPError	parseError(org.xmlpull.v1.XmlPullParser parser) Parses error sub-packets.
static Packet	parseMessage(org.xmlpull.v1.XmlPullParser parser) Parses a message packet.
static PacketExtension	parsePacketExtension(java.lang.String elementName, java.lang.String namespace, org.xmlpull.v1.XmlPullParser parser) Parses a packet extension sub-packet.
static Presence	parsePresence(org.xmlpull.v1.XmlPullParser parser) Parses a presence packet.
static java.util.Map	parseProperties(org.xmlpull.v1.XmlPullParser parser) Parse a properties sub-packet.
static java.lang.Object	parseWithIntrospection(java.lang.String elementName, java.lang.Class objectClass, org.xmlpull.v1.XmlPullParser parser)

Methods inherited from class java.lang.Object

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

Constructor Detail

PacketParserUtils

public PacketParserUtils()

Method Detail

parseMessage

public static Packet parseMessage(org.xmlpull.v1.XmlPullParser parser)
                           throws java.lang.Exception

Parses a message packet.

Parameters:

parser - the XML parser, positioned at the start of a message packet.

Returns:

a Message packet.

Throws:

java.lang.Exception - if an exception occurs while parsing the packet.

parsePresence

public static Presence parsePresence(org.xmlpull.v1.XmlPullParser parser)
                              throws java.lang.Exception

Parses a presence packet.

Parameters:

parser - the XML parser, positioned at the start of a presence packet.

Returns:

a Presence packet.

Throws:

java.lang.Exception - if an exception occurs while parsing the packet.

parseProperties

public static java.util.Map parseProperties(org.xmlpull.v1.XmlPullParser parser)
                                     throws java.lang.Exception

Parse a properties sub-packet. If any errors occur while de-serializing Java object properties, an exception will be printed and not thrown since a thrown exception will shut down the entire connection. ClassCastExceptions will occur when both the sender and receiver of the packet don't have identical versions of the same class.

Parameters:

parser - the XML parser, positioned at the start of a properties sub-packet.

Returns:

a map of the properties.

Throws:

java.lang.Exception - if an error occurs while parsing the properties.

parseError

public static XMPPError parseError(org.xmlpull.v1.XmlPullParser parser)
                            throws java.lang.Exception

Parses error sub-packets.

Parameters:

parser - the XML parser.

Returns:

an error sub-packet.

Throws:

java.lang.Exception - if an exception occurs while parsing the packet.

parsePacketExtension

public static PacketExtension parsePacketExtension(java.lang.String elementName,
                                   java.lang.String namespace,
                                   org.xmlpull.v1.XmlPullParser parser)
                                            throws java.lang.Exception

Parses a packet extension sub-packet.

Parameters:

elementName - the XML element name of the packet extension.

namespace - the XML namespace of the packet extension.

parser - the XML parser, positioned at the starting element of the extension.

Returns:

a PacketExtension.

Throws:

java.lang.Exception - if a parsing error occurs.

parseWithIntrospection

public static java.lang.Object parseWithIntrospection(java.lang.String elementName,
                                      java.lang.Class objectClass,
                                      org.xmlpull.v1.XmlPullParser parser)
                                               throws java.lang.Exception

Throws:

java.lang.Exception