org.jivesoftware.smackx.hints.element

Class StoreHint

java.lang.Object

org.jivesoftware.smackx.hints.element.MessageProcessingHint

org.jivesoftware.smackx.hints.element.StoreHint

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public final class StoreHint
extends MessageProcessingHint

A "store" hint. Messages with this hint should be stored in permanent stores or archives.

See Also:

XEP-0334 § 4.4 Store

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static StoreHint	INSTANCE

Fields inherited from class org.jivesoftware.smackx.hints.element.MessageProcessingHint

NAMESPACE

Method Summary

Modifier and Type	Method and Description
static StoreHint	from(Message message)
String	getElementName() Returns the root element name.
MessageProcessingHintType	getHintType()
static boolean	hasHint(Message message)
static void	set(Message message)
String	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class org.jivesoftware.smackx.hints.element.MessageProcessingHint

getNamespace

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final StoreHint 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.

Returns:

the element name.

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.

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

getHintType

public MessageProcessingHintType getHintType()

Specified by:

getHintType in class MessageProcessingHint

from

public static StoreHint from(Message message)

hasHint

public static boolean hasHint(Message message)

set

public static void set(Message message)