org.jivesoftware.smackx.shim.packet

Class HeadersExtension

java.lang.Object

org.jivesoftware.smackx.shim.packet.HeadersExtension

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class HeadersExtension
extends Object
implements ExtensionElement

Extension representing a list of headers as specified in Stanza Headers and Internet Metadata (SHIM).

See Also:

Header

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
HeadersExtension(List<Header> headerList)

Method Summary

Modifier and Type	Method and Description
static HeadersExtension	from(Stanza packet) Return the SHIM headers extension of this stanza or null if there is none.
String	getElementName() Returns the root element name.
List<Header>	getHeaders()
String	getNamespace() Returns the root element XML namespace.
XmlStringBuilder	toXML(String enclosingNamespace) 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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

HeadersExtension

public HeadersExtension(List<Header> headerList)

Method Detail

getHeaders

public List<Header> getHeaders()

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 XmlStringBuilder 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.

from

public static HeadersExtension from(Stanza packet)

Return the SHIM headers extension of this stanza or null if there is none.

Parameters:

packet -

Returns:

the headers extension or null.