Package org.jivesoftware.smackx.carbons.packet

Class CarbonExtension.Private

java.lang.Object

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

All Implemented Interfaces:

Element, ExtensionElement, FullyQualifiedElement, NamedElement, XmlLangElement

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	Description
static String	ELEMENT
static CarbonExtension.Private	INSTANCE

Method Summary

Modifier and Type	Method	Description
static void	addTo(Message message)	Deprecated. use addTo(MessageBuilder) instead.
static void	addTo(MessageBuilder messageBuilder)	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(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

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

Returns the root element XML namespace.

Specified by:

getNamespace in interface FullyQualifiedElement

Returns:

the namespace.

toXML

public String toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element

addTo

public static void addTo(MessageBuilder messageBuilder)

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

Parameters:

messageBuilder - the message to add the private extension to

addTo

@Deprecated
public static void addTo(Message message)

Deprecated.

use addTo(MessageBuilder) instead.

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