org.jivesoftware.smackx.carbons.packet

Class CarbonExtension

java.lang.Object

org.jivesoftware.smackx.carbons.packet.CarbonExtension

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class CarbonExtension
extends java.lang.Object
implements ExtensionElement

Stanza(/Packet) 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(/packet) in a sent or received element

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
java.lang.String	getElementName() Returns the root element name.
Forwarded	getForwarded() Get the forwarded packet.
static CarbonExtension	getFrom(Message msg) Deprecated. use from(Message) instead
java.lang.String	getNamespace() Returns the root element XML namespace.
XmlStringBuilder	toXML() 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

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

CarbonExtension

public CarbonExtension(CarbonExtension.Direction dir,
                       Forwarded 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 getForwarded()

Get the forwarded packet.

Returns:

the Forwarded message contained in this Carbon.

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.

getNamespace

public java.lang.String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.

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.