Package org.jivesoftware.smackx.carbons.packet

Class CarbonExtension

java.lang.Object

org.jivesoftware.smackx.carbons.packet.CarbonExtension

All Implemented Interfaces:

Element, ExtensionElement, FullyQualifiedElement, NamedElement, XmlLangElement

public class CarbonExtension
extends Object
implements ExtensionElement

Stanza extension for XEP-0280: Message Carbons. The extension XEP-0280 is meant to synchronize a message flow to multiple presences of a user.

It accomplishes this by wrapping a Forwarded stanza in a sent or received element

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CarbonExtension.Direction	Defines the direction of a CarbonExtension message.
static class	CarbonExtension.Private	Stanza extension indicating that a message may not be carbon-copied.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
CarbonExtension(CarbonExtension.Direction dir, Forwarded<Message> fwd)	Construct a Carbon message extension.

Method Summary

Modifier and Type	Method	Description
static CarbonExtension	from(Message msg)	Obtain a Carbon from a message, if available.
CarbonExtension.Direction	getDirection()	Get the direction (sent or received) of the carbon.
String	getElementName()	Returns the root element name.
Forwarded<Message>	getForwarded()	Get the forwarded packet.
static CarbonExtension	getFrom(Message msg)	Deprecated. use from(Message) instead
String	getNamespace()	Returns the root element XML namespace.
XmlStringBuilder	toXML(XmlEnvironment enclosingNamespace)

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.FullyQualifiedElement

getLanguage, getQName

Field Detail

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

CarbonExtension

public CarbonExtension(CarbonExtension.Direction dir,
                       Forwarded<Message> fwd)

Construct a Carbon message extension.

Parameters:

dir - Determines if the carbon is being sent/received

fwd - The forwarded message.

Method Detail

getDirection

public CarbonExtension.Direction getDirection()

Get the direction (sent or received) of the carbon.

Returns:

the CarbonExtension.Direction of the carbon.

getForwarded

public Forwarded<Message> getForwarded()

Get the forwarded packet.

Returns:

the Forwarded message contained in this Carbon.

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

Returns the root element XML namespace.

Specified by:

getNamespace in interface FullyQualifiedElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element

getFrom

@Deprecated
public static CarbonExtension getFrom(Message msg)

Deprecated.

use from(Message) instead

Obtain a Carbon from a message, if available.

Only Message instances can contain a Carbon extensions.

Parameters:

msg - Message object to check for carbons

Returns:

a Carbon if available, null otherwise.

from

public static CarbonExtension from(Message msg)

Obtain a Carbon from a message, if available.

Only Message instances can contain a Carbon extensions.

Parameters:

msg - Message object to check for carbons

Returns:

a Carbon if available, null otherwise.