Package org.jivesoftware.smackx.spoiler.element

Class SpoilerElement

java.lang.Object
org.jivesoftware.smackx.spoiler.element.SpoilerElement
All Implemented Interfaces:
org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.ExtensionElement, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.XmlElement, org.jivesoftware.smack.packet.XmlLangElement
public class SpoilerElement extends Object implements org.jivesoftware.smack.packet.ExtensionElement

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELEMENT
     
    static final SpoilerElement
    EMPTY
     
    static final String
    NAMESPACE
     
    static final QName
    QNAME
     

  • Constructor Summary

    Constructors
    Constructor
    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
    Description
    static void
    addSpoiler(org.jivesoftware.smack.packet.Message message)
    Add a SpoilerElement to a message.
    static void
    addSpoiler(org.jivesoftware.smack.packet.Message message, String hint)
    Add a SpoilerElement with a hint to a message.
    static void
    addSpoiler(org.jivesoftware.smack.packet.Message message, String lang, String hint)
    Add a SpoilerElement with a hint in a certain language to a message.
    static boolean
    containsSpoiler(org.jivesoftware.smack.packet.Message message)
    Returns true, if the message has at least one spoiler element.
    String
    getElementName()
     
    String
    getHint()
    Return the hint text of the spoiler.
    String
    getLanguage()
     
    String
    getNamespace()
     
    static Map<String,String>
    getSpoilers(org.jivesoftware.smack.packet.Message message)
    Return a map of all spoilers contained in a message.
    CharSequence
    toXML(org.jivesoftware.smack.packet.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.XmlElement

    getQName

  • Field Details

  • Constructor Details

    • 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 Details

    • getHint

      public String getHint()
      Return the hint text of the spoiler. May be null.
      Returns:
      hint text

    • addSpoiler

      public static void addSpoiler(org.jivesoftware.smack.packet.Message message)
      Add a SpoilerElement to a message.
      Parameters:
      message - message to add the Spoiler to.

    • addSpoiler

      public static void addSpoiler(org.jivesoftware.smack.packet.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(org.jivesoftware.smack.packet.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(org.jivesoftware.smack.packet.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(org.jivesoftware.smack.packet.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()
      Specified by:
      getLanguage in interface org.jivesoftware.smack.packet.XmlElement
      Specified by:
      getLanguage in interface org.jivesoftware.smack.packet.XmlLangElement

    • getNamespace

      public String getNamespace()
      Specified by:
      getNamespace in interface org.jivesoftware.smack.packet.XmlElement

    • getElementName

      public String getElementName()
      Specified by:
      getElementName in interface org.jivesoftware.smack.packet.NamedElement

    • toXML

      public CharSequence toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
      Specified by:
      toXML in interface org.jivesoftware.smack.packet.Element