程序包 ai.nextbillion.kits.directions.models

类 RouteOptions.Builder

java.lang.Object
ai.nextbillion.kits.directions.models.RouteOptions.Builder
封闭类:
RouteOptions
public abstract static class RouteOptions.Builder extends Object
This builder can be used to set the values describing the RouteOptions.

  • 构造器详细资料

    • Builder

      public Builder()

  • 方法详细资料

    • baseUrl

      public abstract RouteOptions.Builder baseUrl(@NonNull String baseUrl)
      The base URL that was used during the request time and resulted in this responses result.
      参数:
      baseUrl - base URL used for original request
      返回:
      this builder for chaining options together

    • user

      public abstract RouteOptions.Builder user(@NonNull String user)
      The user value that was used during the request.
      参数:
      user - string representing the user field in the calling url
      返回:
      this builder for chaining options together

    • profile

      public abstract RouteOptions.Builder profile(@NonNull String profile)
      The routing profile to use. Possible values are DirectionsCriteria.PROFILE_DRIVING_TRAFFIC, DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_WALKING, or DirectionsCriteria.PROFILE_CYCLING. The same profile which was used during the request that resulted in this root directions response. NbmapDirections.Builder ensures that a profile is always set even if the NbmapDirections requesting object doesn't specifically set a profile.
      参数:
      profile - One of the direction profiles defined in DirectionsCriteria.ProfileCriteria
      返回:
      this builder for chaining options together

    • coordinates

      public abstract RouteOptions.Builder coordinates(@NonNull List<ai.nextbillion.kits.geojson.Point> coordinates)
      A list of Points to visit in order. There can be between two and 25 coordinates for most requests, or up to three coordinates for DirectionsCriteria.PROFILE_DRIVING_TRAFFIC requests. Note that these coordinates are different than the direction responses DirectionsWaypoints that these are the non-snapped coordinates.
      参数:
      coordinates - a list of Points which represent the route origin, destination, and optionally, waypoints
      返回:
      this builder for chaining options together

    • alternatives

      public abstract RouteOptions.Builder alternatives(@NonNull Boolean alternatives)
      Whether to try to return alternative routes (true) or not (false, default). An alternative route is a route that is significantly different than the fastest route, but also still reasonably fast. Such a route does not exist in all circumstances. Up to two alternatives may be returned. This is available forDirectionsCriteria.PROFILE_DRIVING_TRAFFIC, DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_CYCLING.
      参数:
      alternatives - true if the request contained additional route request, otherwise false
      返回:
      this builder for chaining options together

    • language

      public abstract RouteOptions.Builder language(@NonNull String language)
      The language of returned turn-by-turn text instructions. The default is en (English). Must be used in conjunction with RouteOptions.steps() = true.
      参数:
      language - a string with the language which was requested in the url
      返回:
      this builder for chaining options together

    • radiuses

      public abstract RouteOptions.Builder radiuses(@NonNull String radiuses)
      The maximum distance a coordinate can be moved to snap to the road network in meters. There must be as many radiuses as there are coordinates in the request, each separated by ;. Values can be any number greater than 0 or the string unlimited.
      参数:
      radiuses - a String of radius values, each separated by ;.
      返回:
      this builder for chaining options together

    • radiusesList

      public RouteOptions.Builder radiusesList(@NonNull List<Double> radiuses)
      The maximum distance a coordinate can be moved to snap to the road network in meters. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or Double.POSITIVE_INFINITY.
      参数:
      radiuses - a list of radius values
      返回:
      this builder for chaining options together

    • bearings

      public abstract RouteOptions.Builder bearings(@NonNull String bearings)
      Influences the direction in which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on by direction. This is useful for making sure the new routes of rerouted vehicles continue traveling in their current direction. A request that does this would provide bearing and radius values for the first waypoint and leave the remaining values empty. Takes two comma-separated values per waypoint: an angle clockwise from true north between 0 and 360, and the range of degrees by which the angle can deviate (recommended value is 45° or 90°), formatted as {angle, degrees}. If provided, the list of bearings must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with the ; separator.
      参数:
      bearings - a string representing the bearings with the ; separator. Angle and degrees for every bearing value are comma-separated.
      返回:
      this builder for chaining options together

    • bearingsList

      public RouteOptions.Builder bearingsList(@NonNull List<List<Double>> bearings)
      Influences the direction in which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on by direction. This is useful for making sure the new routes of rerouted vehicles continue traveling in their current direction. A request that does this would provide bearing and radius values for the first waypoint and leave the remaining values empty. Takes a List of list of doubles: the first value in the list is an angle clockwise from true north between 0 and 360, the second value is the range of degrees by which the angle can deviate (recommended value is 45° or 90°). If provided, the list of bearings must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with the null value.
      参数:
      bearings - a List of list of doubles representing the bearings used in the original request. The first value in the list is the angle, the second one is the degrees.
      返回:
      this builder for chaining options together

    • continueStraight

      public abstract RouteOptions.Builder continueStraight(@NonNull Boolean continueStraight)
      Sets the allowed direction of travel when departing intermediate waypoints. If true, the route will continue in the same direction of travel. If false, the route may continue in the opposite direction of travel. Defaults to true for DirectionsCriteria.PROFILE_DRIVING and false for DirectionsCriteria.PROFILE_WALKING and DirectionsCriteria.PROFILE_CYCLING.
      参数:
      continueStraight - true if you'd like the user to continue straight from the starting point
      返回:
      this builder for chaining options together

    • roundaboutExits

      public abstract RouteOptions.Builder roundaboutExits(@NonNull Boolean roundaboutExits)
      Whether to emit instructions at roundabout exits (true) or not (false, default). Without this parameter, roundabout maneuvers are given as a single instruction that includes both entering and exiting the roundabout. With roundabout_exits=true, this maneuver becomes two instructions, one for entering the roundabout and one for exiting it. Must be used in conjunction with steps(Boolean)
      参数:
      roundaboutExits - true if you'd like extra roundabout instructions
      返回:
      this builder for chaining options together

    • geometries

      public abstract RouteOptions.Builder geometries(@NonNull String geometries)
      The format of the returned geometry. Allowed values are: DirectionsCriteria.GEOMETRY_POLYLINE (default, a polyline with a precision of five decimal places), DirectionsCriteria.GEOMETRY_POLYLINE6 (a polyline with a precision of six decimal places). A null value will reset this field to the APIs default value vs this SDKs default value of DirectionsCriteria.GEOMETRY_POLYLINE6.
      参数:
      geometries - one of the options found in DirectionsCriteria.GeometriesCriteria.
      返回:
      this builder for chaining options together

    • overview

      public abstract RouteOptions.Builder overview(@NonNull String overview)
      Displays the requested type of overview geometry. Can be DirectionsCriteria.OVERVIEW_FULL (the most detailed geometry available), DirectionsCriteria.OVERVIEW_SIMPLIFIED (default, a simplified version of the full geometry), or DirectionsCriteria.OVERVIEW_FALSE (no overview geometry).
      参数:
      overview - one of the options found in DirectionsCriteria.OverviewCriteria
      返回:
      this builder for chaining options together

    • steps

      public abstract RouteOptions.Builder steps(@NonNull Boolean steps)
      Whether to return steps and turn-by-turn instructions (true) or not (false, default). If steps is set to true, the following guidance-related parameters will be available: RouteOptions.bannerInstructions(), RouteOptions.language(), RouteOptions.roundaboutExits(), RouteOptions.voiceInstructions(), RouteOptions.voiceUnits(), RouteOptions.waypointNamesList(), RouteOptions.waypointTargetsList(), waypoints from RouteOptions.coordinates()
      参数:
      steps - true if you'd like step information, false otherwise
      返回:
      this builder for chaining options together

    • annotations

      public abstract RouteOptions.Builder annotations(@NonNull String annotations)
      Whether to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DURATION DirectionsCriteria.ANNOTATION_DISTANCE DirectionsCriteria.ANNOTATION_SPEED DirectionsCriteria.ANNOTATION_CONGESTION DirectionsCriteria.ANNOTATION_MAXSPEED You can include several annotations as a comma-separated list. See the RouteLeg object for more details on what is included with annotations. Must be used in conjunction with overview=full.
      参数:
      annotations - in string format and separated by commas if more than one annotation was requested
      返回:
      this builder for chaining options together

    • annotationsList

      public RouteOptions.Builder annotationsList(@NonNull List<String> annotations)
      Whether to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DURATION DirectionsCriteria.ANNOTATION_DISTANCE DirectionsCriteria.ANNOTATION_SPEED DirectionsCriteria.ANNOTATION_CONGESTION DirectionsCriteria.ANNOTATION_MAXSPEED See the RouteLeg object for more details on what is included with annotations. Must be used in conjunction with overview=full.
      参数:
      annotations - a list of annotations
      返回:
      this builder for chaining options together

    • voiceInstructions

      public abstract RouteOptions.Builder voiceInstructions(@NonNull Boolean voiceInstructions)
      Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default). Must be used in conjunction with steps(Boolean).
      参数:
      voiceInstructions - true if the original request included voice instructions
      返回:
      this builder for chaining options together

    • bannerInstructions

      public abstract RouteOptions.Builder bannerInstructions(@NonNull Boolean bannerInstructions)
      Whether to return banner objects associated with the route steps (true) or not (false, default). Must be used in conjunction with steps(Boolean)
      参数:
      bannerInstructions - true if the original request included banner instructions
      返回:
      this builder for chaining options together

    • voiceUnits

      public abstract RouteOptions.Builder voiceUnits(@NonNull String voiceUnits)
      Specify which type of units to return in the text for voice instructions. Can be DirectionsCriteria.IMPERIAL (default) or DirectionsCriteria.METRIC. Must be used in conjunction with steps(Boolean)=true and voiceInstructions(Boolean)=true.
      参数:
      voiceUnits - string matching either imperial or metric
      返回:
      this builder for chaining options together

    • accessToken

      public abstract RouteOptions.Builder accessToken(@NonNull String accessToken)
      A valid Nbmap access token used to making the request.
      参数:
      accessToken - a string containing a valid Nbmap access token
      返回:
      this builder for chaining options together

    • requestUuid

      public abstract RouteOptions.Builder requestUuid(@NonNull String requestUuid)
      A universally unique identifier (UUID) for identifying and executing a similar specific route in the future.
      参数:
      requestUuid - a string containing the request UUID
      返回:
      this builder for chaining options together

    • exclude

      public abstract RouteOptions.Builder exclude(@NonNull String exclude)
      Exclude certain road types from routing. The default is to not exclude anything from the profile selected. The following exclude flags are available for each profile: DirectionsCriteria.PROFILE_DRIVING: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY. DirectionsCriteria.PROFILE_DRIVING_TRAFFIC: One of DirectionsCriteria.EXCLUDE_TOLL, DirectionsCriteria.EXCLUDE_MOTORWAY, or DirectionsCriteria.EXCLUDE_FERRY. DirectionsCriteria.PROFILE_WALKING: No excludes supported DirectionsCriteria.PROFILE_CYCLING: DirectionsCriteria.EXCLUDE_FERRY
      参数:
      exclude - a string matching one of the DirectionsCriteria.ExcludeCriteria exclusions
      返回:
      this builder for chaining options together

    • approaches

      public abstract RouteOptions.Builder approaches(@NonNull String approaches)
      Indicates from which side of the road to approach a waypoint. Accepts DirectionsCriteria.APPROACH_UNRESTRICTED (default) or DirectionsCriteria.APPROACH_CURB . If set to DirectionsCriteria.APPROACH_UNRESTRICTED, the route can approach waypoints from either side of the road. If set to DirectionsCriteria.APPROACH_CURB, the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints. However, you can skip a coordinate and show its position in the list with the ; separator. The same approaches the user originally made when the request was made.
      参数:
      approaches - unrestricted, curb or omitted (;)
      返回:
      this builder for chaining options together

    • approachesList

      public RouteOptions.Builder approachesList(@NonNull List<String> approaches)
      Indicates from which side of the road to approach a waypoint. Accepts DirectionsCriteria.APPROACH_UNRESTRICTED (default) or DirectionsCriteria.APPROACH_CURB . If set to DirectionsCriteria.APPROACH_UNRESTRICTED, the route can approach waypoints from either side of the road. If set to DirectionsCriteria.APPROACH_CURB, the route will be returned so that on arrival, the waypoint will be found on the side that corresponds with the driving_side of the region in which the returned route is located. If provided, the list of approaches must be the same length as the list of waypoints. However, you can skip a coordinate and show its position in the list with null value. The same approaches the user originally made when the request was made.
      参数:
      approaches - a list of Strings
      返回:
      this builder for chaining options together

    • waypointIndices

      public abstract RouteOptions.Builder waypointIndices(@NonNull String waypointIndices)
      Indicates which input coordinates should be treated as waypoints.

      Most useful in combination with steps=true and requests based on traces with high sample rates. Can be an index corresponding to any of the input coordinates, but must contain the first ( 0 ) and last coordinates' index separated by ; . RouteOptions.steps()

      The same waypoint indices the user originally made when the request was made.
      参数:
      waypointIndices - to be used as waypoints
      返回:
      this builder for chaining options together

    • waypointIndicesList

      public RouteOptions.Builder waypointIndicesList(@NonNull List<Integer> indices)
      Indicates which input coordinates should be treated as waypoints.

      Most useful in combination with steps=true and requests based on traces with high sample rates. Can be an index corresponding to any of the input coordinates, but must contain the first ( 0 ) and last coordinates'. RouteOptions.steps()

      The same waypoint indices the user originally made when the request was made.
      参数:
      indices - a list to be used as waypoints
      返回:
      this builder for chaining options together

    • waypointNames

      public abstract RouteOptions.Builder waypointNames(@NonNull String waypointNames)
      A semicolon-separated list of custom names for entries in the list of RouteOptions.coordinates(), used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters cannot exceed 500. If provided, the list of waypoint_names must be the same length as the list of coordinates, but you can skip a coordinate pair and show its position in the list with the ; separator. The first value in the list corresponds to the route origin, not the first destination. To leave the origin unnamed, begin the list with a semicolon. Must be used in conjunction with steps(Boolean) = true.
      参数:
      waypointNames - unrestricted, curb or omitted (;)
      返回:
      this builder for chaining options together

    • waypointNamesList

      public RouteOptions.Builder waypointNamesList(@NonNull List<String> waypointNames)
      A semicolon-separated list of custom names for entries in the list of RouteOptions.coordinates(), used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters cannot exceed 500. If provided, the list of waypoint_names must be the same length as the list of coordinates, but you can skip a coordinate pair and show its position in the list with the null value. The first value in the list corresponds to the route origin, not the first destination. To leave the origin unnamed, begin the list with a null value. Must be used in conjunction with steps(Boolean) = true.
      参数:
      waypointNames - a list of Strings
      返回:
      this builder for chaining options together

    • waypointTargets

      public abstract RouteOptions.Builder waypointTargets(@NonNull String waypointTargets)
      A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates. If this parameter is provided, the Directions API will compute the side of the street, left or right, for each target based on the waypoint_targets and the driving direction. The maneuver.modifier, banner and voice instructions will be updated with the computed side of street. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate pair and show its position in the list with the ; separator. Must be used with steps(Boolean) = true. The same waypoint targets the user originally made when the request was made.
      参数:
      waypointTargets - list of coordinate pairs for drop-off locations (;)
      返回:
      this builder for chaining options together

    • waypointTargetsList

      public RouteOptions.Builder waypointTargetsList(@NonNull List<ai.nextbillion.kits.geojson.Point> waypointTargets)
      A list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates. If this parameter is provided, the Directions API will compute the side of the street, left or right, for each target based on the waypoint_targets and the driving direction. The maneuver.modifier, banner and voice instructions will be updated with the computed side of street. The number of waypoint targets must be the same as the number of coordinates, but you can skip a coordinate pair and show its position in the list with the null value. Must be used with steps(Boolean) = true. The same waypoint targets the user originally made when the request was made.
      参数:
      waypointTargets - list of Points for drop-off locations
      返回:
      this builder for chaining options together

    • walkingOptions

      public abstract RouteOptions.Builder walkingOptions(@NonNull WalkingOptions walkingOptions)
      To be used to specify settings for use with the walking profile.
      参数:
      walkingOptions - options to use for walking profile
      返回:
      this builder for chaining options together

    • snappingClosures

      public abstract RouteOptions.Builder snappingClosures(@NonNull String snappingClosures)
      A semicolon-separated list of booleans affecting snapping of waypoint locations to road segments. If true, road segments closed due to live-traffic closures will be considered for snapping. If false, they will not be considered for snapping. If provided, the number of snappingClosures must be the same as the number of coordinates. You can skip a coordinate and show its position in the list with the ; separator. If unspecified, this parameter defaults to false. Must be used with DirectionsCriteria.PROFILE_DRIVING_TRAFFIC
      参数:
      snappingClosures - a semicolon-separated list of booleans
      返回:
      this builder for chaining options together

    • snappingClosures

      public RouteOptions.Builder snappingClosures(@NonNull List<Boolean> snappingClosures)
      A list of booleans affecting snapping of waypoint locations to road segments. If true, road segments closed due to live-traffic closures will be considered for snapping. If false, they will not be considered for snapping. If provided, the number of snappingClosures must be the same as the number of coordinates. You can skip a coordinate and show its position in the list with null value. If unspecified, this parameter defaults to false. Must be used with DirectionsCriteria.PROFILE_DRIVING_TRAFFIC
      参数:
      snappingClosures - a list of booleans
      返回:
      this builder for chaining options together

    • build

      public abstract RouteOptions build()
      Builds a new instance of the RouteOptions object.
      返回:
      a new RouteOptions instance