Package org.jivesoftware.smackx.jingle.element

Class JingleReason

java.lang.Object

org.jivesoftware.smackx.jingle.element.JingleReason

All Implemented Interfaces:

Element, NamedElement, XmlElement, XmlLangElement

Direct Known Subclasses:

JingleReason.AlternativeSession

public class JingleReason
extends Object
implements XmlElement

The Jingle 'reason' element.

See Also:

• XEP-0166 § 7.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JingleReason.AlternativeSession
static enum	JingleReason.Reason

Field Summary

Fields

Modifier and Type	Field	Description
static final JingleReason	Busy
static final JingleReason	Cancel
static final JingleReason	ConnectivityError
static final JingleReason	Decline
static final String	ELEMENT
static final JingleReason	Expired
static final JingleReason	FailedApplication
static final JingleReason	FailedTransport
static final JingleReason	GeneralError
static final JingleReason	Gone
static final JingleReason	IncompatibleParameters
static final JingleReason	MediaError
static final String	NAMESPACE
protected final JingleReason.Reason	reason
static final JingleReason	SecurityError
static final JingleReason	Success
static final String	TEXT_ELEMENT
static final JingleReason	Timeout
static final JingleReason	UnsupportedApplications
static final JingleReason	UnsupportedTransports

Constructor Summary

Constructors

Constructor	Description
JingleReason(JingleReason.Reason reason)
JingleReason(JingleReason.Reason reason, String text, XmlElement element)

Method Summary

Modifier and Type	Method	Description
static JingleReason.AlternativeSession	AlternativeSession(String sessionId)
JingleReason.Reason	asEnum()
XmlElement	getElement()	An optional element that provides more detailed machine-readable information about the reason for the action.
String	getElementName()	Returns the root element name.
String	getNamespace()	Returns the root element XML namespace.
String	getText()	An optional text that provides human-readable information about the reason for the action.
XmlStringBuilder	toXML(XmlEnvironment enclosingXmlEnvironment)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

ELEMENT

public static final String ELEMENT

See Also:

• Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

• Constant Field Values

TEXT_ELEMENT

public static final String TEXT_ELEMENT

See Also:

• Constant Field Values

Busy

public static final JingleReason Busy

Cancel

public static final JingleReason Cancel

ConnectivityError

public static final JingleReason ConnectivityError

Decline

public static final JingleReason Decline

Expired

public static final JingleReason Expired

FailedApplication

public static final JingleReason FailedApplication

FailedTransport

public static final JingleReason FailedTransport

GeneralError

public static final JingleReason GeneralError

Gone

public static final JingleReason Gone

IncompatibleParameters

public static final JingleReason IncompatibleParameters

MediaError

public static final JingleReason MediaError

SecurityError

public static final JingleReason SecurityError

Success

public static final JingleReason Success

Timeout

public static final JingleReason Timeout

UnsupportedApplications

public static final JingleReason UnsupportedApplications

UnsupportedTransports

public static final JingleReason UnsupportedTransports

reason

protected final JingleReason.Reason reason

Constructor Details

JingleReason

public JingleReason(JingleReason.Reason reason)

JingleReason

public JingleReason(JingleReason.Reason reason,
 String text,
 XmlElement element)

Method Details

AlternativeSession

public static JingleReason.AlternativeSession AlternativeSession(String sessionId)

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: XmlElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface XmlElement

Returns:

the namespace.

getText

public String getText()

An optional text that provides human-readable information about the reason for the action.

Returns:

a human-readable text with information regarding this reason or null.

Since:

4.4.5

getElement

public XmlElement getElement()

An optional element that provides more detailed machine-readable information about the reason for the action.

Returns:

an element with machine-readable information about this reason or null.

Since:

4.4.5

toXML

public XmlStringBuilder toXML(XmlEnvironment enclosingXmlEnvironment)

Specified by:

toXML in interface Element

asEnum

public JingleReason.Reason asEnum()