Packet (Smack 4.1.8 API)

All Superinterfaces:

Element, TopLevelStreamElement

All Known Implementing Classes:

AbstractHttpOverXmpp, AdHocCommandData, AgentChatHistory, AgentInfo, AgentStatusRequest, AgentWorkgroups, Bind, Bytestream, Carbon.Disable, Carbon.Enable, ChatMetadata, ChatNotes, ChatSettings, Close, Data, DepartQueuePacket, DiscoverInfo, DiscoverItems, EmptyResultIQ, ErrorIQ, GenericSettings, HttpOverXmppReq, HttpOverXmppResp, IQ, Jingle, LastActivity, Macros, Message, MonitorPacket, MUCAdmin, MUCOwner, OccupantsInfo, OfferConfirmation, OfferRequestProvider.OfferRequestPacket, OfferRevokeProvider.OfferRevokePacket, OfflineMessageRequest, OfflineSettings, Open, PEPPubSub, Ping, Presence, Privacy, PrivateDataIQ, PubSub, Registration, RoomInvitation.RoomInvitationIQ, RoomTransfer.RoomTransferIQ, RosterPacket, RTPBridge, SearchSettings, Session, SharedGroupsInfo, SimpleIQ, SoundSettings, Stanza, StreamInitiation, STUN, Time, Transcript, Transcripts, TranscriptSearch, UnparsedIQ, UserSearch, VCard, Version, WorkgroupForm, WorkgroupProperties

Deprecated.
use Stanza instead
```
@Deprecated
public interface Packet
extends TopLevelStreamElement
```
Deprecated interface of pre Smack 4.1 Stanzas.

Field Summary

Fields
Modifier and Type Field and Description

static String ITEM
Deprecated.

static String TEXT
Deprecated.

Fields
Modifier and Type	Field and Description
`static String`	`ITEM` Deprecated.
`static String`	`TEXT` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addExtension(ExtensionElement extension)` Deprecated. Adds a stanza(/packet) extension to the packet.
`void`	`addExtensions(Collection<ExtensionElement> extensions)` Deprecated. Adds a collection of stanza(/packet) extensions to the packet.
`XMPPError`	`getError()` Deprecated. Returns the error associated with this packet, or `null` if there are no errors.
`ExtensionElement`	`getExtension(String namespace)` Deprecated. Returns the first extension of this stanza(/packet) that has the given namespace.
`<PE extends ExtensionElement> PE`	`getExtension(String elementName, String namespace)` Deprecated. Returns the first stanza(/packet) extension that matches the specified element name and namespace, or `null` if it doesn't exist.
`List<ExtensionElement>`	`getExtensions()` Deprecated. Returns a copy of the stanza(/packet) extensions attached to the packet.
`Set<ExtensionElement>`	`getExtensions(String elementName, String namespace)` Deprecated. Return a set of all extensions with the given element name and namespace.
`String`	`getFrom()` Deprecated. Returns who the stanza(/packet) is being sent "from" or `null` if the value is not set.
`String`	`getLanguage()` Deprecated. Returns the xml:lang of this Stanza, or null if one has not been set.
`String`	`getPacketID()` Deprecated. use `getStanzaId()` instead.
`String`	`getStanzaId()` Deprecated. Returns the unique ID of the stanza.
`String`	`getTo()` Deprecated. Returns who the stanza(/packet) is being sent "to", or `null` if the value is not set.
`boolean`	`hasExtension(String namespace)` Deprecated. Check if a stanza(/packet) extension with the given namespace exists.
`boolean`	`hasExtension(String elementName, String namespace)` Deprecated. Check if a stanza(/packet) extension with the given element and namespace exists.
`ExtensionElement`	`removeExtension(ExtensionElement extension)` Deprecated. Removes a stanza(/packet) extension from the packet.
`ExtensionElement`	`removeExtension(String elementName, String namespace)` Deprecated. Remove the stanza(/packet) extension with the given elementName and namespace.
`void`	`setError(XMPPError error)` Deprecated. Sets the error for this packet.
`void`	`setFrom(String from)` Deprecated. Sets who the stanza(/packet) is being sent "from".
`void`	`setLanguage(String language)` Deprecated. Sets the xml:lang of this Stanza.
`void`	`setPacketID(String packetID)` Deprecated. use `setStanzaId(String)` instead.
`void`	`setStanzaId(String id)` Deprecated. Sets the unique ID of the packet.
`void`	`setTo(String to)` Deprecated. Sets who the stanza(/packet) is being sent "to".
`String`	`toString()` Deprecated.

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

- Field Detail
  - TEXT
```
static final String TEXT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ITEM
```
static final String ITEM
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getStanzaId
```
String getStanzaId()
```
    Deprecated.
    
    Returns the unique ID of the stanza. The returned value could be null.
    
    Returns:
    
    the packet's unique ID or null if the id is not available.
  - getPacketID
```
@Deprecated
String getPacketID()
```
    Deprecated. use getStanzaId() instead.
    
    Returns:
    
    the stanza id.
  - setStanzaId
```
void setStanzaId(String id)
```
    Deprecated.
    
    Sets the unique ID of the packet. To indicate that a stanza(/packet) has no id pass null as the packet's id value.
    
    Parameters:
    
    id - the unique ID for the packet.
  - setPacketID
```
@Deprecated
void setPacketID(String packetID)
```
    Deprecated. use setStanzaId(String) instead.
    
    Parameters:
    
    packetID -
  - getTo
```
String getTo()
```
    Deprecated.
    
    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.
    
    Returns:
    
    who the stanza(/packet) is being sent to, or null if the value has not been set.
  - setTo
```
void setTo(String to)
```
    Deprecated.
    
    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.
    
    Parameters:
    
    to - who the stanza(/packet) is being sent to.
  - getFrom
```
String getFrom()
```
    Deprecated.
    
    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.
    
    Returns:
    
    who the stanza(/packet) is being sent from, or null if the value has not been set.
  - setFrom
```
void setFrom(String from)
```
    Deprecated.
    
    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.
    
    Parameters:
    
    from - who the stanza(/packet) is being sent to.
  - getError
```
XMPPError getError()
```
    Deprecated.
    
    Returns the error associated with this packet, or null if there are no errors.
    
    Returns:
    
    the error sub-packet or null if there isn't an error.
  - setError
```
void setError(XMPPError error)
```
    Deprecated.
    
    Sets the error for this packet.
    
    Parameters:
    
    error - the error to associate with this packet.
  - getLanguage
```
String getLanguage()
```
    Deprecated.
    
    Returns the xml:lang of this Stanza, or null if one has not been set.
    
    Returns:
    
    the xml:lang of this Stanza, or null.
  - setLanguage
```
void setLanguage(String language)
```
    Deprecated.
    
    Sets the xml:lang of this Stanza.
    
    Parameters:
    
    language - the xml:lang of this Stanza.
  - getExtensions
```
List<ExtensionElement> getExtensions()
```
    Deprecated.
    
    Returns a copy of the stanza(/packet) extensions attached to the packet.
    
    Returns:
    
    the stanza(/packet) extensions.
  - getExtensions
```
Set<ExtensionElement> getExtensions(String elementName,
                                    String namespace)
