org.jivesoftware.smackx.spoiler.element

Class SpoilerElement

java.lang.Object

org.jivesoftware.smackx.spoiler.element.SpoilerElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class SpoilerElement
extends Object
implements ExtensionElement

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static SpoilerElement	EMPTY
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
SpoilerElement(String language, String hint) Create a new SpoilerElement with a hint about a content and a language attribute.

Method Summary

Modifier and Type	Method and Description
static void	addSpoiler(Message message) Add a SpoilerElement to a message.
static void	addSpoiler(Message message, String hint) Add a SpoilerElement with a hint to a message.
static void	addSpoiler(Message message, String lang, String hint) Add a SpoilerElement with a hint in a certain language to a message.
static boolean	containsSpoiler(Message message) Returns true, if the message has at least one spoiler element.
String	getElementName() Returns the root element name.
String	getHint() Return the hint text of the spoiler.
String	getLanguage() Return the language of the hint.
String	getNamespace() Returns the root element XML namespace.
static Map<String,String>	getSpoilers(Message message) Return a map of all spoilers contained in a message.
CharSequence	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

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

EMPTY

public static final SpoilerElement EMPTY

Constructor Detail

SpoilerElement

public SpoilerElement(String language,
                      String hint)

Create a new SpoilerElement with a hint about a content and a language attribute.

Parameters:

language - language of the hint.

hint - hint about the content.

Method Detail

getHint

public String getHint()

Return the hint text of the spoiler. May be null.

Returns:

hint text

addSpoiler

public static void addSpoiler(Message message)

Add a SpoilerElement to a message.

Parameters:

message - message to add the Spoiler to.

addSpoiler

public static void addSpoiler(Message message,
                              String hint)

Add a SpoilerElement with a hint to a message.

Parameters:

message - Message to add the Spoiler to.

hint - Hint about the Spoilers content.

addSpoiler

public static void addSpoiler(Message message,
                              String lang,
                              String hint)

Add a SpoilerElement with a hint in a certain language to a message.

Parameters:

message - Message to add the Spoiler to.

lang - language of the Spoiler hint.

hint - hint.

containsSpoiler

public static boolean containsSpoiler(Message message)

Returns true, if the message has at least one spoiler element.

Parameters:

message - message

Returns:

true if message has spoiler extension

getSpoilers

public static Map<String,String> getSpoilers(Message message)

Return a map of all spoilers contained in a message. The map uses the language of a spoiler as key. If a spoiler has no language attribute, its key will be an empty String.

Parameters:

message - message

Returns:

map of spoilers

getLanguage

public String getLanguage()

Return the language of the hint. May be null.

Returns:

language of hint text

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

toXML

public CharSequence 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.