org.jivesoftware.smackx.pubsub

Class SimplePayload

java.lang.Object

org.jivesoftware.smackx.pubsub.SimplePayload

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class SimplePayload
extends Object
implements ExtensionElement

The default payload representation for PayloadItem.getPayload(). It simply stores the XML payload as a string.

Constructor Summary

Constructors

Constructor and Description
SimplePayload(String xmlPayload) Construct a SimplePayload object with the specified element name, namespace and content.
SimplePayload(String elementName, String namespace, CharSequence xmlPayload) Deprecated. use SimplePayload(String) insteas.

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
String	toString()
String	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplePayload

public SimplePayload(String xmlPayload)

Construct a SimplePayload object with the specified element name, namespace and content. The content must be well formed XML.

Parameters:

xmlPayload - The payload data

SimplePayload

@Deprecated
public SimplePayload(String elementName,
                                 String namespace,
                                 CharSequence xmlPayload)

Deprecated. use SimplePayload(String) insteas.

Construct a SimplePayload object with the specified element name, namespace and content. The content must be well formed XML.

Parameters:

elementName - The root element name (of the payload)

namespace - The namespace of the payload, null if there is none

xmlPayload - The payload data

Method Detail

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public String 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

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

toString

public String toString()

Overrides:

toString in class Object