Package org.jivesoftware.smackx.usertune.element

Class UserTuneElement

java.lang.Object

org.jivesoftware.smackx.usertune.element.UserTuneElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement, XmlElement, XmlLangElement

public final class UserTuneElement
extends 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 final class	UserTuneElement.Builder	This class defines a Builder class for UserTuneElement.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT
static final UserTuneElement	EMPTY_USER_TUNE
static final String	NAMESPACE
static final QName	QNAME

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static UserTuneElement	from(Message message)
String	getArtist()
static UserTuneElement.Builder	getBuilder()	Returns a new instance of UserTuneElement.Builder.
String	getElementName()	Returns the root element name.
UInt16	getLength()
String	getNamespace()	Returns the root element XML namespace.
Integer	getRating()
String	getSource()
String	getTitle()
String	getTrack()
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.XmlElement

getLanguage, getQName

Field Details

NAMESPACE

public static final String NAMESPACE

See Also:

• Constant Field Values

ELEMENT

public static final String ELEMENT

See Also:

• Constant Field Values

QNAME

public static final QName QNAME

EMPTY_USER_TUNE

public static final UserTuneElement EMPTY_USER_TUNE

Method Details

getNamespace

public String getNamespace()

Description copied from interface: XmlElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface XmlElement

Returns:

the namespace.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getArtist

public String getArtist()

getLength

public UInt16 getLength()

getRating

public Integer getRating()

getSource

public String getSource()

getTitle

public String getTitle()

getTrack

public String getTrack()

getUri

public 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 Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getBuilder

public static UserTuneElement.Builder getBuilder()

Returns a new instance of UserTuneElement.Builder.

Returns:

Builder