Stanza (Smack 4.1.8 API)

java.lang.Object
- org.jivesoftware.smack.packet.Stanza

All Implemented Interfaces:

Element, Packet, TopLevelStreamElement

Direct Known Subclasses:

IQ, Message, Presence
```
public abstract class Stanza
extends Object
implements TopLevelStreamElement, Packet
```
Base class for XMPP Stanzas, which are called Stanza(/Packet) in older versions of Smack (i.e. < 4.1).
Every stanza has a unique ID (which is automatically generated, but can be overridden). Stanza IDs are required for IQ stanzas and recommended for presence and message stanzas. Optionally, the "to" and "from" fields can be set.

XMPP Stanzas are Message, IQ and Presence. Which therefore subclass this class. If you think you need to subclass this class, then you are doing something wrong.

See Also:

RFC 6120 § 8. XML Stanzas

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_LANGUAGE`
`static String`	`ITEM`
`protected String`	`language` Optional value of the 'xml:lang' attribute of the outermost element of the stanza.
`static String`	`TEXT`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Stanza()

protected Stanza(Stanza p)

protected Stanza(String stanzaId)

Constructors
Modifier	Constructor and Description
`protected`	`Stanza()`
`protected`	`Stanza(Stanza p)`
`protected`	`Stanza(String stanzaId)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addCommonAttributes(XmlStringBuilder xml)` Add to, from, id and 'xml:lang' attributes
`void`	`addExtension(ExtensionElement extension)` Adds a stanza(/packet) extension to the packet.
`void`	`addExtensions(Collection<ExtensionElement> extensions)` Adds a collection of stanza(/packet) extensions to the packet.
`protected void`	`appendErrorIfExists(XmlStringBuilder xml)` Append an XMPPError is this stanza(/packet) has one set.
`static String`	`getDefaultLanguage()` Returns the default language used for all messages containing localized content.
`XMPPError`	`getError()` Returns the error associated with this packet, or `null` if there are no errors.
`ExtensionElement`	`getExtension(String namespace)` Returns the first extension of this stanza(/packet) that has the given namespace.
`<PE extends ExtensionElement> PE`	`getExtension(String elementName, String namespace)` Returns the first extension that matches the specified element name and namespace, or `null` if it doesn't exist.
`List<ExtensionElement>`	`getExtensions()` Returns a list of all extension elements of this stanza.
`Set<ExtensionElement>`	`getExtensions(String elementName, String namespace)` Return a set of all extensions with the given element name and namespace.
`protected XmlStringBuilder`	`getExtensionsXML()` Returns the extension sub-packets (including properties data) as an XML String, or the Empty String if there are no stanza(/packet) extensions.
`String`	`getFrom()` Returns who the stanza(/packet) is being sent "from" or `null` if the value is not set.
`String`	`getLanguage()` Returns the xml:lang of this Stanza, or null if one has not been set.
`String`	`getPacketID()` Deprecated. use `getStanzaId()` instead.
`String`	`getStanzaId()` Returns the unique ID of the stanza.
`String`	`getTo()` Returns who the stanza(/packet) is being sent "to", or `null` if the value is not set.
`boolean`	`hasExtension(String namespace)` Check if a stanza(/packet) extension with the given namespace exists.
`boolean`	`hasExtension(String elementName, String namespace)` Check if a stanza(/packet) extension with the given element and namespace exists.
`boolean`	`hasStanzaIdSet()` Check if this stanza has an ID set.
`ExtensionElement`	`overrideExtension(ExtensionElement extension)` Add the given extension and override eventually existing extensions with the same name and namespace.
`ExtensionElement`	`removeExtension(ExtensionElement extension)` Removes a stanza(/packet) extension from the packet.
`ExtensionElement`	`removeExtension(String elementName, String namespace)` Remove the stanza(/packet) extension with the given elementName and namespace.
`void`	`setError(XMPPError error)` Sets the error for this packet.
`void`	`setFrom(String from)` Sets who the stanza(/packet) is being sent "from".
`void`	`setLanguage(String language)` Sets the xml:lang of this Stanza.
`void`	`setPacketID(String packetID)` Deprecated. use `setStanzaId(String)` instead.
`void`	`setStanzaId(String id)` Sets the unique ID of the packet.
`void`	`setTo(String to)` Sets who the stanza(/packet) is being sent "to".
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jivesoftware.smack.packet.Element
toXML

- Field Detail
  - TEXT
```
public static final String TEXT
```
    See Also:
    
    Constant Field Values
  - ITEM
```
public static final String ITEM
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LANGUAGE
```
protected static final String DEFAULT_LANGUAGE
```
  - language
```
protected String language
```
    Optional value of the 'xml:lang' attribute of the outermost element of the stanza.
    Such an attribute is defined for all stanza types. For IQ, see for example XEP-50 3.7: "The requester SHOULD provide its locale information using the "xml:lang " attribute on either the (RECOMMENDED) or element."
