org.jivesoftware.smackx.iqversion.packet

Class Version

java.lang.Object

org.jivesoftware.smack.packet.Stanza

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.iqversion.packet.Version

All Implemented Interfaces:

Element, Packet, TopLevelStreamElement

public class Version
extends IQ

A Version IQ packet, which is used by XMPP clients to discover version information about the software running at another entity's JID.

Author:

Gaston Dombiak

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.IQChildElementXmlStringBuilder, IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Fields inherited from class org.jivesoftware.smack.packet.IQ

IQ_ELEMENT, QUERY_ELEMENT

Fields inherited from class org.jivesoftware.smack.packet.Stanza

DEFAULT_LANGUAGE, ITEM, language, TEXT

Constructor Summary

Constructors

Constructor and Description
Version()
Version(String to) Request version IQ
Version(String name, String version)
Version(String name, String version, String os) Creates a new Version object with given details.
Version(Version original)

Method Summary

Modifier and Type	Method and Description
static Version	createResultFor(Stanza request, Version version)
protected IQ.IQChildElementXmlStringBuilder	getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml) This method must be overwritten by IQ subclasses to create their child content.
String	getName() Returns the natural-language name of the software.
String	getOs() Returns the operating system of the queried entity.
String	getVersion() Returns the specific version of the software.
void	setOs(String os) Sets the operating system of the queried entity.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementXML, getType, isRequestIQ, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Stanza

addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensions, getExtensionsXML, getFrom, getLanguage, getPacketID, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, overrideExtension, removeExtension, removeExtension, setError, setFrom, setLanguage, setPacketID, setStanzaId, setTo, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Version

public Version()

Version

public Version(String to)

Request version IQ

Parameters:

to - the jid where to request version from

Version

public Version(String name,
               String version)

Version

public Version(String name,
               String version,
               String os)

Creates a new Version object with given details.

Parameters:

name - The natural-language name of the software. This element is REQUIRED.

version - The specific version of the software. This element is REQUIRED.

os - The operating system of the queried entity. This element is OPTIONAL.

Version

public Version(Version original)

Method Detail

getName

public String getName()

Returns the natural-language name of the software. This property will always be present in a result.

Returns:

the natural-language name of the software.

getVersion

public String getVersion()

Returns the specific version of the software. This property will always be present in a result.

Returns:

the specific version of the software.

getOs

public String getOs()

Returns the operating system of the queried entity. This property will always be present in a result.

Returns:

the operating system of the queried entity.

setOs

public void setOs(String os)

Sets the operating system of the queried entity. This message should only be invoked when parsing the XML and setting the property to a Version instance.

Parameters:

os - operating system of the queried entity.

getIQChildElementBuilder

protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)

Description copied from class: IQ

This method must be overwritten by IQ subclasses to create their child content. It is important that the builder does not include the final end element. This will be done automatically by IQChildelementXmlStringBuilder after eventual existing stanza(/packet) extensions have been added.

For example to create an IQ with a extra attribute and an additional child element

 
 <iq to='foo@example.org' id='123'>
   <bar xmlns='example:bar' extraAttribute='blaz'>
      <extraElement>elementText</extraElement>
   </bar>
 </iq>
 
 

the body of the getIQChildElementBuilder looks like

 
 // The builder 'xml' will already have the child element and the 'xmlns' attribute added
 // So the current builder state is "<bar xmlns='example:bar'"
 xml.attribute("extraAttribute", "blaz");
 xml.rightAngleBracket();
 xml.element("extraElement", "elementText");
 // Do not close the 'bar' attribute by calling xml.closeElement('bar')
 
 

If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such.

 xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
 

If your IQ does not contain any attributes or child elements (besides stanza(/packet) extensions), consider sub-classing SimpleIQ instead.

Specified by:

getIQChildElementBuilder in class IQ

Parameters:

xml - a pre-created builder which already has the child element and the 'xmlns' attribute set.

Returns:

the build to create the IQ child content.

createResultFor

public static Version createResultFor(Stanza request,
                                      Version version)