RoutingService

All Implemented Interfaces:

java.io.Serializable
```
public interface RoutingService<P extends Position<P>, O extends RoutingServiceOptions<O>>
 implements Serializable
                    
```
A service capable to generate routes into an environment. Parametric on the Position type P and the supported RoutingServiceOptions.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`P`	`allowedPointClosestTo(P position)`	Retrieves (if available) the valid point closest to position, using the default options.
`abstract P`	`allowedPointClosestTo(P position, O options)`	Retrieves (if available) the valid point closest to position with the provided options.
`Route<P>`	`route(P from, P to)`	Computes a Route a P another.
`Route<P>`	`route(P from, P to, String options)`	Computes a Route a P another, honoring the provided set of navigation options.
`abstract Route<P>`	`route(P from, P to, O options)`	Computes a Route a P another, honoring the provided set of navigation options.
`abstract O`	`parseOptions(String options)`	Creates a set of options from the provided string.
`abstract O`	`getDefaultOptions()`	The default set of options.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - allowedPointClosestTo
```
 P allowedPointClosestTo(P position)
```
    Retrieves (if available) the valid point closest to position, using the default options.
  - allowedPointClosestTo
```
 abstract P allowedPointClosestTo(P position, O options)
```
    Retrieves (if available) the valid point closest to position with the provided options. For instance, this method could be used to find the pedestrian-allowed road closer to a highway.
  - route
```
 Route<P> route(P from, P to)
```
    Computes a Route a P another.
  - route
```
 Route<P> route(P from, P to, String options)
```
    Computes a Route a P another, honoring the provided set of navigation options.
  - route
```
 abstract Route<P> route(P from, P to, O options)
```
    Computes a Route a P another, honoring the provided set of navigation options.
  - parseOptions
```
 abstract O parseOptions(String options)
```
    Creates a set of options from the provided string.
  - getDefaultOptions
```
 abstract O getDefaultOptions()
```
    The default set of options.