org.jivesoftware.smackx.carbons.packet

Class CarbonExtension.Private

java.lang.Object

org.jivesoftware.smackx.carbons.packet.CarbonExtension.Private

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

Enclosing class:

CarbonExtension

public static final class CarbonExtension.Private
extends Object
implements ExtensionElement

Stanza extension indicating that a message may not be carbon-copied. Adding this extension to any message will disallow that message from being copied.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static CarbonExtension.Private	INSTANCE

Method Summary

Modifier and Type	Method and Description
static void	addTo(Message message) Marks a message "private", so that it will not be carbon-copied, by adding private packet extension to the message.
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
String	toXML(String enclosingNamespace) 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

INSTANCE

public static final CarbonExtension.Private INSTANCE

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Method Detail

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

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public String toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

addTo

public static void addTo(Message message)

Marks a message "private", so that it will not be carbon-copied, by adding private packet extension to the message.

Parameters:

message - the message to add the private extension to