Package org.robolectric.shadows

Class ShadowLocationManager

java.lang.Object

org.robolectric.shadows.ShadowLocationManager

@Implements(value=android.location.LocationManager.class,
            looseSignatures=true)
public class ShadowLocationManager
extends Object

Shadow for LocationManager. Note that the default state of location on Android devices is location on, gps provider enabled, network provider disabled.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ShadowLocationManager.ProviderProperties	Properties of a provider.

Constructor Summary

Constructors

Constructor	Description
ShadowLocationManager()

Method Summary

Modifier and Type	Method	Description
protected boolean	addGpsStatusListener(GpsStatus.Listener listener)
protected boolean	addNmeaListener(OnNmeaMessageListener listener, Handler handler)
protected List<String>	getAllProviders()
protected String	getBestProvider(Criteria criteria, boolean enabled)
List<GpsStatus.Listener>	getGpsStatusListeners()
protected Location	getLastKnownLocation(String provider)
List<LocationListener>	getLocationUpdateListeners()	Deprecated. Do not test listeners, instead use simulateLocation(Location) and test the results of those listeners being invoked.
List<LocationListener>	getLocationUpdateListeners(String provider)	Deprecated. Do not test listeners, instead use simulateLocation(Location) and test the results of those listeners being invoked.
List<PendingIntent>	getLocationUpdatePendingIntents()	Deprecated. Do not test pending intents, instead use simulateLocation(Location) and test the results of those pending intent being invoked.
List<PendingIntent>	getLocationUpdatePendingIntents(String provider)	Deprecated. Do not test pending intents, instead use simulateLocation(Location) and test the results of those pending intent being invoked.
protected LocationProvider	getProvider(String name)
protected List<String>	getProviders(boolean enabledOnly)
protected List<String>	getProviders(Criteria criteria, boolean enabled)
List<LocationListener>	getRequestLocationUpdateListeners()	Deprecated. Use getLocationUpdateListeners() instead.
protected boolean	injectLocation(Location location)
protected boolean	isLocationEnabledForUser(UserHandle userHandle)
protected boolean	isProviderEnabled(String provider)
protected boolean	registerGnssStatusCallback(GnssStatus.Callback callback, Handler handler)
protected void	removeGpsStatusListener(GpsStatus.Listener listener)
protected void	removeNmeaListener(OnNmeaMessageListener listener)
void	removeProvider(String name)	Completely removes a provider.
protected void	removeUpdates(PendingIntent pendingIntent)
protected void	removeUpdates(LocationListener listener)
protected void	requestLocationUpdates(long minTime, float minDistance, Criteria criteria, PendingIntent intent)
protected void	requestLocationUpdates(long minTime, float minDistance, Criteria criteria, LocationListener listener, Looper looper)
protected void	requestLocationUpdates(Object oRequest, Object intent)
protected void	requestLocationUpdates(Object oRequest, Object listener, Object looper)
protected void	requestLocationUpdates(String provider, long minTime, float minDistance, PendingIntent intent)
protected void	requestLocationUpdates(String provider, long minTime, float minDistance, LocationListener listener)
protected void	requestLocationUpdates(String provider, long minTime, float minDistance, LocationListener listener, Looper looper)
protected void	requestSingleUpdate(Criteria criteria, PendingIntent intent)
protected void	requestSingleUpdate(Criteria criteria, LocationListener listener, Looper looper)
protected void	requestSingleUpdate(String provider, PendingIntent intent)
protected void	requestSingleUpdate(String provider, LocationListener listener, Looper looper)
void	sendGnssStatus(GnssStatus status)	Sends a GnssStatus to all registered GnssStatus.Callbacks.
void	sendNmeaMessage(String message, long timestamp)	Sends a NMEA message to all registered OnNmeaMessageListeners.
void	setLastKnownLocation(String provider, Location location)	Sets the last known location for the given provider.
void	setLocationEnabled(boolean enabled)	On P and above, turns location on or off.
protected void	setLocationEnabledForUser(boolean enabled, UserHandle userHandle)
void	setLocationMode(int locationMode)	On pre-P devices, sets the device location mode.
void	setProviderEnabled(String name, boolean enabled)	Sets the given provider enabled or disabled.
void	setProviderProperties(String name, ShadowLocationManager.ProviderProperties properties)	Sets the properties of the given provider.
void	simulateLocation(Location location)	Delivers a new location to the appropriate listeners and updates state accordingly.
protected void	unregisterGnssStatusCallback(GnssStatus.Callback callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

ShadowLocationManager

public ShadowLocationManager()

Method Detail

getAllProviders

@Implementation
protected List<String> getAllProviders()

getProvider

@Implementation
@Nullable
protected LocationProvider getProvider(String name)

getProviders

@Implementation
protected List<String> getProviders(boolean enabledOnly)

getProviders

@Implementation
protected List<String> getProviders(@Nullable
                                    Criteria criteria,
                                    boolean enabled)

getBestProvider

@Implementation
@Nullable
protected String getBestProvider(Criteria criteria,
                                 boolean enabled)

isProviderEnabled

@Implementation
protected boolean isProviderEnabled(String provider)

removeProvider

public void removeProvider(String name)

Completely removes a provider.

setProviderProperties

public void setProviderProperties(String name,
                                  @Nullable
                                  ShadowLocationManager.ProviderProperties properties)

Sets the properties of the given provider. The provider will be created if it doesn't exist already.

setProviderEnabled

public void setProviderEnabled(String name,
                               boolean enabled)

Sets the given provider enabled or disabled. The provider will be created if it doesn't exist already. On P and above, location must also be enabled via setLocationEnabled(boolean) in order for a provider to be considered enabled.

isLocationEnabledForUser

@Implementation(minSdk=28)
protected boolean isLocationEnabledForUser(UserHandle userHandle)

setLocationEnabledForUser

@Implementation(minSdk=28)
protected void setLocationEnabledForUser(boolean enabled,
                                         UserHandle userHandle)

setLocationEnabled

public void setLocationEnabled(boolean enabled)

On P and above, turns location on or off. On pre-P devices, sets the location mode to Settings.Secure.LOCATION_MODE_HIGH_ACCURACY or Settings.Secure.LOCATION_MODE_OFF.

setLocationMode

public void setLocationMode(int locationMode)

On pre-P devices, sets the device location mode. For P and above, use setLocationEnabled(boolean) and setProviderEnabled(String, boolean) in combination to achieve the desired effect.

getLastKnownLocation

@Implementation
@Nullable
protected Location getLastKnownLocation(String provider)

setLastKnownLocation

public void setLastKnownLocation(String provider,
                                 @Nullable
                                 Location location)

Sets the last known location for the given provider.

requestSingleUpdate

@Implementation
protected void requestSingleUpdate(String provider,
                                   LocationListener listener,
                                   @Nullable
                                   Looper looper)

requestSingleUpdate

@Implementation
protected void requestSingleUpdate(Criteria criteria,
                                   LocationListener listener,
                                   @Nullable
                                   Looper looper)

requestSingleUpdate

@Implementation
protected void requestSingleUpdate(String provider,
                                   PendingIntent intent)

requestSingleUpdate

@Implementation
protected void requestSingleUpdate(Criteria criteria,
                                   PendingIntent intent)

requestLocationUpdates

@Implementation
protected void requestLocationUpdates(String provider,
                                      long minTime,
                                      float minDistance,
                                      LocationListener listener)

requestLocationUpdates

@Implementation
protected void requestLocationUpdates(String provider,
                                      long minTime,
                                      float minDistance,
                                      LocationListener listener,
                                      @Nullable
                                      Looper looper)

requestLocationUpdates

@Implementation
protected void requestLocationUpdates(long minTime,
                                      float minDistance,
                                      Criteria criteria,
                                      LocationListener listener,
                                      @Nullable
                                      Looper looper)

requestLocationUpdates

@Implementation
protected void requestLocationUpdates(String provider,
                                      long minTime,
                                      float minDistance,
                                      PendingIntent intent)

requestLocationUpdates

@Implementation
protected void requestLocationUpdates(long minTime,
                                      float minDistance,
                                      Criteria criteria,
                                      PendingIntent intent)

requestLocationUpdates

@Implementation(minSdk=21)
protected void requestLocationUpdates(@Nullable
                                      Object oRequest,
                                      Object listener,
                                      @Nullable
                                      Object looper)

requestLocationUpdates

@Implementation(minSdk=21)
protected void requestLocationUpdates(@Nullable
                                      Object oRequest,
                                      Object intent)

removeUpdates

@Implementation
protected void removeUpdates(LocationListener listener)

removeUpdates

@Implementation
protected void removeUpdates(PendingIntent pendingIntent)

injectLocation

@Implementation(minSdk=28)
protected boolean injectLocation(Location location)

addGpsStatusListener

@Implementation
protected boolean addGpsStatusListener(GpsStatus.Listener listener)

removeGpsStatusListener

@Implementation
protected void removeGpsStatusListener(GpsStatus.Listener listener)

getGpsStatusListeners

public List<GpsStatus.Listener> getGpsStatusListeners()

registerGnssStatusCallback

@Implementation(minSdk=24)
protected boolean registerGnssStatusCallback(GnssStatus.Callback callback,
                                             Handler handler)

unregisterGnssStatusCallback

@Implementation(minSdk=24)
protected void unregisterGnssStatusCallback(GnssStatus.Callback callback)

sendGnssStatus

public void sendGnssStatus(GnssStatus status)

Sends a GnssStatus to all registered GnssStatus.Callbacks.

addNmeaListener

@Implementation(minSdk=24)
protected boolean addNmeaListener(OnNmeaMessageListener listener,
                                  Handler handler)

removeNmeaListener

@Implementation(minSdk=24)
protected void removeNmeaListener(OnNmeaMessageListener listener)

sendNmeaMessage

public void sendNmeaMessage(String message,
                            long timestamp)

Sends a NMEA message to all registered OnNmeaMessageListeners.

getRequestLocationUpdateListeners

@Deprecated
public List<LocationListener> getRequestLocationUpdateListeners()

Deprecated. Use getLocationUpdateListeners() instead.

simulateLocation

public void simulateLocation(Location location)

Delivers a new location to the appropriate listeners and updates state accordingly. Delivery will ignore the enabled/disabled state of providers, unlike location on a real device.

getLocationUpdateListeners

@Deprecated
public List<LocationListener> getLocationUpdateListeners()

Deprecated. Do not test listeners, instead use simulateLocation(Location) and test the results of those listeners being invoked.

Retrieves a list of all currently registered listeners.

getLocationUpdateListeners

@Deprecated
public List<LocationListener> getLocationUpdateListeners(String provider)

Deprecated. Do not test listeners, instead use simulateLocation(Location) and test the results of those listeners being invoked.

Retrieves a list of all currently registered listeners for the given provider.

getLocationUpdatePendingIntents

@Deprecated
public List<PendingIntent> getLocationUpdatePendingIntents()

Deprecated. Do not test pending intents, instead use simulateLocation(Location) and test the results of those pending intent being invoked.

Retrieves a list of all currently registered pending intents.

getLocationUpdatePendingIntents

@Deprecated
public List<PendingIntent> getLocationUpdatePendingIntents(String provider)

Deprecated. Do not test pending intents, instead use simulateLocation(Location) and test the results of those pending intent being invoked.

Retrieves a list of all currently registered pending intents for the given provider.