org.jivesoftware.smack.packet

Interface Packet

All Superinterfaces:

Element, TopLevelStreamElement

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 java.lang.String	ITEM Deprecated.
static java.lang.String	TEXT Deprecated.

Method Summary

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

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

toXML, toXML, toXML

Field Detail

TEXT

static final java.lang.String TEXT

Deprecated.

See Also:

Constant Field Values

ITEM

static final java.lang.String ITEM

Deprecated.

See Also:

Constant Field Values

Method Detail

getStanzaId

java.lang.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
java.lang.String getPacketID()

Deprecated. use getStanzaId() instead.

Get the stanza id.

Returns:

the stanza id.

setStanzaId

void setStanzaId(java.lang.String id)

Deprecated.

Sets the unique ID of the packet. To indicate that a stanza has no id pass null as the packet's id value.

Parameters:

id - the unique ID for the packet.

setPacketID

@Deprecated
void setPacketID(java.lang.String packetID)

Deprecated. use setStanzaId(String) instead.

Set the stanza ID.

Parameters:

packetID -

getTo

java.lang.String getTo()

Deprecated.

Returns who the stanza 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 is being sent to, or null if the value has not been set.

setTo

void setTo(java.lang.String to)

Deprecated.

Sets who the stanza 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 is being sent to.

getFrom

java.lang.String getFrom()

Deprecated.

Returns who the stanza 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 is being sent from, or null if the value has not been set.

setFrom

void setFrom(java.lang.String from)

Deprecated.

Sets who the stanza 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 is being sent to.

getError

StanzaError 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(StanzaError error)

Deprecated.

Sets the error for this packet.

Parameters:

error - the error to associate with this packet.

getLanguage

java.lang.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(java.lang.String language)

Deprecated.

Sets the xml:lang of this Stanza.

Parameters:

language - the xml:lang of this Stanza.

getExtensions

java.util.List<ExtensionElement> getExtensions()

Deprecated.

Returns a copy of the stanza extensions attached to the packet.

Returns:

the stanza extensions.

getExtensions

java.util.Set<ExtensionElement> getExtensions(java.lang.String elementName,
                                              java.lang.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 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(java.lang.String namespace)

Deprecated.

Returns the first extension of this stanza 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 extension with the given namespace.

getExtension

<PE extends ExtensionElement> PE getExtension(java.lang.String elementName,
                                              java.lang.String namespace)

Deprecated.

Returns the first stanza 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 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.

Type Parameters:

PE - type of the ExtensionElement.

Parameters:

elementName - the XML element name of the stanza extension. (May be null)

namespace - the XML element namespace of the stanza extension.

Returns:

the extension, or null if it doesn't exist.

addExtension

void addExtension(ExtensionElement extension)

Deprecated.

Adds a stanza extension to the packet. Does nothing if extension is null.

Parameters:

extension - a stanza extension.

addExtensions

void addExtensions(java.util.Collection<ExtensionElement> extensions)

Deprecated.

Adds a collection of stanza extensions to the packet. Does nothing if extensions is null.

Parameters:

extensions - a collection of stanza extensions

hasExtension

boolean hasExtension(java.lang.String elementName,
                     java.lang.String namespace)

Deprecated.

Check if a stanza extension with the given element and namespace exists.

The argument elementName may be null.

Parameters:

elementName -

namespace -

Returns:

true if a stanza extension exists, false otherwise.

hasExtension

boolean hasExtension(java.lang.String namespace)

Deprecated.

Check if a stanza extension with the given namespace exists.

Parameters:

namespace -

Returns:

true if a stanza extension exists, false otherwise.

removeExtension

ExtensionElement removeExtension(java.lang.String elementName,
                                 java.lang.String namespace)

Deprecated.

Remove the stanza extension with the given elementName and namespace.

Parameters:

elementName -

namespace -

Returns:

the removed stanza extension or null.

removeExtension

ExtensionElement removeExtension(ExtensionElement extension)

Deprecated.

Removes a stanza extension from the packet.

Parameters:

extension - the stanza extension to remove.

Returns:

the removed stanza extension or null.

toString

java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object