public abstract class Packet extends Object
Modifier and Type | Field and Description |
---|---|
protected static String |
DEFAULT_LANGUAGE |
static String |
ID_NOT_AVAILABLE
Constant used as packetID to indicate that a packet has no id.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addCommonAttributes(XmlStringBuilder xml)
Add to, from and id attributes
|
void |
addExtension(PacketExtension extension)
Adds a packet extension to the packet.
|
void |
addExtensions(Collection<PacketExtension> extensions)
Adds a collection of packet extensions to the packet.
|
boolean |
equals(Object o) |
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.
|
PacketExtension |
getExtension(String namespace)
Returns the first extension of this packet that has the given namespace.
|
<PE extends PacketExtension> |
getExtension(String elementName,
String namespace)
Returns the first packet extension that matches the specified element name and
namespace, or null if it doesn't exist.
|
Collection<PacketExtension> |
getExtensions()
Returns an unmodifiable collection of the packet extensions attached to the packet.
|
protected CharSequence |
getExtensionsXML()
Returns the extension sub-packets (including properties data) as an XML
String, or the Empty String if there are no packet extensions.
|
String |
getFrom()
Returns who the packet is being sent "from" or null if
the value is not set.
|
String |
getPacketID()
Returns the unique ID of the packet.
|
String |
getTo()
Returns who the packet is being sent "to", or null if
the value is not set.
|
String |
getXmlns() |
int |
hashCode() |
static String |
nextID()
Returns the next unique id.
|
void |
removeExtension(PacketExtension extension)
Removes a packet extension from the packet.
|
static void |
setDefaultXmlns(String defaultXmlns) |
void |
setError(XMPPError error)
Sets the error for this packet.
|
void |
setFrom(String from)
Sets who the packet is being sent "from".
|
void |
setPacketID(String packetID)
Sets the unique ID of the packet.
|
void |
setTo(String to)
Sets who the packet is being sent "to".
|
String |
toString() |
abstract CharSequence |
toXML()
Returns the packet as XML.
|
protected static final String DEFAULT_LANGUAGE
public static final String ID_NOT_AVAILABLE
public static String nextID()
public static void setDefaultXmlns(String defaultXmlns)
public String getPacketID()
public void setPacketID(String packetID)
packetID
- the unique ID for the packet.public String getTo()
The StringUtils class provides several useful methods for dealing with
XMPP addresses such as parsing the
bare address
,
user name
,
server
, and
resource
.
public void setTo(String to)
to
- who the packet is being sent to.public String getFrom()
The StringUtils class provides several useful methods for dealing with
XMPP addresses such as parsing the
bare address
,
user name
,
server
, and
resource
.
public void setFrom(String from)
from
- who the packet is being sent to.public XMPPError getError()
public void setError(XMPPError error)
error
- the error to associate with this packet.public Collection<PacketExtension> getExtensions()
public PacketExtension getExtension(String namespace)
namespace
- the namespace of the extension that is desired.public <PE extends PacketExtension> PE getExtension(String elementName, String namespace)
ProviderManager
class to handle custom parsing. In that case, the type of the Object
will be determined by the provider.elementName
- the XML element name of the packet extension. (May be null)namespace
- the XML element namespace of the packet extension.public void addExtension(PacketExtension extension)
extension
- a packet extension.public void addExtensions(Collection<PacketExtension> extensions)
extensions
- a collection of packet extensionspublic void removeExtension(PacketExtension extension)
extension
- the packet extension to remove.public abstract CharSequence toXML()
protected CharSequence getExtensionsXML()
public static String getDefaultLanguage()
protected void addCommonAttributes(XmlStringBuilder xml)
xml
-