org.jivesoftware.smackx.reference.element

Class ReferenceElement

java.lang.Object

org.jivesoftware.smackx.reference.element.ReferenceElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class ReferenceElement
extends Object
implements ExtensionElement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReferenceElement.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_ANCHOR
static String	ATTR_BEGIN
static String	ATTR_END
static String	ATTR_TYPE
static String	ATTR_URI
static String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
ReferenceElement(Integer begin, Integer end, ReferenceElement.Type type, String anchor, URI uri) XEP-Compliant constructor.
ReferenceElement(Integer begin, Integer end, ReferenceElement.Type type, String anchor, URI uri, ExtensionElement child) XEP-incompliant (v0.2) constructor.

Method Summary

Modifier and Type	Method and Description
static void	addMention(Stanza stanza, int begin, int end, org.jxmpp.jid.BareJid jid) Add a reference to another users bare jid to a stanza.
static boolean	containsReferences(Stanza stanza) Return true, if the stanza contains at least one reference extension.
String	getAnchor()
Integer	getBegin()
String	getElementName() Returns the root element name.
Integer	getEnd()
String	getNamespace() Returns the root element XML namespace.
static List<ReferenceElement>	getReferencesFromStanza(Stanza stanza) Return a list of all reference extensions contained in a stanza.
ReferenceElement.Type	getType()
URI	getUri()
XmlStringBuilder	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

ATTR_BEGIN

public static final String ATTR_BEGIN

See Also:

Constant Field Values

ATTR_END

public static final String ATTR_END

See Also:

Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

Constant Field Values

ATTR_ANCHOR

public static final String ATTR_ANCHOR

See Also:

Constant Field Values

ATTR_URI

public static final String ATTR_URI

See Also:

Constant Field Values

Constructor Detail

ReferenceElement

public ReferenceElement(Integer begin,
                        Integer end,
                        ReferenceElement.Type type,
                        String anchor,
                        URI uri,
                        ExtensionElement child)

XEP-incompliant (v0.2) constructor. This is needed for SIMS.

Parameters:

begin -

end -

type -

anchor -

uri -

child -

ReferenceElement

public ReferenceElement(Integer begin,
                        Integer end,
                        ReferenceElement.Type type,
                        String anchor,
                        URI uri)

XEP-Compliant constructor.

Parameters:

begin -

end -

type -

anchor -

uri -

Method Detail

getBegin

public Integer getBegin()

getEnd

public Integer getEnd()

getType

public ReferenceElement.Type getType()

getAnchor

public String getAnchor()

getUri

public URI getUri()

addMention

public static void addMention(Stanza stanza,
                              int begin,
                              int end,
                              org.jxmpp.jid.BareJid jid)

Add a reference to another users bare jid to a stanza.

Parameters:

stanza - stanza.

begin - start index of the mention in the messages body.

end - end index of the mention in the messages body.

jid - referenced jid.

getReferencesFromStanza

public static List<ReferenceElement> getReferencesFromStanza(Stanza stanza)

Return a list of all reference extensions contained in a stanza. If there are no reference elements, return an empty list.

Parameters:

stanza - stanza

Returns:

list of all references contained in the stanza

containsReferences

public static boolean containsReferences(Stanza stanza)

Return true, if the stanza contains at least one reference extension.

Parameters:

stanza - stanza

Returns:

true if stanza contains references

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 XmlStringBuilder 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.