org.jivesoftware.smackx.sid.element

Class OriginIdElement

java.lang.Object

org.jivesoftware.smackx.sid.element.StableAndUniqueIdElement

org.jivesoftware.smackx.sid.element.OriginIdElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class OriginIdElement
extends StableAndUniqueIdElement

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT

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

ATTR_ID

Constructor Summary

Constructors

Constructor and Description
OriginIdElement()
OriginIdElement(String id)

Method Summary

Modifier and Type	Method and Description
static OriginIdElement	addOriginId(Message message) Add an origin-id element to a message and set the stanzas id to the same id as in the origin-id element.
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
static OriginIdElement	getOriginId(Message message) Return the origin-id element of a message or null, if absent.
static boolean	hasOriginId(Message message) Return true, if the message contains a origin-id element.
CharSequence	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

Constructor Detail

OriginIdElement

public OriginIdElement()

OriginIdElement

public OriginIdElement(String id)

Method Detail

addOriginId

public static OriginIdElement addOriginId(Message message)

Add an origin-id element to a message and set the stanzas id to the same id as in the origin-id element.

Parameters:

message - message.

hasOriginId

public static boolean hasOriginId(Message message)

Return true, if the message contains a origin-id element.

Parameters:

message - message

Returns:

true if the message contains a origin-id, false otherwise.

getOriginId

public static OriginIdElement getOriginId(Message message)

Return the origin-id element of a message or null, if absent.

Parameters:

message - message

Returns:

origin-id element

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

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.