Package org.jivesoftware.smackx.usertune.element

Class UserTuneElement

java.lang.Object

org.jivesoftware.smackx.usertune.element.UserTuneElement

All Implemented Interfaces:

Element, ExtensionElement, FullyQualifiedElement, NamedElement, XmlLangElement

public final class UserTuneElement
extends java.lang.Object
implements ExtensionElement

ExtensionElement that contains the UserTune.
Instance of UserTuneElement can be created using UserTuneElement.Builder.build() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserTuneElement.Builder	This class defines a Builder class for UserTuneElement.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ELEMENT
static UserTuneElement	EMPTY_USER_TUNE
static java.lang.String	NAMESPACE
static javax.xml.namespace.QName	QNAME

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static UserTuneElement	from(Message message)
java.lang.String	getArtist()
static UserTuneElement.Builder	getBuilder()	Returns a new instance of UserTuneElement.Builder.
java.lang.String	getElementName()	Returns the root element name.
UInt16	getLength()
java.lang.String	getNamespace()	Returns the root element XML namespace.
java.lang.Integer	getRating()
java.lang.String	getSource()
java.lang.String	getTitle()
java.lang.String	getTrack()
java.net.URI	getUri()
int	hashCode()
static boolean	hasUserTuneElement(Message message)
XmlStringBuilder	toXML(XmlEnvironment xmlEnvironment)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

getLanguage, getQName

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

QNAME

public static final javax.xml.namespace.QName QNAME

EMPTY_USER_TUNE

public static final UserTuneElement EMPTY_USER_TUNE

Method Detail

getNamespace

public java.lang.String getNamespace()

Description copied from interface: FullyQualifiedElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface FullyQualifiedElement

Returns:

the namespace.

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.

getArtist

public java.lang.String getArtist()

getLength

public UInt16 getLength()

getRating

public java.lang.Integer getRating()

getSource

public java.lang.String getSource()

getTitle

public java.lang.String getTitle()

getTrack

public java.lang.String getTrack()

getUri

public java.net.URI getUri()

toXML

public XmlStringBuilder toXML(XmlEnvironment xmlEnvironment)

Specified by:

toXML in interface Element

hasUserTuneElement

public static boolean hasUserTuneElement(Message message)

from

public static UserTuneElement from(Message message)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getBuilder

public static UserTuneElement.Builder getBuilder()

Returns a new instance of UserTuneElement.Builder.

Returns:

Builder