org.jivesoftware.smackx.packet

Class DelayInformation

java.lang.Object

org.jivesoftware.smackx.packet.DelayInformation

All Implemented Interfaces:

PacketExtension

public class DelayInformation
extends java.lang.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 dealy.

For more information see JEP-91.

Author:

Gaston Dombiak

Field Summary

Fields

Modifier and Type	Field and Description
static java.text.SimpleDateFormat	NEW_UTC_FORMAT New date format based on JEP-82 that some clients may use when sending delayed dates.
static java.text.SimpleDateFormat	UTC_FORMAT

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getElementName() Returns the root element name.
java.lang.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.
java.lang.String	getNamespace() Returns the root element XML namespace.
java.lang.String	getReason() Returns a natural-language description of the reason for the delay or null if this information is not available.
java.util.Date	getStamp() Returns the timstamp when the packet was originally sent.
void	setFrom(java.lang.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(java.lang.String reason) Sets a natural-language description of the reason for the delay or null if this information is not available.
java.lang.String	toXML() Returns the XML reppresentation of the PacketExtension.

Methods inherited from class java.lang.Object

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

Field Detail

UTC_FORMAT

public static java.text.SimpleDateFormat UTC_FORMAT

NEW_UTC_FORMAT

public static java.text.SimpleDateFormat NEW_UTC_FORMAT

New date format based on JEP-82 that some clients may use when sending delayed dates. JEP-91 is using a SHOULD other servers or clients may be using this format instead of the old UTC format.

Constructor Detail

DelayInformation

public DelayInformation(java.util.Date stamp)

Creates a new instance with the specified timestamp.

Method Detail

getFrom

public java.lang.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(java.lang.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 java.util.Date getStamp()

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

Returns:

the timstamp when the packet was originally sent.

getReason

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

Description copied from interface: PacketExtension

Returns the root element name.

Specified by:

getElementName in interface PacketExtension

Returns:

the element name.

getNamespace

public java.lang.String getNamespace()

Description copied from interface: PacketExtension

Returns the root element XML namespace.

Specified by:

getNamespace in interface PacketExtension

Returns:

the namespace.

toXML

public java.lang.String toXML()

Description copied from interface: PacketExtension

Returns the XML reppresentation of the PacketExtension.

Specified by:

toXML in interface PacketExtension

Returns:

the packet extension as XML.