org.jivesoftware.smack.packet

Class DefaultExtensionElement

java.lang.Object

org.jivesoftware.smack.packet.DefaultExtensionElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class DefaultExtensionElement
extends Object
implements ExtensionElement

Default implementation of the ExtensionElement interface. Unless a ExtensionElementProvider is registered with ProviderManager, instances of this class will be returned when getting stanza(/packet) extensions.

This class provides a very simple representation of an XML sub-document. Each element is a key in a Map with its CDATA being the value. For example, given the following XML sub-document:

 <foo xmlns="http://bar.com">
     <color>blue</color>
     <food>pizza</food>
 </foo>

In this case, getValue("color") would return "blue", and getValue("food") would return "pizza". This parsing mechanism mechanism is very simplistic and will not work as desired in all cases (for example, if some of the elements have attributes. In those cases, a custom ExtensionElementProvider should be used.

Constructor Summary

Constructors

Constructor and Description
DefaultExtensionElement(String elementName, String namespace) Creates a new generic stanza(/packet) extension.

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the XML element name of the extension sub-packet root element.
Collection<String>	getNames() Returns an unmodifiable collection of the names that can be used to get values of the stanza(/packet) extension.
String	getNamespace() Returns the XML namespace of the extension sub-packet root element.
String	getValue(String name) Returns a stanza(/packet) extension value given a name.
void	setValue(String name, String value) Sets a stanza(/packet) extension value using the given name.
CharSequence	toXML() Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExtensionElement

public DefaultExtensionElement(String elementName,
                               String namespace)

Creates a new generic stanza(/packet) extension.

Parameters:

elementName - the name of the element of the XML sub-document.

namespace - the namespace of the element.

Method Detail

getElementName

public String getElementName()

Returns the XML element name of the extension sub-packet root element.

Specified by:

getElementName in interface NamedElement

Returns:

the XML element name of the stanza(/packet) extension.

getNamespace

public String getNamespace()

Returns the XML namespace of the extension sub-packet root element.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the XML namespace of the stanza(/packet) extension.

toXML

public CharSequence toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.

getNames

public Collection<String> getNames()

Returns an unmodifiable collection of the names that can be used to get values of the stanza(/packet) extension.

Returns:

the names.

getValue

public String getValue(String name)

Returns a stanza(/packet) extension value given a name.

Parameters:

name - the name.

Returns:

the value.

setValue

public void setValue(String name,
                     String value)

Sets a stanza(/packet) extension value using the given name.

Parameters:

name - the name.

value - the value.