org.jivesoftware.smackx.delay.packet

Class DelayInformation

java.lang.Object

org.jivesoftware.smackx.delay.packet.DelayInformation

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class DelayInformation
extends Object
implements ExtensionElement

Represents timestamp information about data stored for later delivery. A DelayInformation will always includes the timestamp when the stanza was originally sent and may include more information such as the JID of the entity that originally sent the stanza 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 String	ELEMENT
static String	NAMESPACE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DelayInformation	from(Stanza packet) Return delay information from the given stanza.
String	getElementName() Returns the root element name.
String	getFrom() Returns the JID of the entity that originally sent the stanza or that delayed the delivery of the stanza or null if this information is not available.
static DelayInformation	getFrom(Stanza packet) Deprecated. use from(Stanza) instead
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 stanza was originally sent.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

DelayInformation

public DelayInformation(Date stamp,
                        String from,
                        String reason)

Creates a new instance with the specified timestamp.

Parameters:

stamp - the timestamp

from - sender

reason - reason of delay.

DelayInformation

public DelayInformation(Date stamp)

Method Detail

getFrom

public String getFrom()

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

Returns:

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

getStamp

public Date getStamp()

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

Returns:

the timestamp when the stanza 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.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

getFrom

@Deprecated
public static DelayInformation getFrom(Stanza packet)

Deprecated. use from(Stanza) instead

Return delay information from the given stanza.

Parameters:

packet -

Returns:

the DelayInformation or null

from

public static DelayInformation from(Stanza packet)

Return delay information from the given stanza.

Parameters:

packet -

Returns:

the DelayInformation or null