com.swirl

Class RegionManager

java.lang.Object

com.swirl.Manager

com.swirl.RegionManager

public class RegionManager
extends Manager

The RegionManager manages a working set of Region objects and determines based on receiving Location updates which regions are entered, which are exited and broadcasts that information onto the EventBus.

An instance of this class is loaded and started by the library. You do not interact with this class directly.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RegionManager.RegionsChangedEvent A RegionsChangedEvent is generated whenever the RegionManager determines the set of entered or exited regions to have changed based on a location change.

Method Summary

Modifier and Type	Method and Description
java.util.List<Region>	getEnteredRegions()
static RegionManager	getInstance() Returns the last RegionManager created.
Region	getMonitoredArea()
java.util.List<Region>	getMonitoredRegions()
void	init(android.content.Context context, EventBus bus, java.util.concurrent.ScheduledExecutorService executor) Called when the manager is created to provide its execution environment.
void	onLocationChange(Device.LocationChangedEvent event)
void	onPermissionsChanged(Device.PermissionsChangedEvent event)
void	start() Starts the manager.
void	stop() Stops the manager.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static RegionManager getInstance()

Returns the last RegionManager created. Usually there is only one. It will return null if there is no RegionManager.

Returns:

RegionManager

init

public void init(android.content.Context context,
                 EventBus bus,
                 java.util.concurrent.ScheduledExecutorService executor)

Description copied from class: Manager

Called when the manager is created to provide its execution environment.

Parameters:

context - The application context to use

bus - The EventBus that the manager is a member of

executor - The Executor to use and on which events are dispatched

start

public void start()

Description copied from class: Manager

Starts the manager.

stop

public void stop()

Description copied from class: Manager

Stops the manager.

getMonitoredArea

public Region getMonitoredArea()

getMonitoredRegions

public java.util.List<Region> getMonitoredRegions()

getEnteredRegions

public java.util.List<Region> getEnteredRegions()

onPermissionsChanged

public void onPermissionsChanged(Device.PermissionsChangedEvent event)

onLocationChange

public void onLocationChange(Device.LocationChangedEvent event)