org.jivesoftware.smackx.sid.element

Class StanzaIdElement

java.lang.Object

org.jivesoftware.smackx.sid.element.StableAndUniqueIdElement

org.jivesoftware.smackx.sid.element.StanzaIdElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class StanzaIdElement
extends StableAndUniqueIdElement

Field Summary

Fields

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

Fields inherited from class org.jivesoftware.smackx.sid.element.StableAndUniqueIdElement

ATTR_ID

Constructor Summary

Constructors

Constructor and Description
StanzaIdElement(String by)
StanzaIdElement(String id, String by)

Method Summary

Modifier and Type	Method and Description
String	getBy()
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
static StanzaIdElement	getStanzaId(Message message) Return the stanza-id element of a message.
static boolean	hasStanzaId(Message message) Return true, if a message contains a stanza-id element.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class org.jivesoftware.smackx.sid.element.StableAndUniqueIdElement

getId

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

ATTR_BY

public static final String ATTR_BY

See Also:

Constant Field Values

Constructor Detail

StanzaIdElement

public StanzaIdElement(String by)

StanzaIdElement

public StanzaIdElement(String id,
                       String by)

Method Detail

hasStanzaId

public static boolean hasStanzaId(Message message)

Return true, if a message contains a stanza-id element.

Parameters:

message - message

Returns:

true if message contains stanza-id element, otherwise false.

getStanzaId

public static StanzaIdElement getStanzaId(Message message)

Return the stanza-id element of a message.

Parameters:

message - message

Returns:

stanza-id element of a jid, or null if absent.

getBy

public String getBy()

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Returns:

the namespace.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Returns:

the element name.

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.

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.