Package org.jivesoftware.smackx.geoloc.packet

Class GeoLocation

java.lang.Object

org.jivesoftware.smackx.geoloc.packet.GeoLocation

All Implemented Interfaces:

Serializable, Element, ExtensionElement, NamedElement, XmlElement, XmlLangElement, FormFieldChildElement

public final class GeoLocation
extends Object
implements Serializable, ExtensionElement, FormFieldChildElement

A GeoLocation Extension packet, which is used by the XMPP clients to exchange their respective geographic locations.

See Also:

• XEP-0080
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GeoLocation.Builder	This class defines a builder class for GeoLocation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT
static final GeoLocation	EMPTY_GEO_LOCATION
static final String	NAMESPACE
static final QName	QNAME

Method Summary

Modifier and Type	Method	Description
static GeoLocation.Builder	builder()	Returns a new instance of GeoLocation.Builder.
boolean	equals(Object obj)
static GeoLocation	from(Message message)	Returns the first GeoLocation, or null if it doesn't exist in Message.
static GeoLocation	from(FormField formField)	Returns the first GeoLocation, or null if it doesn't exist in FormField.
Double	getAccuracy()
Double	getAlt()
Double	getAltAccuracy()
String	getArea()
Double	getBearing()
String	getBuilding()
String	getCountry()
String	getCountryCode()
String	getDatum()
String	getDescription()
String	getElementName()	Returns the root element name.
Double	getError()	Deprecated. use getAccuracy() instead.
String	getFloor()
Double	getLat()
String	getLocality()
Double	getLon()
String	getNamespace()	Returns the root element XML namespace.
String	getPostalcode()
QName	getQName()
String	getRegion()
String	getRoom()
Double	getSpeed()
String	getStreet()
String	getText()
Date	getTimestamp()
String	getTzo()
URI	getUri()
int	hashCode()
boolean	isExclusiveElement()
CharSequence	toXML(XmlEnvironment enclosingNamespace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smackx.xdata.FormFieldChildElement

checkConsistency, mustBeOnlyOfHisKind, requiresNoTypeSet, validate

Methods inherited from interface org.jivesoftware.smack.packet.XmlElement

getLanguage

Field Details

NAMESPACE

public static final String NAMESPACE

See Also:

• Constant Field Values

ELEMENT

public static final String ELEMENT

See Also:

• Constant Field Values

QNAME

public static final QName QNAME

EMPTY_GEO_LOCATION

public static final GeoLocation EMPTY_GEO_LOCATION

Method Details

getAccuracy

public Double getAccuracy()

getAlt

public Double getAlt()

getAltAccuracy

public Double getAltAccuracy()

getArea

public String getArea()

getBearing

public Double getBearing()

getBuilding

public String getBuilding()

getCountry

public String getCountry()

getCountryCode

public String getCountryCode()

getDatum

public String getDatum()

getDescription

public String getDescription()

getError

@Deprecated
public Double getError()

Deprecated.

use getAccuracy() instead.

Get the error.

Returns:

the error.

getFloor

public String getFloor()

getLat

public Double getLat()

getLocality

public String getLocality()

getLon

public Double getLon()

getPostalcode

public String getPostalcode()

getRegion

public String getRegion()

getRoom

public String getRoom()

getSpeed

public Double getSpeed()

getStreet

public String getStreet()

getText

public String getText()

getTimestamp

public Date getTimestamp()

getTzo

public String getTzo()

getUri

public URI getUri()

getQName

public QName getQName()

Specified by:

getQName in interface XmlElement

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

toXML

public CharSequence toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element

getNamespace

public String getNamespace()

Description copied from interface: XmlElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface XmlElement

Returns:

the namespace.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

builder

public static GeoLocation.Builder builder()

Returns a new instance of GeoLocation.Builder.

Returns:

Builder

isExclusiveElement

public boolean isExclusiveElement()

Specified by:

isExclusiveElement in interface FormFieldChildElement

from

public static GeoLocation from(Message message)

Returns the first GeoLocation, or null if it doesn't exist in Message.

Parameters:

message - The Message stanza containing GeoLocation

Returns:

GeoLocation

from

public static GeoLocation from(FormField formField)

Returns the first GeoLocation, or null if it doesn't exist in FormField.

Parameters:

formField - the Formfield containing GeoLocation

Returns:

GeoLocation