org.jivesoftware.smackx.last_interaction.element

Class IdleElement

java.lang.Object

org.jivesoftware.smackx.last_interaction.element.IdleElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class IdleElement
extends Object
implements ExtensionElement

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IdleElement() Create a new IdleElement with the current date as date of last user interaction.
IdleElement(Date since) Create a new IdleElement.

Method Summary

Modifier and Type	Method and Description
static void	addToPresence(Presence presence) Add an Idle element with current date to the presence.
static IdleElement	fromPresence(Presence presence) Return the IdleElement from a presence.
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
Date	getSince() Return the value of last user interaction.
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

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

ATTR_SINCE

public static final String ATTR_SINCE

See Also:

Constant Field Values

Constructor Detail

IdleElement

public IdleElement()

Create a new IdleElement with the current date as date of last user interaction.

IdleElement

public IdleElement(Date since)

Create a new IdleElement.

Parameters:

since - date of last user interaction

Method Detail

getSince

public Date getSince()

Return the value of last user interaction.

Returns:

date of last interaction

addToPresence

public static void addToPresence(Presence presence)

Add an Idle element with current date to the presence.

Parameters:

presence - presence

fromPresence

public static IdleElement fromPresence(Presence presence)

Return the IdleElement from a presence. Returns null, if no IdleElement found.

Parameters:

presence - presence

Returns:

idleElement from presence or null

getNamespace

public String getNamespace()

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

getElementName

public String getElementName()

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

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.