com.atakmap.android.routes

Class RoutePlannerManager

java.lang.Object

com.atakmap.android.routes.RoutePlannerManager

public class RoutePlannerManager
extends java.lang.Object

Class to manage Route Planners.

Constructor Summary

Constructors

Constructor and Description
RoutePlannerManager()

Method Summary

Modifier and Type	Method and Description
int	getCount() Gets the number of registered Route Planners.
RoutePlannerInterface	getPlanner(java.lang.String id) Gets the Route Planner registered with the given id.
java.util.Set<java.util.Map.Entry<java.lang.String,RoutePlannerInterface>>	getReroutePlanners() Gets a set of all id->Route Planner mapping entries containing only entries that support re-routing.
java.util.Set<java.util.Map.Entry<java.lang.String,RoutePlannerInterface>>	getRoutePlanners() Gets a set of all id->Route Planner mapping entries representing all registered Route Planners.
RoutePlannerInterface	registerPlanner(java.lang.String id, RoutePlannerInterface planner) Registers the Route Planner with the given id.
RoutePlannerInterface	unregisterPlanner(java.lang.String id) Unregisters the Route Planner with the given id.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutePlannerManager

public RoutePlannerManager()

Method Detail

getPlanner

public RoutePlannerInterface getPlanner(java.lang.String id)

Gets the Route Planner registered with the given id.

Parameters:

id - the identifier for the specific route planner

Returns:

null if no matching Route Planner

registerPlanner

public RoutePlannerInterface registerPlanner(java.lang.String id,
                                             RoutePlannerInterface planner)

Registers the Route Planner with the given id.

Parameters:

id - the identifier for a route planner

planner - the route planner

Returns:

The previously registered Route Planner with the same id, if any

unregisterPlanner

public RoutePlannerInterface unregisterPlanner(java.lang.String id)

Unregisters the Route Planner with the given id.

Parameters:

id - the identifier for the route planner

Returns:

The Route Planner that has been unregistered, if any

getRoutePlanners

public java.util.Set<java.util.Map.Entry<java.lang.String,RoutePlannerInterface>> getRoutePlanners()

Gets a set of all id->Route Planner mapping entries representing all registered Route Planners. The set is decoupled from the manager once it is returned.

Returns:

the set of all route planners

getReroutePlanners

public java.util.Set<java.util.Map.Entry<java.lang.String,RoutePlannerInterface>> getReroutePlanners()

Gets a set of all id->Route Planner mapping entries containing only entries that support re-routing. The set is decoupled from the manager once it is returned.

Returns:

the set of all reroute planners

getCount

public int getCount()

Gets the number of registered Route Planners.

Returns:

The number of registered Route Planners.