Interface IsolineAvoidanceOptions.Builder

  • Method Details

    • areas

      Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.

      Parameters:
      areas - Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • areas

      Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.

      Parameters:
      areas - Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • areas

      Specifies geographic areas to avoid where possible. Routes may still pass through these areas if no reasonable alternative exists.

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

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

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

      IsolineAvoidanceOptions.Builder carShuttleTrains(Boolean carShuttleTrains)

      Indicates a preference to avoid car shuttle trains (auto trains) where possible. These may still be included if no reasonable alternative route exists.

      Parameters:
      carShuttleTrains - Indicates a preference to avoid car shuttle trains (auto trains) where possible. These may still be included if no reasonable alternative route exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • controlledAccessHighways

      IsolineAvoidanceOptions.Builder controlledAccessHighways(Boolean controlledAccessHighways)

      Indicates a preference to avoid controlled-access highways (such as interstate highways or motorways) where possible. If a viable route cannot be calculated using only local roads, controlled-access highways may still be included.

      Parameters:
      controlledAccessHighways - Indicates a preference to avoid controlled-access highways (such as interstate highways or motorways) where possible. If a viable route cannot be calculated using only local roads, controlled-access highways may still be included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dirtRoads

      Indicates a preference to avoid unpaved or dirt roads where possible. Routes may still include dirt roads if no reasonable paved alternative exists.

      Parameters:
      dirtRoads - Indicates a preference to avoid unpaved or dirt roads where possible. Routes may still include dirt roads if no reasonable paved alternative exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • ferries

      Indicates a preference to avoid ferries where possible. If a viable route cannot be calculated without using ferries, they may still be included.

      Parameters:
      ferries - Indicates a preference to avoid ferries where possible. If a viable route cannot be calculated without using ferries, they may still be included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • seasonalClosure

      IsolineAvoidanceOptions.Builder seasonalClosure(Boolean seasonalClosure)

      Indicates a preference to avoid roads that may be subject to seasonal closures where possible. These roads may still be included if no reasonable year-round alternative exists.

      Parameters:
      seasonalClosure - Indicates a preference to avoid roads that may be subject to seasonal closures where possible. These roads may still be included if no reasonable year-round alternative exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tollRoads

      Indicates a preference to avoid toll roads where possible. If a viable route cannot be calculated without using toll roads, they may still be included.

      Parameters:
      tollRoads - Indicates a preference to avoid toll roads where possible. If a viable route cannot be calculated without using toll roads, they may still be included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tollTransponders

      IsolineAvoidanceOptions.Builder tollTransponders(Boolean tollTransponders)

      Indicates a preference to avoid roads that require electronic toll collection transponders where possible. These roads may still be included if no viable alternative route exists.

      Parameters:
      tollTransponders - Indicates a preference to avoid roads that require electronic toll collection transponders where possible. These roads may still be included if no viable alternative route exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • truckRoadTypes

      IsolineAvoidanceOptions.Builder truckRoadTypes(Collection<String> truckRoadTypes)

      For truck travel modes, indicates specific road classification types in Sweden ( BK1 through BK4) and Mexico (A2, A4, B2, B4, C, D, ET2, ET4) to avoid where possible. These road types may still be used if no reasonable alternative exists.

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

      Parameters:
      truckRoadTypes - For truck travel modes, indicates specific road classification types in Sweden ( BK1 through BK4) and Mexico (A2, A4, B2, B4, C, D, ET2, ET4) to avoid where possible. These road types may still be used if no reasonable alternative exists.

      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

      IsolineAvoidanceOptions.Builder truckRoadTypes(String... truckRoadTypes)

      For truck travel modes, indicates specific road classification types in Sweden ( BK1 through BK4) and Mexico (A2, A4, B2, B4, C, D, ET2, ET4) to avoid where possible. These road types may still be used if no reasonable alternative exists.

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

      Parameters:
      truckRoadTypes - For truck travel modes, indicates specific road classification types in Sweden ( BK1 through BK4) and Mexico (A2, A4, B2, B4, C, D, ET2, ET4) to avoid where possible. These road types may still be used if no reasonable alternative exists.

      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

      Indicates a preference to avoid tunnels where possible. If a viable route cannot be calculated without using tunnels, they may still be included.

      Parameters:
      tunnels - Indicates a preference to avoid tunnels where possible. If a viable route cannot be calculated without using tunnels, they may still be included.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • uTurns

      Indicates a preference to avoid U-turns where possible. U-turns may still be included if necessary to reach certain areas or when no reasonable alternative exists.

      Parameters:
      uTurns - Indicates a preference to avoid U-turns where possible. U-turns may still be included if necessary to reach certain areas or when no reasonable alternative exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • zoneCategories

      Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.

      Parameters:
      zoneCategories - Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • zoneCategories

      Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.

      Parameters:
      zoneCategories - Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • zoneCategories

      Indicates types of regulated zones (such as congestion pricing or environmental zones) to avoid where possible. Routes may still pass through these zones if no reasonable alternative exists.

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

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

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