Smack

org.jivesoftware.smackx.provider
Interface PrivateDataProvider

All Known Implementing Classes:
Bookmarks.Provider

public interface PrivateDataProvider

An interface for parsing custom private data. Each PrivateDataProvider must be registered with the PrivateDataManager class for it to be used. Every implementation of this interface must have a public, no-argument constructor.

Author:
Matt Tucker

Method Summary
 PrivateData parsePrivateData(org.xmlpull.v1.XmlPullParser parser)
          Parse the private data sub-document and create a PrivateData instance.
 

Method Detail

parsePrivateData

PrivateData parsePrivateData(org.xmlpull.v1.XmlPullParser parser)
                             throws Exception
Parse the private data sub-document and create a PrivateData instance. At the beginning of the method call, the xml parser will be positioned at the opening tag of the private data child element. At the end of the method call, the parser must be positioned on the closing tag of the child element.

Parameters:
parser - an XML parser.
Returns:
a new PrivateData instance.
Throws:
Exception - if an error occurs parsing the XML.

Smack

Copyright © 2003-2007 Jive Software.