org.jivesoftware.smackx.forward.packet

Class Forwarded

java.lang.Object

org.jivesoftware.smackx.forward.packet.Forwarded

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class Forwarded
extends java.lang.Object
implements ExtensionElement

Stanza extension for XEP-0297: Stanza Forwarding.

See Also:

XEP-0297: Stanza Forwarding

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
Forwarded(DelayInformation delay, Stanza fwdPacket) Creates a new Forwarded stanza(/packet) extension.
Forwarded(Stanza fwdPacket) Creates a new Forwarded stanza(/packet) extension.

Method Summary

Modifier and Type	Method and Description
static Forwarded	from(Stanza packet) Get the forwarded extension.
DelayInformation	getDelayInformation() get the timestamp of the forwarded packet.
java.lang.String	getElementName() Returns the root element name.
Stanza	getForwardedPacket() Deprecated. use @{link getForwardedStanza()} instead.
Stanza	getForwardedStanza() Get the forwarded Stanza found in this extension.
java.lang.String	getNamespace() Returns the root element XML namespace.
XmlStringBuilder	toXML() 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

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

Constructor Detail

Forwarded

public Forwarded(DelayInformation delay,
                 Stanza fwdPacket)

Creates a new Forwarded stanza(/packet) extension.

Parameters:

delay - an optional DelayInformation timestamp of the packet.

fwdPacket - the stanza(/packet) that is forwarded (required).

Forwarded

public Forwarded(Stanza fwdPacket)

Creates a new Forwarded stanza(/packet) extension.

Parameters:

fwdPacket - the stanza(/packet) that is forwarded (required).

Method Detail

getElementName

public java.lang.String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

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

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.

getForwardedPacket

@Deprecated
public Stanza getForwardedPacket()

Deprecated. use @{link getForwardedStanza()} instead.

get the stanza(/packet) forwarded by this stanza.

Returns:

the Stanza instance (typically a message) that was forwarded.

getForwardedStanza

public Stanza getForwardedStanza()

Get the forwarded Stanza found in this extension.

Returns:

the Stanza (typically a message) that was forwarded.

getDelayInformation

public DelayInformation getDelayInformation()

get the timestamp of the forwarded packet.

Returns:

the DelayInformation representing the time when the original stanza(/packet) was sent. May be null.

from

public static Forwarded from(Stanza packet)

Get the forwarded extension.

Parameters:

packet -

Returns:

the Forwarded extension or null