org.jivesoftware.smackx.workgroup.packet

Class QueueUpdate

java.lang.Object

org.jivesoftware.smackx.workgroup.packet.QueueUpdate

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class QueueUpdate
extends java.lang.Object
implements ExtensionElement

An IQ stanza(/packet) that encapsulates both types of workgroup queue status notifications -- position updates, and estimated time left in the queue updates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueueUpdate.Provider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT_NAME Element name of the stanza(/packet) extension.
static java.lang.String	NAMESPACE Namespace of the stanza(/packet) extension.

Constructor Summary

Constructors

Constructor and Description
QueueUpdate(int position, int remainingTime)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementName() Returns the root element name.
java.lang.String	getNamespace() Returns the root element XML namespace.
int	getPosition() Returns the user's position in the workgroup queue, or -1 if the value isn't set on this packet.
int	getRemaingTime() Returns the user's estimated time left in the workgroup queue, or -1 if the value isn't set on this packet.
java.lang.String	toXML() 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_NAME

public static final java.lang.String ELEMENT_NAME

Element name of the stanza(/packet) extension.

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

Namespace of the stanza(/packet) extension.

See Also:

Constant Field Values

Constructor Detail

QueueUpdate

public QueueUpdate(int position,
                   int remainingTime)

Method Detail

getPosition

public int getPosition()

Returns the user's position in the workgroup queue, or -1 if the value isn't set on this packet.

Returns:

the position in the workgroup queue.

getRemaingTime

public int getRemaingTime()

Returns the user's estimated time left in the workgroup queue, or -1 if the value isn't set on this packet.

Returns:

the estimated time left in the workgroup queue.

toXML

public java.lang.String toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.

getElementName

public java.lang.String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public java.lang.String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.