org.jivesoftware.smackx.delay.packet

Class DelayInformation

java.lang.Object

org.jivesoftware.smackx.delay.packet.DelayInformation

All Implemented Interfaces:

PacketExtension

Direct Known Subclasses:

DelayInfo

public class DelayInformation
extends Object
implements PacketExtension

Represents timestamp information about data stored for later delivery. A DelayInformation will always includes the timestamp when the packet was originally sent and may include more information such as the JID of the entity that originally sent the packet as well as the reason for the delay.

For more information see XEP-0091 and XEP-0203.

Field Summary

Fields

Modifier and Type	Field and Description
static DateFormat	XEP_0091_UTC_FORMAT Date format according to the obsolete XEP-0091 specification.

Constructor Summary

Constructors

Constructor and Description
DelayInformation(Date stamp) Creates a new instance with the specified timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
String	getFrom() Returns the JID of the entity that originally sent the packet or that delayed the delivery of the packet or null if this information is not available.
String	getNamespace() Returns the root element XML namespace.
String	getReason() Returns a natural-language description of the reason for the delay or null if this information is not available.
Date	getStamp() Returns the timestamp when the packet was originally sent.
void	setFrom(String from) Sets the JID of the entity that originally sent the packet or that delayed the delivery of the packet or null if this information is not available.
void	setReason(String reason) Sets a natural-language description of the reason for the delay or null if this information is not available.
String	toXML() Returns the XML representation of the PacketExtension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XEP_0091_UTC_FORMAT

public static final DateFormat XEP_0091_UTC_FORMAT

Date format according to the obsolete XEP-0091 specification. XEP-0091 recommends to use this old format for date-time instead of the one specified in XEP-0082.

Date formats are not synchronized. Since multiple threads access the format concurrently, it must be synchronized externally.

Constructor Detail

DelayInformation

public DelayInformation(Date stamp)

Creates a new instance with the specified timestamp.

Parameters:

stamp - the timestamp

Method Detail

getFrom

public String getFrom()

Returns the JID of the entity that originally sent the packet or that delayed the delivery of the packet or null if this information is not available.

Returns:

the JID of the entity that originally sent the packet or that delayed the delivery of the packet.

setFrom

public void setFrom(String from)

Sets the JID of the entity that originally sent the packet or that delayed the delivery of the packet or null if this information is not available.

Parameters:

from - the JID of the entity that originally sent the packet.

getStamp

public Date getStamp()

Returns the timestamp when the packet was originally sent. The returned Date is be understood as UTC.

Returns:

the timestamp when the packet was originally sent.

getReason

public String getReason()

Returns a natural-language description of the reason for the delay or null if this information is not available.

Returns:

a natural-language description of the reason for the delay or null.

setReason

public void setReason(String reason)

Sets a natural-language description of the reason for the delay or null if this information is not available.

Parameters:

reason - a natural-language description of the reason for the delay or null.

getElementName

public String getElementName()

Description copied from interface: PacketExtension

Returns the root element name.

Specified by:

getElementName in interface PacketExtension

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: PacketExtension

Returns the root element XML namespace.

Specified by:

getNamespace in interface PacketExtension

Returns:

the namespace.

toXML

public String toXML()

Description copied from interface: PacketExtension

Returns the XML representation of the PacketExtension.

Specified by:

toXML in interface PacketExtension

Returns:

the packet extension as XML.