org.jivesoftware.smackx.carbons.packet

Class CarbonExtension

java.lang.Object

org.jivesoftware.smackx.carbons.packet.CarbonExtension

All Implemented Interfaces:

PacketExtension

public class CarbonExtension
extends Object
implements PacketExtension

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 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 Packet extension indicating that a message may not be carbon-copied.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CarbonExtension.Direction	getDirection() Get the direction (sent or received) of the carbon.
String	getElementName() Returns the root element name.
Forwarded	getForwarded() Get the forwarded packet.
String	getNamespace() Returns the root element XML namespace.
String	toXML() Returns the XML representation of the PacketExtension.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final 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 String getElementName()

Description copied from interface: PacketExtension

Returns the root element name.

Specified by:

getElementName in interface PacketExtension

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: PacketExtension

Returns the root element XML namespace.

Specified by:

getNamespace in interface PacketExtension

Returns:

the namespace.

toXML

public String toXML()

Description copied from interface: PacketExtension

Returns the XML representation of the PacketExtension.

Specified by:

toXML in interface PacketExtension

Returns:

the packet extension as XML.