Interface RouteAvoidanceAreaGeometry.Builder

  • Method Details

    • corridor

      Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

      Parameters:
      corridor - Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • corridor

      Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to corridor(Corridor).

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

      Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

      Parameters:
      boundingBox - Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • boundingBox

      RouteAvoidanceAreaGeometry.Builder boundingBox(Double... boundingBox)

      Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

      Parameters:
      boundingBox - Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • polygon

      Geometry defined as a polygon with only one linear ring.

      Parameters:
      polygon - Geometry defined as a polygon with only one linear ring.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • polygon

      Geometry defined as a polygon with only one linear ring.

      Parameters:
      polygon - Geometry defined as a polygon with only one linear ring.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • polylineCorridor

      RouteAvoidanceAreaGeometry.Builder polylineCorridor(PolylineCorridor polylineCorridor)

      Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

      Parameters:
      polylineCorridor - Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • polylineCorridor

      default RouteAvoidanceAreaGeometry.Builder polylineCorridor(Consumer<PolylineCorridor.Builder> polylineCorridor)

      Geometry defined as an encoded corridor - an encoded polyline with a radius that defines the width of the corridor.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to polylineCorridor(PolylineCorridor).

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

      RouteAvoidanceAreaGeometry.Builder polylinePolygon(Collection<String> polylinePolygon)

      A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github .com/heremaps/flexiblepolyline/blob/master/README.md.

      Parameters:
      polylinePolygon - A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • polylinePolygon

      RouteAvoidanceAreaGeometry.Builder polylinePolygon(String... polylinePolygon)

      A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github .com/heremaps/flexiblepolyline/blob/master/README.md.

      Parameters:
      polylinePolygon - A list of Isoline PolylinePolygon, for each isoline PolylinePolygon, it contains PolylinePolygon of the first linear ring (the outer ring) and from 2nd item to the last item (the inner rings). For more information on polyline encoding, see https://github.com/heremaps/flexiblepolyline/blob/master/README.md.
      Returns:
      Returns a reference to this object so that method calls can be chained together.