Class Forwarded<S extends org.jivesoftware.smack.packet.Stanza>
- java.lang.Object
-
- org.jivesoftware.smackx.forward.packet.Forwarded<S>
-
- All Implemented Interfaces:
org.jivesoftware.smack.packet.Element
,org.jivesoftware.smack.packet.ExtensionElement
,org.jivesoftware.smack.packet.FullyQualifiedElement
,org.jivesoftware.smack.packet.NamedElement
,org.jivesoftware.smack.packet.XmlLangElement
public class Forwarded<S extends org.jivesoftware.smack.packet.Stanza> extends java.lang.Object implements org.jivesoftware.smack.packet.ExtensionElement
Stanza extension for XEP-0297: Stanza Forwarding.- See Also:
- XEP-0297: Stanza Forwarding
-
-
Constructor Summary
Constructors Constructor Description Forwarded(DelayInformation delay, S forwardedStanza)
Deprecated.useForwarded(Stanza, DelayInformation)
instead.Forwarded(S fwdPacket)
Creates a new Forwarded stanza extension.Forwarded(S forwardedStanza, DelayInformation delay)
Creates a new Forwarded stanza extension.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.util.List<org.jivesoftware.smack.packet.Message>
extractMessagesFrom(java.util.Collection<Forwarded<org.jivesoftware.smack.packet.Message>> forwardedCollection)
Extract messages in a collection of forwarded elements.static Forwarded<?>
from(org.jivesoftware.smack.packet.Stanza packet)
Get the forwarded extension.DelayInformation
getDelayInformation()
get the timestamp of the forwarded packet.java.lang.String
getElementName()
S
getForwardedStanza()
Get the forwarded Stanza found in this extension.java.lang.String
getNamespace()
boolean
isForwarded(java.lang.Class<? extends org.jivesoftware.smack.packet.Stanza> stanzaClass)
Check if this is forwarding a stanza of the provided class.org.jivesoftware.smack.util.XmlStringBuilder
toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
-
-
-
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
-
QNAME
public static final javax.xml.namespace.QName QNAME
-
-
Constructor Detail
-
Forwarded
@Deprecated public Forwarded(DelayInformation delay, S forwardedStanza)
Deprecated.useForwarded(Stanza, DelayInformation)
instead.Creates a new Forwarded stanza extension.- Parameters:
delay
- an optionalDelayInformation
timestamp of the packet.forwardedStanza
- the stanza that is forwarded (required).
-
Forwarded
public Forwarded(S fwdPacket)
Creates a new Forwarded stanza extension.- Parameters:
fwdPacket
- the stanza that is forwarded (required).
-
Forwarded
public Forwarded(S forwardedStanza, DelayInformation delay)
Creates a new Forwarded stanza extension.- Parameters:
forwardedStanza
- the stanza that is forwarded (required).delay
- an optionalDelayInformation
timestamp of the packet.
-
-
Method Detail
-
getElementName
public java.lang.String getElementName()
- Specified by:
getElementName
in interfaceorg.jivesoftware.smack.packet.NamedElement
-
getNamespace
public java.lang.String getNamespace()
- Specified by:
getNamespace
in interfaceorg.jivesoftware.smack.packet.FullyQualifiedElement
-
toXML
public org.jivesoftware.smack.util.XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
- Specified by:
toXML
in interfaceorg.jivesoftware.smack.packet.Element
-
getForwardedStanza
public S 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.
-
isForwarded
public boolean isForwarded(java.lang.Class<? extends org.jivesoftware.smack.packet.Stanza> stanzaClass)
Check if this is forwarding a stanza of the provided class.- Parameters:
stanzaClass
- the class to check for.- Returns:
true
if this is forwarding a stanza of the provided class.- Since:
- 4.4
-
from
public static Forwarded<?> from(org.jivesoftware.smack.packet.Stanza packet)
Get the forwarded extension.- Parameters:
packet
- TODO javadoc me please- Returns:
- the Forwarded extension or null
-
extractMessagesFrom
public static java.util.List<org.jivesoftware.smack.packet.Message> extractMessagesFrom(java.util.Collection<Forwarded<org.jivesoftware.smack.packet.Message>> forwardedCollection)
Extract messages in a collection of forwarded elements. Note that it is required that theForwarded
in the given collection only containMessage
stanzas.- Parameters:
forwardedCollection
- the collection to extract from.- Returns:
- a list a the extracted messages.
- Since:
- 4.3.0
-
-