org.jivesoftware.smackx.chatstates.packet

Class ChatStateExtension

java.lang.Object

org.jivesoftware.smackx.chatstates.packet.ChatStateExtension

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class ChatStateExtension
extends Object
implements ExtensionElement

Represents a chat state which is an extension to message packets which is used to indicate the current status of a chat participant.

See Also:

ChatState

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
ChatStateExtension(ChatState state) Default constructor.

Method Summary

Modifier and Type	Method and Description
ChatState	getChatState()
String	getElementName() Returns the root element name.
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

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

ChatStateExtension

public ChatStateExtension(ChatState state)

Default constructor. The argument provided is the state that the extension will represent.

Parameters:

state - the state that the extension represents.

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.

getChatState

public ChatState getChatState()

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.