android.location
Class LocationProvider

java.lang.Object
  android.location.LocationProvider

Direct Known Subclasses:

DummyLocationProvider, LocationProviderImpl

public abstract class LocationProvider
extends Object

An abstract superclass for location providers. A location provider provides periodic reports on the geographical location of the device.

Each provider has a set of criteria under which it may be used; for example, some providers require GPS hardware and visibility to a number of satellites; others require the use of the cellular radio, or access to a specific carrier's network, or to the internet. They may also have different battery consumption characteristics or monetary costs to the user. The Criteria class allows providers to be selected based on user-specified criteria.

Field Summary

static int	AVAILABLE
(package private) static String	BAD_CHARS_REGEX
static int	OUT_OF_SERVICE
static int	TEMPORARILY_UNAVAILABLE

Constructor Summary

LocationProvider(String name)
Constructs a LocationProvider with the given name.

Method Summary

abstract int	getAccuracy() Returns a constant describing horizontal accuracy of this provider.
String	getName() Returns the name of this provider.
abstract int	getPowerRequirement() Returns the power requirement for this provider.
abstract boolean	hasMonetaryCost() Returns true if the use of this provider may result in a monetary charge to the user, false if use is free.
boolean	meetsCriteria(Criteria criteria) Returns true if this provider meets the given criteria, false otherwise.
abstract boolean	requiresCell() Returns true if the provider requires access to an appropriate cellular network (e.g., to make use of cell tower IDs), false otherwise.
abstract boolean	requiresNetwork() Returns true if the provider requires access to a data network (e.g., the Internet), false otherwise.
abstract boolean	requiresSatellite() Returns true if the provider requires access to a satellite-based positioning system (e.g., GPS), false otherwise.
abstract boolean	supportsAltitude() Returns true if the provider is able to provide altitude information, false otherwise.
abstract boolean	supportsBearing() Returns true if the provider is able to provide bearing information, false otherwise.
abstract boolean	supportsSpeed() Returns true if the provider is able to provide speed information, false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

BAD_CHARS_REGEX

static final String BAD_CHARS_REGEX

See Also:

Constant Field Values

OUT_OF_SERVICE

public static final int OUT_OF_SERVICE

See Also:

Constant Field Values

TEMPORARILY_UNAVAILABLE

public static final int TEMPORARILY_UNAVAILABLE

See Also:

Constant Field Values

AVAILABLE

public static final int AVAILABLE

See Also:

Constant Field Values

Constructor Detail

LocationProvider

LocationProvider(String name)

Constructs a LocationProvider with the given name. Provider names must consist only of the characters [a-zA-Z0-9].

Throws:

IllegalArgumentException - if name contains an illegal character

Method Detail

getName

public String getName()

Returns the name of this provider.

meetsCriteria

public boolean meetsCriteria(Criteria criteria)

Returns true if this provider meets the given criteria, false otherwise.

requiresNetwork

public abstract boolean requiresNetwork()

Returns true if the provider requires access to a data network (e.g., the Internet), false otherwise.

requiresSatellite

public abstract boolean requiresSatellite()

Returns true if the provider requires access to a satellite-based positioning system (e.g., GPS), false otherwise.

requiresCell

public abstract boolean requiresCell()

Returns true if the provider requires access to an appropriate cellular network (e.g., to make use of cell tower IDs), false otherwise.

hasMonetaryCost

public abstract boolean hasMonetaryCost()

Returns true if the use of this provider may result in a monetary charge to the user, false if use is free. It is up to each provider to give accurate information.

supportsAltitude

public abstract boolean supportsAltitude()

Returns true if the provider is able to provide altitude information, false otherwise. A provider that reports altitude under most circumstances but may occassionally not report it should return true.

supportsSpeed

public abstract boolean supportsSpeed()

Returns true if the provider is able to provide speed information, false otherwise. A provider that reports speed under most circumstances but may occassionally not report it should return true.

supportsBearing

public abstract boolean supportsBearing()

Returns true if the provider is able to provide bearing information, false otherwise. A provider that reports bearing under most circumstances but may occassionally not report it should return true.

getPowerRequirement

public abstract int getPowerRequirement()

Returns the power requirement for this provider.

Returns:

the power requirement for this provider, as one of the constants Criteria.POWER_REQUIREMENT_*.

getAccuracy

public abstract int getAccuracy()

Returns a constant describing horizontal accuracy of this provider. If the provider returns finer grain or exact location, Criteria.ACCURACY_FINE is returned, otherwise if the location is only approximate then Criteria.ACCURACY_COARSE is returned.