Android - An Open Handset Alliance Project

android.location
public abstract class

android.location.LocationProviderImpl

java.lang.Object
	android.location.LocationProvider
		android.location.LocationProviderImpl

An abstract superclass for location provider implementations. Location provider implementations are typically instantiated by the location manager service in the system process, and location information is made available to implementations via the manager.

Summary

Constants inherited from class android.location.LocationProvider

AVAILABLE, OUT_OF_SERVICE, TEMPORARILY_UNAVAILABLE

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

Protected Constructors

LocationProviderImpl(String name)

Public Methods

	static	void	addProvider(LocationProviderImpl provider)
abstract		void	disable()
			Disables this provider.
abstract		void	enable()
			Enables this provider.
abstract		Location	getLocation()
			Returns a Location object containing the information gathered during the most recent fix.
	static	LocationProviderImpl	getProvider(String name)
	static	List	getProviders()
abstract		int	getStatus()
			Returns a information on the status of this provider.
		void	updateCellState(CellState state)
			Updates the cell state for the given provider.
		void	updateNetworkState(int state)
			Updates the network state for the given provider.

Methods inherited from class android.location.LocationProvider

getAccuracy, getName, getPowerRequirement, hasMonetaryCost, meetsCriteria, requiresCell, requiresNetwork, requiresSatellite, supportsAltitude, supportsBearing, supportsSpeed

abstract	int	getAccuracy()
		Returns the horizontal accuracy of this provider in meters.
	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

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Protected Constructors

protected LocationProviderImpl(String name)

Public Methods

public static void addProvider(LocationProviderImpl provider)

public abstract void disable()

Disables this provider. When disabled, calls to getStatus() and getLocation() need not be handled. Hardware may be shut down while the provider is disabled.

public abstract void enable()

Enables this provider. When enabled, calls to getStatus() and getLocation() must be handled. Hardware may be started up when the provider is enabled.

public abstract Location getLocation()

Returns a Location object containing the information gathered during the most recent fix.

public static LocationProviderImpl getProvider(String name)

public static List getProviders()

public abstract int getStatus()

Returns a information on the status of this provider. OUT_OF_SERVICE is returned if the provider is out of service, and this is not expected to change in the near future; TEMPORARILY_UNAVAILABLE is returned if the provider is temporarily unavailable but is expected to be available shortly; and AVAILABLE is returned if the provider is currently available.

public void updateCellState(CellState state)

Updates the cell state for the given provider. This function must be overwritten if requiresCell() returns true.

Parameters

state	cell state

public void updateNetworkState(int state)

Updates the network state for the given provider. This function must be overwritten if requiresNetwork() returns true. It returns TEMPORARILY_UNAVAILABLE (connecting), OUT_OF_SERVICE (disconnected) OR AVAILABLE.

Parameters

state	data state

Android - An Open Handset Alliance Project

Documentation

Goodies

android.location.LocationProviderImpl

Summary

Constants inherited from class android.location.LocationProvider

Protected Constructors

Public Methods

Methods inherited from class android.location.LocationProvider

Methods inherited from class java.lang.Object

Details

Protected Constructors

protected LocationProviderImpl(String name)

Public Methods

public static void addProvider(LocationProviderImpl provider)

public abstract void disable()

public abstract void enable()

public abstract Location getLocation()

public static LocationProviderImpl getProvider(String name)

public static List getProviders()

public abstract int getStatus()

public void updateCellState(CellState state)

Parameters

public void updateNetworkState(int state)

Parameters


e.g. "intent" or "activity"