```
    Deprecated.
    
    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.
    
    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
```
ExtensionElement getExtension(String namespace)
```
    Deprecated.
    
    Returns the first extension of this stanza(/packet) that has the given namespace.
    When possible, use getExtension(String,String) instead.
    
    Parameters:
    
    namespace - the namespace of the extension that is desired.
    
    Returns:
    
    the stanza(/packet) extension with the given namespace.
  - getExtension
```
<PE extends ExtensionElement> PE getExtension(String elementName,
                                              String namespace)
```
    Deprecated.
    
    Returns the first stanza(/packet) 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. Stanza(/Packet) extensions are are arbitrary XML sub-documents in standard XMPP packets. By default, a DefaultPacketExtension instance will be returned for each extension. However, PacketExtensionProvider 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.
    
    Parameters:
    
    elementName - the XML element name of the stanza(/packet) extension. (May be null)
    
    namespace - the XML element namespace of the stanza(/packet) extension.
    
    Returns:
    
    the extension, or null if it doesn't exist.
  - addExtension
```
void addExtension(ExtensionElement extension)
```
    Deprecated.
    
    Adds a stanza(/packet) extension to the packet. Does nothing if extension is null.
    
    Parameters:
    
    extension - a stanza(/packet) extension.
  - addExtensions
```
void addExtensions(Collection<ExtensionElement> extensions)
```
    Deprecated.
    
    Adds a collection of stanza(/packet) extensions to the packet. Does nothing if extensions is null.
    
    Parameters:
    
    extensions - a collection of stanza(/packet) extensions
  - hasExtension
```
boolean hasExtension(String elementName,
                     String namespace)
```
    Deprecated.
    
    Check if a stanza(/packet) extension with the given element and namespace exists.
    The argument elementName may be null.
    
    Parameters:
    
    elementName -
    
    namespace -
    
    Returns:
    
    true if a stanza(/packet) extension exists, false otherwise.
  - hasExtension
```
boolean hasExtension(String namespace)
```
    Deprecated.
    
    Check if a stanza(/packet) extension with the given namespace exists.
    
    Parameters:
    
    namespace -
    
    Returns:
    
    true if a stanza(/packet) extension exists, false otherwise.
  - removeExtension
```
ExtensionElement removeExtension(String elementName,
                                 String namespace)
```
    Deprecated.
    
    Remove the stanza(/packet) extension with the given elementName and namespace.
    
    Parameters:
    
    elementName -
    
    namespace -
    
    Returns:
    
    the removed stanza(/packet) extension or null.
  - removeExtension
```
ExtensionElement removeExtension(ExtensionElement extension)
```
    Deprecated.
    
    Removes a stanza(/packet) extension from the packet.
    
    Parameters:
    
    extension - the stanza(/packet) extension to remove.
    
    Returns:
    
    the removed stanza(/packet) extension or null.
  - toString
```
String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object

Interface Packet

Field Summary

Method Summary

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

Field Detail

TEXT

ITEM

Method Detail

getStanzaId

getPacketID

setStanzaId

setPacketID

getTo

setTo

getFrom

setFrom

getError

setError

getLanguage

setLanguage

getExtensions

getExtensions

getExtension

getExtension

addExtension

addExtensions

hasExtension

hasExtension

removeExtension

removeExtension

toString