com.caucho.xmpp.data
Class XmppDataFormMarshal

java.lang.Object
  com.caucho.xmpp.AbstractXmppMarshal
      com.caucho.xmpp.data.XmppDataFormMarshal

All Implemented Interfaces:

XmppMarshal

public class XmppDataFormMarshal
extends AbstractXmppMarshal

DataForm XEP-0004: http://www.xmpp.org/extensions/xep-0004.html

 namespace = jabber:x:data

 element x {
   attribute type,

   instructions*,
   title?,
   field*,
   reported?,
   item*
 }

 element field {
    attribute label?,
    attribute type?,
    attribute var?,

    desc?,
    required?,
    value*,
    option*,
 }

 element item {
   field+
 }

 element option {
   attribute label?,

   value*
 }

 element reported {
   field+
 }

 element value {
   string
 }
 

Constructor Summary

XmppDataFormMarshal()

Method Summary

java.io.Serializable	fromXml(XmppStreamReader in) Deserializes the object from XML
java.lang.String	getClassName() Returns the java classname of the object
java.lang.String	getLocalName() Returns the local name for the XMPP stanza value
java.lang.String	getNamespaceURI() Returns the namespace uri for the XMPP stanza value
DataField	parseField(XMLStreamReader in) Deserializes the object from XML
DataItem	parseItem(XMLStreamReader in) Deserializes the object from XML
DataOption	parseOption(XMLStreamReader in) Deserializes the object from XML
DataReported	parseReported(XMLStreamReader in) Deserializes the object from XML
void	toXml(XmppStreamWriter out, java.io.Serializable object) Serializes the object to XML

Methods inherited from class com.caucho.xmpp.AbstractXmppMarshal

debug, expectEnd, expectEnd, skipToEnd, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XmppDataFormMarshal

public XmppDataFormMarshal()

Method Detail

getNamespaceURI

public java.lang.String getNamespaceURI()

Returns the namespace uri for the XMPP stanza value

getLocalName

public java.lang.String getLocalName()

Returns the local name for the XMPP stanza value

getClassName

public java.lang.String getClassName()

Returns the java classname of the object

toXml

public void toXml(XmppStreamWriter out,
                  java.io.Serializable object)
           throws java.io.IOException,
                  XMLStreamException

Serializes the object to XML

Specified by:

toXml in interface XmppMarshal

Specified by:

toXml in class AbstractXmppMarshal

Throws:

java.io.IOException

XMLStreamException

fromXml

public java.io.Serializable fromXml(XmppStreamReader in)
                             throws java.io.IOException,
                                    XMLStreamException

Deserializes the object from XML

Specified by:

fromXml in interface XmppMarshal

Specified by:

fromXml in class AbstractXmppMarshal

Throws:

java.io.IOException

XMLStreamException

parseField

public DataField parseField(XMLStreamReader in)
                     throws java.io.IOException,
                            XMLStreamException

Deserializes the object from XML

Throws:

java.io.IOException

XMLStreamException

parseItem

public DataItem parseItem(XMLStreamReader in)
                   throws java.io.IOException,
                          XMLStreamException

Deserializes the object from XML

Throws:

java.io.IOException

XMLStreamException

parseReported

public DataReported parseReported(XMLStreamReader in)
                           throws java.io.IOException,
                                  XMLStreamException

Deserializes the object from XML

Throws:

java.io.IOException

XMLStreamException

parseOption

public DataOption parseOption(XMLStreamReader in)
                       throws java.io.IOException,
                              XMLStreamException

Deserializes the object from XML

Throws:

java.io.IOException

XMLStreamException