Package org.jivesoftware.smackx.softwareinfo.form

Class SoftwareInfoForm

java.lang.Object

org.jivesoftware.smackx.xdata.form.FilledForm

org.jivesoftware.smackx.softwareinfo.form.SoftwareInfoForm

All Implemented Interfaces:

FormReader

public final class SoftwareInfoForm
extends FilledForm

Form that contains the software information.
Instance of SoftwareInfoForm can be created using SoftwareInfoForm.Builder.build() method.
To obtain an instance of SoftwareInfoForm.Builder, use getBuilder() method.
An example to illustrate is provided inside SoftwareInfoFormTest inside the test package.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SoftwareInfoForm.Builder	Builder class for SoftwareInfoForm.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FORM_TYPE
static java.lang.String	ICON
static java.lang.String	OS
static java.lang.String	OS_VERSION
static java.lang.String	SOFTWARE
static java.lang.String	SOFTWARE_VERSION

Fields inherited from class org.jivesoftware.smackx.xdata.form.FilledForm

formTypeFormField

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static SoftwareInfoForm.Builder	getBuilder()	Returns a new instance of SoftwareInfoForm.Builder.
MediaElement	getIcon()	Returns the software icon if used by client.
java.lang.String	getOS()	Returns name of the OS used by client.
java.lang.String	getOSVersion()	Returns version of the OS used by client.
java.lang.String	getSoftwareName()	Returns name of the software used by client.
java.lang.String	getSoftwareVersion()	Returns version of the software used by client.
int	hashCode()

Methods inherited from class org.jivesoftware.smackx.xdata.form.FilledForm

ensureFormType, getDataForm, getField, getFieldOrThrow, getFormType, getInstructions, getTitle, hasField

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smackx.xdata.form.FormReader

readBoolean, readDate, readFirstValue, readInteger, readStringValues, readValues

Field Detail

FORM_TYPE

public static final java.lang.String FORM_TYPE

See Also:

Constant Field Values

OS

public static final java.lang.String OS

See Also:

Constant Field Values

OS_VERSION

public static final java.lang.String OS_VERSION

See Also:

Constant Field Values

SOFTWARE

public static final java.lang.String SOFTWARE

See Also:

Constant Field Values

SOFTWARE_VERSION

public static final java.lang.String SOFTWARE_VERSION

See Also:

Constant Field Values

ICON

public static final java.lang.String ICON

See Also:

Constant Field Values

Method Detail

getOS

public java.lang.String getOS()

Returns name of the OS used by client.

Returns:

os

getOSVersion

public java.lang.String getOSVersion()

Returns version of the OS used by client.

Returns:

os_version

getSoftwareName

public java.lang.String getSoftwareName()

Returns name of the software used by client.

Returns:

software

getSoftwareVersion

public java.lang.String getSoftwareVersion()

Returns version of the software used by client.

Returns:

software_version

getIcon

public MediaElement getIcon()

Returns the software icon if used by client.

Returns:

MediaElement MediaElement or null

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getBuilder

public static SoftwareInfoForm.Builder getBuilder()

Returns a new instance of SoftwareInfoForm.Builder.

Returns:

Builder