Android
android.location
public abstract class

android.location.LocationProvider

java.lang.Object
android.location.LocationProvider

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.

Summary

Constants

      Value  
int  AVAILABLE    0x00000002 
int  OUT_OF_SERVICE    0x00000000 
int  TEMPORARILY_UNAVAILABLE    0x00000001 

Public Methods

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

Details

Constants

public static final int AVAILABLE

Constant Value: 2 (0x00000002)

public static final int OUT_OF_SERVICE

Constant Value: 0 (0x00000000)

public static final int TEMPORARILY_UNAVAILABLE

Constant Value: 1 (0x00000001)

Public Methods

public abstract int getAccuracy()

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

public String getName()

Returns the name of this provider.

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_*.

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.

public boolean meetsCriteria(Criteria criteria)

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

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.

public abstract boolean requiresNetwork()

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

public abstract boolean requiresSatellite()

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

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.

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.

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.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48