org.jivesoftware.smackx.pubsub

Class FormNode

java.lang.Object

org.jivesoftware.smackx.pubsub.NodeExtension

org.jivesoftware.smackx.pubsub.FormNode

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class FormNode
extends NodeExtension

Generic stanza extension which represents any PubSub form that is parsed from the incoming stream or being sent out to the server. Form types are defined in FormNodeType.

Constructor Summary

Constructors

Constructor and Description
FormNode(FormNodeType formType, Form submitForm) Create a FormNode which contains the specified form.
FormNode(FormNodeType formType, String nodeId, Form submitForm) Create a FormNode which contains the specified form, which is associated with the specified node.

Method Summary

Modifier and Type	Method and Description
Form	getForm() Get the Form that is to be sent, or was retrieved from the server.
CharSequence	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class org.jivesoftware.smackx.pubsub.NodeExtension

getElementName, getNamespace, getNode, getPubSubNamespace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FormNode

public FormNode(FormNodeType formType,
                Form submitForm)

Create a FormNode which contains the specified form.

Parameters:

formType - The type of form being sent

submitForm - The form

FormNode

public FormNode(FormNodeType formType,
                String nodeId,
                Form submitForm)

Create a FormNode which contains the specified form, which is associated with the specified node.

Parameters:

formType - The type of form being sent

nodeId - The node the form is associated with

submitForm - The form

Method Detail

getForm

public Form getForm()

Get the Form that is to be sent, or was retrieved from the server.

Returns:

The form

toXML

public CharSequence toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Overrides:

toXML in class NodeExtension

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.