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 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 String	ELEMENT
static String	NAMESPACE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static List<Message>	extractMessagesFrom(Collection<Forwarded> forwardedCollection) Extract messages in a collection of forwarded elements.
static Forwarded	from(Stanza packet) Get the forwarded extension.
DelayInformation	getDelayInformation() get the timestamp of the forwarded packet.
String	getElementName() Returns the root element name.
Stanza	getForwardedPacket() Deprecated. use @{link getForwardedStanza()} instead.
Stanza	getForwardedStanza() Get the forwarded Stanza found in this extension.
String	getNamespace() Returns the root element XML namespace.
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

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

Forwarded

public Forwarded(DelayInformation delay,
                 Stanza fwdPacket)

Creates a new Forwarded stanza extension.

Parameters:

delay - an optional DelayInformation timestamp of the packet.

fwdPacket - the stanza that is forwarded (required).

Forwarded

public Forwarded(Stanza fwdPacket)

Creates a new Forwarded stanza extension.

Parameters:

fwdPacket - the stanza that is forwarded (required).

Method Detail

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.

getForwardedPacket

@Deprecated
public Stanza getForwardedPacket()

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

get the stanza 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 was sent. May be null.

from

public static Forwarded from(Stanza packet)

Get the forwarded extension.

Parameters:

packet -

Returns:

the Forwarded extension or null

extractMessagesFrom

public static List<Message> extractMessagesFrom(Collection<Forwarded> forwardedCollection)

Extract messages in a collection of forwarded elements. Note that it is required that the Forwarded in the given collection only contain Message stanzas.

Parameters:

forwardedCollection - the collection to extract from.

Returns:

a list a the extracted messages.

Since:

4.3.0