GeoLocation (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.extensions.geoloc.model.GeoLocation

```
public final class GeoLocation
extends Object
```
The implementation of the <geoloc/> element in the http://jabber.org/protocol/geoloc namespace.
This class represents the geological location of a user.

4. Recommended Transport

Location information about human users SHOULD be communicated and transported by means of Publish-Subscribe (XEP-0060) [5] or the subset thereof specified in Personal Eventing Protocol (XEP-0163) [6].

Although the XMPP publish-subscribe extension is the preferred means for transporting location information about human users, applications that do not involve human users (e.g., device tracking) MAY use other transport methods; however, because location information is not pure presence information and can change independently of network availability, it SHOULD NOT be provided as an extension to <presence/>.

Usage
This class is immutable, you have to use a builder to create a geo location instance. Here's an example:
```
 GeoLocation geoLocation = GeoLocation.builder()
     .countryCode("de")
     .latitude(50.2)
     .longitude(7.5)
     .timeZone(TimeZone.getTimeZone("GMT+1"))
     .build();
 
 
```
See Also:
XEP-0080: User Location, XML Schema

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GeoLocation.Builder
A builder class to which builds geo location objects.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GeoLocation.Builder` A builder class to which builds geo location objects.

Field Summary

Fields
Modifier and Type Field and Description

static String NAMESPACE
http://jabber.org/protocol/geoloc

Fields
Modifier and Type	Field and Description
`static String`	`NAMESPACE` http://jabber.org/protocol/geoloc

Constructor Summary

Constructors
Constructor and Description
`GeoLocation()` Creates an empty geolocation element.
`GeoLocation(double latitude, double longitude)` Deprecated. Use the builder to create an instance of this class.

Method Summary

Methods
Modifier and Type	Method and Description
`static GeoLocation.Builder`	`builder()` Creates the builder to build a geo location.
`Double`	`getAccuracy()` Gets the horizontal GPS error in meters.
`Double`	`getAltitude()` Gets the altitude in meters above or below sea level.
`String`	`getArea()` Gets a named area such as a campus or neighborhood.
`Double`	`getBearing()` Gets the GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
`String`	`getBuilding()` Gets a specific building on a street or in an area.
`String`	`getCountry()` Gets the nation where the user is located.
`String`	`getCountryCode()` Gets the ISO 3166 two-letter country code.
`String`	`getDatum()` Gets the GPS datum.
`String`	`getDescription()` Gets a natural-language name for or description of the location.
`String`	`getFloor()` Gets a particular floor in a building.
`String`	`getLanguage()` Gets the the natural language of location data.
`Double`	`getLatitude()` Gets the latitude in decimal degrees North.
`String`	`getLocality()` Gets a locality within the administrative region, such as a town or city.
`Double`	`getLongitude()` Gets the longitude in decimal degrees East.
`String`	`getPostalCode()` Gets a code used for postal delivery.
`String`	`getRegion()` Gets an administrative region of the nation, such as a state or province.
`String`	`getRoom()` Gets a particular room in a building.
`Double`	`getSpeed()` Gets the speed at which the entity is moving, in meters per second.
`String`	`getStreet()` Gets a thoroughfare within the locality, or a crossing of two thoroughfares.
`String`	`getText()` Gets a catch-all element that captures any other information about the location.
`Date`	`getTimestamp()` Gets the UTC timestamp specifying the moment when the reading was taken.
`TimeZone`	`getTimeZone()` Gets the time zone offset from UTC for the current location.
`URI`	`getUri()` Gets a URI or URL pointing to information about the location.
`void`	`setAccuracy(Double accuracy)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setAltitude(Double altitude)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setArea(String area)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setBearing(Double bearing)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setBuilding(String building)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setCountry(String country)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setCountryCode(String countryCode)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setDatum(String datum)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setDescription(String description)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setFloor(String floor)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setLanguage(String language)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setLatitude(Double latitude)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setLocality(String locality)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setLongitude(Double longitude)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setPostalCode(String postalCode)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setRegion(String region)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setRoom(String room)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setSpeed(Double speed)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setStreet(String street)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setText(String text)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setTimestamp(Date timestamp)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setTimeZone(TimeZone timeZone)` Deprecated. Use `GeoLocation.Builder`.
`void`	`setUri(URI uri)` Deprecated. Use `GeoLocation.Builder`.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    http://jabber.org/protocol/geoloc
    
    See Also:
    Constant Field Values
- Constructor Detail
  - GeoLocation
```
public GeoLocation()
```
    Creates an empty geolocation element.
  - GeoLocation
```
@Deprecated
public GeoLocation(double latitude,
                      double longitude)
```
    Deprecated. Use the builder to create an instance of this class.
    
    Parameters:
    latitude - The latitude.
    longitude - The longitude.
- Method Detail
  - builder
```
public static GeoLocation.Builder builder()
```
    Creates the builder to build a geo location.
    
    Returns:
    The builder.
  - getAccuracy
```
public final Double getAccuracy()
```
    Gets the horizontal GPS error in meters.
    
    Returns:
    The accuracy.
    See Also:
    setAccuracy(Double)
  - setAccuracy
```
@Deprecated
public void setAccuracy(Double accuracy)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the horizontal GPS error in meters.
    
    Parameters:
    accuracy - The accuracy.
    See Also:
    getAccuracy()
  - getAltitude
```
public final Double getAltitude()
```
    Gets the altitude in meters above or below sea level.
    
    Returns:
    The altitude.
    See Also:
    setAltitude(Double)
  - setAltitude
```
@Deprecated
public void setAltitude(Double altitude)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the altitude in meters above or below sea level.
    
    Parameters:
    altitude - The altitude.
    See Also:
    getAltitude()
  - getArea
```
public final String getArea()
```
    Gets a named area such as a campus or neighborhood.
    
    Returns:
    The area.
    See Also:
    setArea(String)
  - setArea
```
@Deprecated
public void setArea(String area)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a named area such as a campus or neighborhood.
    
    Parameters:
    area - The area.
    See Also:
    getArea()
  - getBearing
```
public final Double getBearing()
```
    Gets the GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
    
    Returns:
    The bearing.
    See Also:
    setBearing(Double)
  - setBearing
```
@Deprecated
public void setBearing(Double bearing)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the GPS bearing (direction in which the entity is heading to reach its next waypoint), measured in decimal degrees relative to true north.
    
    Parameters:
    bearing - The bearing.
    See Also:
    getBearing()
  - getBuilding
```
public final String getBuilding()
```
    Gets a specific building on a street or in an area.
    
    Returns:
    The building.
    See Also:
    setBuilding(String)
  - setBuilding
```
@Deprecated
public void setBuilding(String building)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a specific building on a street or in an area.
    
    Parameters:
    building - The building.
    See Also:
    getBuilding()
  - getCountry
```
public final String getCountry()
```
    Gets the nation where the user is located.
    
    Returns:
    The country.
    See Also:
    setCountry(String)
  - setCountry
```
@Deprecated
public void setCountry(String country)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the nation where the user is located.
    
    Parameters:
    country - The country.
    See Also:
    getCountry()
  - getCountryCode
```
public final String getCountryCode()
```
    Gets the ISO 3166 two-letter country code.
    
    Returns:
    The country code.
    See Also:
    setCountryCode(String)
  - setCountryCode
```
@Deprecated
public void setCountryCode(String countryCode)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the ISO 3166 two-letter country code.
    
    Parameters:
    countryCode - The country code.
    See Also:
    getCountryCode()
  - getDatum
```
public final String getDatum()
```
    Gets the GPS datum.
    
    Returns:
    The GPS datum.
    See Also:
    setDatum(String)
  - setDatum
```
@Deprecated
public void setDatum(String datum)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the GPS datum.
    
    Parameters:
    datum - The GPS datum.
    See Also:
    getDatum()
  - getDescription
```
public final String getDescription()
```
    Gets a natural-language name for or description of the location.
    
    Returns:
    The description.
    See Also:
    setDescription(String)
  - setDescription
```
@Deprecated
public void setDescription(String description)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a natural-language name for or description of the location.
    
    Parameters:
    description - The description.
    See Also:
    getDescription()
  - getFloor
```
public final String getFloor()
```
    Gets a particular floor in a building.
    
    Returns:
    The floor.
    See Also:
    setFloor(String)
  - setFloor
```
@Deprecated
public void setFloor(String floor)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a particular floor in a building.
    
    Parameters:
    floor - The floor.
    See Also:
    getFloor()
  - getLatitude
```
public final Double getLatitude()
```
    Gets the latitude in decimal degrees North.
    
    Returns:
    The latitude.
    See Also:
    setLatitude(Double)
  - setLatitude
```
@Deprecated
public void setLatitude(Double latitude)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the latitude in decimal degrees North.
    
    Parameters:
    latitude - The latitude.
    See Also:
    getLatitude()
  - getLocality
```
public final String getLocality()
```
    Gets a locality within the administrative region, such as a town or city.
    
    Returns:
    The locality.
    See Also:
    setLocality(String)
  - setLocality
```
@Deprecated
public void setLocality(String locality)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a locality within the administrative region, such as a town or city.
    
    Parameters:
    locality - The locality.
    See Also:
    getLocality()
  - getLongitude
```
public final Double getLongitude()
```
    Gets the longitude in decimal degrees East.
    
    Returns:
    The longitude.
    See Also:
    setLongitude(Double)
  - setLongitude
```
@Deprecated
public void setLongitude(Double longitude)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the longitude in decimal degrees East.
    
    Parameters:
    longitude - The longitude.
    See Also:
    getLongitude()
  - getPostalCode
```
public final String getPostalCode()
```
    Gets a code used for postal delivery.
    
    Returns:
    The postal code.
    See Also:
    setPostalCode(String)
  - setPostalCode
```
@Deprecated
public void setPostalCode(String postalCode)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a code used for postal delivery.
    
    Parameters:
    postalCode - The postal code.
    See Also:
    getPostalCode()
  - getRegion
```
public final String getRegion()
```
    Gets an administrative region of the nation, such as a state or province.
    
    Returns:
    The region.
    See Also:
    setRegion(String)
  - setRegion
```
@Deprecated
public void setRegion(String region)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets an administrative region of the nation, such as a state or province.
    
    Parameters:
    region - The region.
    See Also:
    getRegion()
  - getRoom
```
public final String getRoom()
```
    Gets a particular room in a building.
    
    Returns:
    The room.
    See Also:
    setRoom(String)
  - setRoom
```
@Deprecated
public void setRoom(String room)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a particular room in a building.
    
    Parameters:
    room - The room.
    See Also:
    getRoom()
  - getSpeed
```
public final Double getSpeed()
```
    Gets the speed at which the entity is moving, in meters per second.
    
    Returns:
    The speed.
    See Also:
    setSpeed(Double)
  - setSpeed
```
@Deprecated
public void setSpeed(Double speed)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the speed at which the entity is moving, in meters per second.
    
    Parameters:
    speed - The speed.
    See Also:
    getSpeed()
  - getStreet
```
public final String getStreet()
```
    Gets a thoroughfare within the locality, or a crossing of two thoroughfares.
    
    Returns:
    The street.
    See Also:
    setStreet(String)
  - setStreet
```
@Deprecated
public void setStreet(String street)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a thoroughfare within the locality, or a crossing of two thoroughfares.
    
    Parameters:
    street - The street.
    See Also:
    setStreet(String)
  - getText
```
public final String getText()
```
    Gets a catch-all element that captures any other information about the location.
    
    Returns:
    The text.
    See Also:
    setText(String)
  - setText
```
@Deprecated
public void setText(String text)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a catch-all element that captures any other information about the location.
    
    Parameters:
    text - The text.
    See Also:
    getText()
  - getTimestamp
```
public final Date getTimestamp()
```
    Gets the UTC timestamp specifying the moment when the reading was taken.
    
    Returns:
    The timestamp.
    See Also:
    setTimestamp(java.util.Date)
  - setTimestamp
```
@Deprecated
public void setTimestamp(Date timestamp)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the UTC timestamp specifying the moment when the reading was taken.
    
    Parameters:
    timestamp - The timestamp.
    See Also:
    getTimestamp()
  - getUri
```
public final URI getUri()
```
    Gets a URI or URL pointing to information about the location.
    
    Returns:
    The URI.
    See Also:
    setUri(java.net.URI)
  - setUri
```
@Deprecated
public void setUri(URI uri)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets a URI or URL pointing to information about the location.
    
    Parameters:
    uri - The URI.
    See Also:
    getUri()
  - getLanguage
```
public final String getLanguage()
```
    Gets the the natural language of location data.
    
    Returns:
    The language.
    See Also:
    setLanguage(String)
  - setLanguage
```
@Deprecated
public void setLanguage(String language)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the natural language of location data.
    
    Parameters:
    language - The language.
    See Also:
    getLanguage()
  - getTimeZone
```
public final TimeZone getTimeZone()
```
    Gets the time zone offset from UTC for the current location.
    
    Returns:
    The time zone.
  - setTimeZone
```
@Deprecated
public void setTimeZone(TimeZone timeZone)
```
    Deprecated. Use GeoLocation.Builder.
    
    Sets the time zone offset from UTC for the current location.
    
    Parameters:
    timeZone - The time zone.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class GeoLocation

Usage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

Constructor Detail

GeoLocation

GeoLocation

Method Detail

builder

getAccuracy

setAccuracy

getAltitude

setAltitude

getArea

setArea

getBearing

setBearing

getBuilding

setBuilding

getCountry

setCountry

getCountryCode

setCountryCode

getDatum

setDatum

getDescription

setDescription

getFloor

setFloor

getLatitude

setLatitude

getLocality

setLocality

getLongitude

setLongitude

getPostalCode

setPostalCode

getRegion

setRegion

getRoom

setRoom

getSpeed

setSpeed

getStreet

setStreet

getText

setText

getTimestamp

setTimestamp

getUri

setUri

getLanguage

setLanguage

getTimeZone

setTimeZone

toString