- Constructor Detail
  - Stanza
```
protected Stanza()
```
  - Stanza
```
protected Stanza(String stanzaId)
```
  - Stanza
```
protected Stanza(Stanza p)
```
- Method Detail
  - getStanzaId
```
public String getStanzaId()
```
    Returns the unique ID of the stanza. The returned value could be null.
    
    Specified by:
    
    getStanzaId in interface Packet
    
    Returns:
    
    the packet's unique ID or null if the id is not available.
  - getPacketID
```
@Deprecated
public String getPacketID()
```
    Deprecated. use getStanzaId() instead.
    
    Specified by:
    
    getPacketID in interface Packet
    
    Returns:
    
    the stanza id.
  - setStanzaId
```
public void setStanzaId(String id)
```
    Sets the unique ID of the packet. To indicate that a stanza(/packet) has no id pass null as the packet's id value.
    
    Specified by:
    
    setStanzaId in interface Packet
    
    Parameters:
    
    id - the unique ID for the packet.
  - setPacketID
```
@Deprecated
public void setPacketID(String packetID)
```
    Deprecated. use setStanzaId(String) instead.
    
    Specified by:
    
    setPacketID in interface Packet
    
    Parameters:
    
    packetID -
  - hasStanzaIdSet
```
public boolean hasStanzaIdSet()
```
    Check if this stanza has an ID set.
    
    Returns:
    
    true if the stanza ID is set, false otherwise.
    
    Since:
    
    4.1
  - getTo
```
public String getTo()
```
    Returns who the stanza(/packet) is being sent "to", or null if the value is not set. The XMPP protocol often makes the "to" attribute optional, so it does not always need to be set.
    
    Specified by:
    
    getTo in interface Packet
    
    Returns:
    
    who the stanza(/packet) is being sent to, or null if the value has not been set.
  - setTo
```
public void setTo(String to)
```
    Sets who the stanza(/packet) is being sent "to". The XMPP protocol often makes the "to" attribute optional, so it does not always need to be set.
    
    Specified by:
    
    setTo in interface Packet
    
    Parameters:
    
    to - who the stanza(/packet) is being sent to.
  - getFrom
```
public String getFrom()
```
    Returns who the stanza(/packet) is being sent "from" or null if the value is not set. The XMPP protocol often makes the "from" attribute optional, so it does not always need to be set.
    
    Specified by:
    
    getFrom in interface Packet
    
    Returns:
    
    who the stanza(/packet) is being sent from, or null if the value has not been set.
  - setFrom
```
public void setFrom(String from)
```
    Sets who the stanza(/packet) is being sent "from". The XMPP protocol often makes the "from" attribute optional, so it does not always need to be set.
    
    Specified by:
    
    setFrom in interface Packet
    
    Parameters:
    
    from - who the stanza(/packet) is being sent to.
  - getError
```
public XMPPError getError()
```
    Returns the error associated with this packet, or null if there are no errors.
    
    Specified by:
    
    getError in interface Packet
    
    Returns:
    
    the error sub-packet or null if there isn't an error.
  - setError
```
public void setError(XMPPError error)
```
    Sets the error for this packet.
    
    Specified by:
    
    setError in interface Packet
    
    Parameters:
    
    error - the error to associate with this packet.
  - getLanguage
```
public String getLanguage()
```
    Returns the xml:lang of this Stanza, or null if one has not been set.
    
    Specified by:
    
    getLanguage in interface Packet
    
    Returns:
    
    the xml:lang of this Stanza, or null.
  - setLanguage
```
public void setLanguage(String language)
```
    Sets the xml:lang of this Stanza.
    
    Specified by:
    
    setLanguage in interface Packet
    
    Parameters:
    
    language - the xml:lang of this Stanza.
  - getExtensions
```
public List<ExtensionElement> getExtensions()
```
    Returns a list of all extension elements of this stanza.
    
    Specified by:
    
    getExtensions in interface Packet
    
    Returns:
    
    a list of all extension elements of this stanza.
  - getExtensions
```
public Set<ExtensionElement> getExtensions(String elementName,
                                           String namespace)
```
    Return a set of all extensions with the given element name and namespace.
    Changes to the returned set will update the stanza(/packet) extensions, if the returned set is not the empty set.
    
    Specified by:
    
    getExtensions in interface Packet
    
    Parameters:
    
    elementName - the element name, must not be null.
    
    namespace - the namespace of the element(s), must not be null.
    
    Returns:
    
    a set of all matching extensions.
    
    Since:
    
    4.1
  - getExtension
```
public ExtensionElement getExtension(String namespace)
```
    Returns the first extension of this stanza(/packet) that has the given namespace.
    When possible, use getExtension(String,String) instead.
    
    Specified by:
    
    getExtension in interface Packet
    
    Parameters:
    
    namespace - the namespace of the extension that is desired.
    
    Returns:
    
    the stanza(/packet) extension with the given namespace.
  - getExtension
```
public <PE extends ExtensionElement> PE getExtension(String elementName,
                                                     String namespace)
```
    Returns the first extension that matches the specified element name and namespace, or null if it doesn't exist. If the provided elementName is null, only the namespace is matched. Extensions are are arbitrary XML sub-documents in standard XMPP packets. By default, a DefaultExtensionElement instance will be returned for each extension. However, ExtensionElementProvider instances can be registered with the ProviderManager class to handle custom parsing. In that case, the type of the Object will be determined by the provider.
    
    Specified by:
    
    getExtension in interface Packet
    
    Parameters:
    
    elementName - the XML element name of the extension. (May be null)
    
    namespace - the XML element namespace of the extension.
    
    Returns:
    
    the extension, or null if it doesn't exist.
  - addExtension
```
public void addExtension(ExtensionElement extension)
```
    Adds a stanza(/packet) extension to the packet. Does nothing if extension is null.
    
    Specified by:
    
    addExtension in interface Packet
    
    Parameters:
    
    extension - a stanza(/packet) extension.
  - overrideExtension
```
public ExtensionElement overrideExtension(ExtensionElement extension)
```
    Add the given extension and override eventually existing extensions with the same name and namespace.
    
    Parameters:
    
    extension - the extension element to add.
    
    Returns:
    
    one of the removed extensions or null if there are none.
    
    Since:
    
    4.1.2
  - addExtensions
```
public void addExtensions(Collection<ExtensionElement> extensions)
```
    Adds a collection of stanza(/packet) extensions to the packet. Does nothing if extensions is null.
    
    Specified by:
    
    addExtensions in interface Packet
    
    Parameters:
    
    extensions - a collection of stanza(/packet) extensions
  - hasExtension
```
public boolean hasExtension(String elementName,
                            String namespace)
```
    Check if a stanza(/packet) extension with the given element and namespace exists.
    The argument elementName may be null.
    
    Specified by:
    
    hasExtension in interface Packet
    
    Parameters:
    
    elementName -
    
    namespace -
    
    Returns:
    
    true if a stanza(/packet) extension exists, false otherwise.
  - hasExtension
```
public boolean hasExtension(String namespace)
```
    Check if a stanza(/packet) extension with the given namespace exists.
    
    Specified by:
    
    hasExtension in interface Packet
    
    Parameters:
    
    namespace -
    
    Returns:
    
    true if a stanza(/packet) extension exists, false otherwise.
  - removeExtension
```
public ExtensionElement removeExtension(String elementName,
                                        String namespace)
```
    Remove the stanza(/packet) extension with the given elementName and namespace.
    
    Specified by:
    
    removeExtension in interface Packet
    
    Parameters:
    
    elementName -
    
    namespace -
    
    Returns:
    
    the removed stanza(/packet) extension or null.
  - removeExtension
```
public ExtensionElement removeExtension(ExtensionElement extension)
```
    Removes a stanza(/packet) extension from the packet.
    
    Specified by:
    
    removeExtension in interface Packet
    
    Parameters:
    
    extension - the stanza(/packet) extension to remove.
    
    Returns:
    
    the removed stanza(/packet) extension or null.
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface Packet
    
    Overrides:
    
    toString in class Object
  - getExtensionsXML
```
protected final XmlStringBuilder getExtensionsXML()
```
    Returns the extension sub-packets (including properties data) as an XML String, or the Empty String if there are no stanza(/packet) extensions.
    
    Returns:
    
    the extension sub-packets as XML or the Empty String if there are no stanza(/packet) extensions.
  - getDefaultLanguage
```
public static String getDefaultLanguage()
```
    Returns the default language used for all messages containing localized content.
    
    Returns:
    
    the default language
  - addCommonAttributes
```
protected void addCommonAttributes(XmlStringBuilder xml)
```
    Add to, from, id and 'xml:lang' attributes
    
    Parameters:
    
    xml -
  - appendErrorIfExists
```
protected void appendErrorIfExists(XmlStringBuilder xml)
```
    Append an XMPPError is this stanza(/packet) has one set.
    
    Parameters:
    
    xml - the XmlStringBuilder to append the error to.

Class Stanza

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jivesoftware.smack.packet.Element

Field Detail

TEXT

ITEM

DEFAULT_LANGUAGE

language

Constructor Detail

Stanza

Stanza

Stanza

Method Detail

getStanzaId

getPacketID

setStanzaId

setPacketID

hasStanzaIdSet

getTo

setTo

getFrom

setFrom

getError

setError

getLanguage

setLanguage

getExtensions

getExtensions

getExtension

getExtension

addExtension

overrideExtension

addExtensions

hasExtension

hasExtension

removeExtension

removeExtension

toString

getExtensionsXML

getDefaultLanguage

addCommonAttributes

appendErrorIfExists