Interface RouteAvoidanceOptions.Builder

  • Method Details

    • areas

      Areas to be avoided.

      Parameters:
      areas - Areas to be avoided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • areas

      Areas to be avoided.

      Parameters:
      areas - Areas to be avoided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • areas

      Areas to be avoided.

      This is a convenience method that creates an instance of the RouteAvoidanceArea.Builder avoiding the need to create one manually via RouteAvoidanceArea.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to areas(List<RouteAvoidanceArea>).

      Parameters:
      areas - a consumer that will call methods on RouteAvoidanceArea.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • carShuttleTrains

      RouteAvoidanceOptions.Builder carShuttleTrains(Boolean carShuttleTrains)

      Avoid car-shuttle-trains while calculating the route.

      Parameters:
      carShuttleTrains - Avoid car-shuttle-trains while calculating the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • controlledAccessHighways

      RouteAvoidanceOptions.Builder controlledAccessHighways(Boolean controlledAccessHighways)

      Avoid controlled access highways while calculating the route.

      Parameters:
      controlledAccessHighways - Avoid controlled access highways while calculating the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dirtRoads

      RouteAvoidanceOptions.Builder dirtRoads(Boolean dirtRoads)

      Avoid dirt roads while calculating the route.

      Parameters:
      dirtRoads - Avoid dirt roads while calculating the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • ferries

      Avoid ferries while calculating the route.

      Parameters:
      ferries - Avoid ferries while calculating the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • seasonalClosure

      RouteAvoidanceOptions.Builder seasonalClosure(Boolean seasonalClosure)

      Avoid roads that have seasonal closure while calculating the route.

      Parameters:
      seasonalClosure - Avoid roads that have seasonal closure while calculating the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tollRoads

      RouteAvoidanceOptions.Builder tollRoads(Boolean tollRoads)

      Avoids roads where the specified toll transponders are the only mode of payment.

      Parameters:
      tollRoads - Avoids roads where the specified toll transponders are the only mode of payment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tollTransponders

      RouteAvoidanceOptions.Builder tollTransponders(Boolean tollTransponders)

      Avoids roads where the specified toll transponders are the only mode of payment.

      Parameters:
      tollTransponders - Avoids roads where the specified toll transponders are the only mode of payment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • truckRoadTypes

      RouteAvoidanceOptions.Builder truckRoadTypes(Collection<String> truckRoadTypes)

      Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

      Parameters:
      truckRoadTypes - Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • truckRoadTypes

      RouteAvoidanceOptions.Builder truckRoadTypes(String... truckRoadTypes)

      Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

      Parameters:
      truckRoadTypes - Truck road type identifiers. BK1 through BK4 apply only to Sweden. A2,A4,B2,B4,C,D,ET2,ET4 apply only to Mexico.

      There are currently no other supported values as of 26th April 2024.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tunnels

      Avoid tunnels while calculating the route.

      Parameters:
      tunnels - Avoid tunnels while calculating the route.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • uTurns

      Avoid U-turns for calculation on highways and motorways.

      Parameters:
      uTurns - Avoid U-turns for calculation on highways and motorways.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • zoneCategories

      Zone categories to be avoided.

      Parameters:
      zoneCategories - Zone categories to be avoided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • zoneCategories

      RouteAvoidanceOptions.Builder zoneCategories(RouteAvoidanceZoneCategory... zoneCategories)

      Zone categories to be avoided.

      Parameters:
      zoneCategories - Zone categories to be avoided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • zoneCategories

      Zone categories to be avoided.

      This is a convenience method that creates an instance of the RouteAvoidanceZoneCategory.Builder avoiding the need to create one manually via RouteAvoidanceZoneCategory.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to zoneCategories(List<RouteAvoidanceZoneCategory>).

      Parameters:
      zoneCategories - a consumer that will call methods on RouteAvoidanceZoneCategory.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: