org.jivesoftware.smackx.workgroup.packet

Class QueueDetails

java.lang.Object

org.jivesoftware.smackx.workgroup.packet.QueueDetails

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public final class QueueDetails
extends Object
implements ExtensionElement

Queue details stanza extension, which contains details about the users currently in a queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueueDetails.Provider Provider class for QueueDetails stanza extensions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Element name of the stanza extension.
static String	NAMESPACE Namespace of the stanza extension.

Constructor Summary

Constructors

Constructor and Description
QueueDetails()

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
int	getUserCount() Returns the number of users currently in the queue that are waiting to be routed to an agent.
Set<QueueUser>	getUsers() Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).
String	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

ELEMENT_NAME

public static final String ELEMENT_NAME

Element name of the stanza extension.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

Namespace of the stanza extension.

See Also:

Constant Field Values

Constructor Detail

QueueDetails

public QueueDetails()

Method Detail

getUserCount

public int getUserCount()

Returns the number of users currently in the queue that are waiting to be routed to an agent.

Returns:

the number of users in the queue.

getUsers

public Set<QueueUser> getUsers()

Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).

Returns:

a Set for the users waiting in a queue.

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.

toXML

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