MapboxMapMatching.Builder (services API)

java.lang.Object
- com.mapbox.api.matching.v5.MapboxMapMatching.Builder

Enclosing class:

MapboxMapMatching
```
public abstract static class MapboxMapMatching.Builder
extends java.lang.Object
```
Builds your map matching query by adding parameters. Create a fresh instance of the builder for new requests given the fact that some methods like coordinates(List) accumulate values.

Since:

2.0.0

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract MapboxMapMatching.Builder`	`accessToken(java.lang.String accessToken)` Required to call when this is being built.
`MapboxMapMatching.Builder`	`addApproaches(java.lang.String... approaches)` Optionally used to indicate how map matched routes consider rom which side of the road to approach a waypoint.
`MapboxMapMatching.Builder`	`addIgnore(java.lang.String... ignore)` Ignore certain routing restrictions when map matching.
`MapboxMapMatching.Builder`	`addWaypointNames(java.lang.String... waypointNames)` Custom names for waypoints used for the arrival instruction, each separated by ; .
`MapboxMapMatching.Builder`	`annotations(java.lang.String... annotations)` Whether or not to return additional metadata along the route.
`protected abstract MapboxMapMatching.Builder`	`annotations(java.lang.String annotations)`
`protected abstract MapboxMapMatching`	`autoBuild()`
`abstract MapboxMapMatching.Builder`	`bannerInstructions(java.lang.Boolean bannerInstructions)` Setting this will determine whether or not to return banner objects associated with the `routeSteps`.
`abstract MapboxMapMatching.Builder`	`baseUrl(java.lang.String baseUrl)` Optionally change the APIs base URL to something other then the default Mapbox one.
`MapboxMapMatching`	`build()` This uses the provided parameters set using the `MapboxMapMatching.Builder` and first checks that all values are valid, formats the values as strings for easier consumption by the API, and lastly creates a new `MapboxMapMatching` object with the values provided.
`abstract MapboxMapMatching.Builder`	`clientAppName(java.lang.String clientAppName)` Base package name or other simple string identifier.
`MapboxMapMatching.Builder`	`coordinate(com.mapbox.geojson.Point coordinate)` This will add a single `Point` to the coordinate list which is used to determine the duration between points.
`MapboxMapMatching.Builder`	`coordinates(java.util.List<com.mapbox.geojson.Point> coordinates)` Add a list of `Point`'s which define the points to perform the map matching on.
`protected abstract MapboxMapMatching.Builder`	`coordinates(java.lang.String coordinates)`
`abstract MapboxMapMatching.Builder`	`geometries(java.lang.String geometries)` alter the default geometry being returned for the map matching route.
`MapboxMapMatching.Builder`	`get()` Use GET method to request data.
`MapboxMapMatching.Builder`	`language(java.util.Locale language)` Set the instruction language for the map matching request, the default is english.
`abstract MapboxMapMatching.Builder`	`language(java.lang.String language)` Set the instruction language for the map matching request, the default is english.
`abstract MapboxMapMatching.Builder`	`overview(java.lang.String overview)` Type of returned overview geometry.
`MapboxMapMatching.Builder`	`post()` Use POST method to request data.
`abstract MapboxMapMatching.Builder`	`profile(java.lang.String profile)` This selects which mode of transportation the user will be using to accurately give the map matching route.
`MapboxMapMatching.Builder`	`radiuses(java.lang.Double... radiuses)` Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment.
`abstract MapboxMapMatching.Builder`	`roundaboutExits(java.lang.Boolean roundaboutExits)` Setting can be set to either true or false to enable or disable respectively.
`abstract MapboxMapMatching.Builder`	`steps(java.lang.Boolean steps)` Setting this will determine whether to return steps and turn-by-turn instructions.
`abstract MapboxMapMatching.Builder`	`tidy(java.lang.Boolean tidy)` Whether or not to transparently remove clusters and re-sample traces for improved map matching results.
`MapboxMapMatching.Builder`	`timestamps(java.lang.String... timestamps)` Timestamps corresponding to each coordinate provided in the request; must be numbers in Unix time (seconds since the Unix epoch) converted to a String.
`protected abstract MapboxMapMatching.Builder`	`timestamps(java.lang.String timestamps)`
`abstract MapboxMapMatching.Builder`	`user(java.lang.String user)` The username for the account that the directions engine runs on.
`abstract MapboxMapMatching.Builder`	`voiceInstructions(java.lang.Boolean voiceInstructions)` Setting can be set to either true or false to enable or disable SSML marked-up text for voice guidance along the route.
`abstract MapboxMapMatching.Builder`	`voiceUnits(java.lang.String voiceUnits)` Specify what unit you'd like voice and banner instructions to use.
`MapboxMapMatching.Builder`	`waypointIndices(java.lang.Integer... waypointIndices)` Optionally, set which input coordinates should be treated as waypoints / separate legs.
`MapboxMapMatching.Builder`	`waypoints(java.lang.Integer... waypoints)` Deprecated. you should now use `waypointIndices(Integer[])`

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - post
```
@NonNull
public MapboxMapMatching.Builder post()
```
    Use POST method to request data. The default is to use GET.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.4.0
  - get
```
@NonNull
public MapboxMapMatching.Builder get()
```
    Use GET method to request data.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.4.0
  - accessToken
```
@NonNull
public abstract MapboxMapMatching.Builder accessToken(@NonNull
                                                               java.lang.String accessToken)
```
    Required to call when this is being built. If no access token provided, ServicesException will be thrown.
    
    Parameters:
    
    accessToken - Mapbox access token, You must have a Mapbox account inorder to use the Map Matching API
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - tidy
```
@NonNull
public abstract MapboxMapMatching.Builder tidy(@Nullable
                                                        java.lang.Boolean tidy)
```
    Whether or not to transparently remove clusters and re-sample traces for improved map matching results. Pass in null to reset to the APIs default setting.
    
    Parameters:
    
    tidy - true if you'd like the API to remove coordinates clustered together, otherwise false
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - user
```
@NonNull
public abstract MapboxMapMatching.Builder user(@NonNull
                                                        java.lang.String user)
```
    The username for the account that the directions engine runs on. In most cases, this should always remain the default value of DirectionsCriteria.PROFILE_DEFAULT_USER.
    
    Parameters:
    
    user - a non-null string which will replace the default user used in the map matching request
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - profile
```
@NonNull
public abstract MapboxMapMatching.Builder profile(@NonNull
                                                           java.lang.String profile)
```
    This selects which mode of transportation the user will be using to accurately give the map matching route. The options include driving, driving considering traffic, walking, and cycling. Using each of these profiles will result in different durations
    
    Parameters:
    
    profile - required to be one of the String values found in the DirectionsCriteria.ProfileCriteria
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - geometries
```
@NonNull
public abstract MapboxMapMatching.Builder geometries(@NonNull
                                                              java.lang.String geometries)
```
    alter the default geometry being returned for the map matching route. A null value will reset this field to the APIs default value vs this SDKs default value of DirectionsCriteria.GEOMETRY_POLYLINE6.
    Note that while the API supports GeoJson as an option for geometry, this SDK intentionally removes this as an option since an encoded string for the geometry significantly reduces bandwidth on mobile devices and speeds up response time.
    
    Parameters:
    
    geometries - null if you'd like the default geometry, else one of the options found in DirectionsCriteria.GeometriesCriteria.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.0.0
  - radiuses
```
@NonNull
public MapboxMapMatching.Builder radiuses(@Nullable
                                                   java.lang.Double... radiuses)
```
    Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment. There must be as many radiuses as there are coordinates in the request. Values can be any number greater than 0 or they can be unlimited simply by passing Double.POSITIVE_INFINITY.
    If no routable road is found within the radius, a NoSegment error is returned.
    
    Parameters:
    
    radiuses - double array containing the radiuses defined in unit meters.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - waypoints
```
@Deprecated
 @NonNull
public MapboxMapMatching.Builder waypoints(@Nullable
                                                                 java.lang.Integer... waypoints)
```
    Deprecated. you should now use waypointIndices(Integer[])
    
    Optionally, set 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 ; . MapboxMapMatching.steps()
    
    Parameters:
    
    waypoints - integer array of coordinate indices to be used as waypoints
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - waypointIndices
```
@NonNull
public MapboxMapMatching.Builder waypointIndices(@Nullable
                                                          java.lang.Integer... waypointIndices)
```
    Optionally, set which input coordinates should be treated as waypoints / separate legs. Note: coordinate indices not added here act as silent 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 ; . MapboxMapMatching.steps()
    
    Parameters:
    
    waypointIndices - integer array of coordinate indices to be used as waypoints
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - steps
```
@NonNull
public abstract MapboxMapMatching.Builder steps(@Nullable
                                                         java.lang.Boolean steps)
```
    Setting this will determine whether to return steps and turn-by-turn instructions. Can be set to either true or false to enable or disable respectively. null can also optionally be passed in to set the default behavior to match what the API does by default.
    If `steps` is set to `true`, the following guidance-related parameters will be available: `banner_instructions`, `language`, `roundabout_exits`, `voice_instructions`, `voice_units`, `waypoint_names`, and `waypoints`.
    
    Parameters:
    
    steps - true if you'd like step information
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - overview
```
@NonNull
public abstract MapboxMapMatching.Builder overview(@Nullable
                                                            java.lang.String overview)
```
    Type of returned overview geometry. Can be DirectionsCriteria.OVERVIEW_FULL (the most detailed geometry available), DirectionsCriteria.OVERVIEW_SIMPLIFIED (a simplified version of the full geometry), or DirectionsCriteria.OVERVIEW_FALSE (no overview geometry). The default is simplified. Passing in null will use the APIs default setting for the overview field.
    
    Parameters:
    
    overview - null or one of the options found in DirectionsCriteria.OverviewCriteria
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - bannerInstructions
```
@NonNull
public abstract MapboxMapMatching.Builder bannerInstructions(@Nullable
                                                                      java.lang.Boolean bannerInstructions)
```
    Setting this will determine whether or not to return banner objects associated with the `routeSteps`. Can be set to either true or false to enable or disable respectively. null can also optionally be passed in to set the default behavior to match what the API does by default.
    Must be used in conjunction with `steps=true`.
    
    Parameters:
    
    bannerInstructions - true if you'd like step information
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - voiceInstructions
```
@NonNull
public abstract MapboxMapMatching.Builder voiceInstructions(@Nullable
                                                                     java.lang.Boolean voiceInstructions)
```
    Setting can be set to either true or false to enable or disable SSML marked-up text for voice guidance along the route. null can also optionally be passed in to set the default behavior to match what the API does by default.
    Must be used in conjunction with `steps=true`.
    
    Parameters:
    
    voiceInstructions - true if you'd like step information
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - voiceUnits
```
@NonNull
public abstract MapboxMapMatching.Builder voiceUnits(@Nullable
                                                              java.lang.String voiceUnits)
```
    Specify what unit you'd like voice and banner instructions to use.
    Must be used in conjunction with `steps=true` and `voice_instructions=true`.
    
    Parameters:
    
    voiceUnits - either Imperial (default) or Metric
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - roundaboutExits
```
@NonNull
public abstract MapboxMapMatching.Builder roundaboutExits(@Nullable
                                                                   java.lang.Boolean roundaboutExits)
```
    Setting can be set to either true or false to enable or disable respectively. null can also optionally be passed in to set the default behavior to match what the API does by default.
    Must be used in conjunction with `steps=true`.
    
    Parameters:
    
    roundaboutExits - true if you'd like step information
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - annotations
```
@NonNull
public MapboxMapMatching.Builder annotations(@Nullable
                                                      java.lang.String... annotations)
```
    Whether or not to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, DirectionsCriteria.ANNOTATION_DURATION and DirectionsCriteria.ANNOTATION_CONGESTION.
    
    Parameters:
    
    annotations - string referencing one of the annotation direction criteria's. The strings restricted to one or multiple values inside the DirectionsCriteria.AnnotationCriteria or null which will result in no annotations being used
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
    
    See Also:
    
    RouteLeg object documentation
  - annotations
```
@NonNull
protected abstract MapboxMapMatching.Builder annotations(@Nullable
                                                                  java.lang.String annotations)
```
  - timestamps
```
@NonNull
public MapboxMapMatching.Builder timestamps(@Nullable
                                                     java.lang.String... timestamps)
```
    Timestamps corresponding to each coordinate provided in the request; must be numbers in Unix time (seconds since the Unix epoch) converted to a String. There must be as many timestamps as there are coordinates in the request.
    
    Parameters:
    
    timestamps - timestamp corresponding to the coordinate added at the identical index
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - timestamps
```
@NonNull
protected abstract MapboxMapMatching.Builder timestamps(@Nullable
                                                                 java.lang.String timestamps)
```
  - coordinates
```
@NonNull
public MapboxMapMatching.Builder coordinates(@NonNull
                                                      java.util.List<com.mapbox.geojson.Point> coordinates)
```
    Add a list of Point's which define the points to perform the map matching on. The minimum points is 2 and the maximum points allowed in totals 100. You can use this method in conjunction with coordinate(Point).
    
    Parameters:
    
    coordinates - a List full of Points which define the points to perform the map matching on
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - coordinates
```
@NonNull
protected abstract MapboxMapMatching.Builder coordinates(@NonNull
                                                                  java.lang.String coordinates)
```
  - coordinate
```
@NonNull
public MapboxMapMatching.Builder coordinate(@NonNull
                                                     com.mapbox.geojson.Point coordinate)
```
    This will add a single Point to the coordinate list which is used to determine the duration between points. This can be called up to 100 times until you hit the maximum allowed points. You can use this method in conjunction with coordinates(List).
    
    Parameters:
    
    coordinate - a Point which you'd like the map matching APi to perform on
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - language
```
@NonNull
public MapboxMapMatching.Builder language(@Nullable
                                                   java.util.Locale language)
```
    Set the instruction language for the map matching request, the default is english. Only a select number of languages are currently supported, reference the table provided in the see link below.
    Must be used in conjunction with `steps=true`.
    
    Parameters:
    
    language - a Locale value representing the language you'd like the instructions to be written in when returned
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
    
    See Also:
    
    Supported Languages
  - language
```
@NonNull
public abstract MapboxMapMatching.Builder language(java.lang.String language)
```
    Set the instruction language for the map matching request, the default is english. Only a select number of languages are currently supported, reference the table provided in the see link below.
    
    Parameters:
    
    language - a String value representing the language you'd like the instructions to be written in when returned
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.2.0
    
    See Also:
    
    Supported Languages
  - clientAppName
```
@NonNull
public abstract MapboxMapMatching.Builder clientAppName(@NonNull
                                                                 java.lang.String clientAppName)
```
    Base package name or other simple string identifier. Used inside the calls user agent header.
    
    Parameters:
    
    clientAppName - base package name or other simple string identifier
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    1.0.0
  - addApproaches
```
@NonNull
public MapboxMapMatching.Builder addApproaches(@Nullable
                                                        java.lang.String... approaches)
```
    Optionally used to indicate how map matched routes consider rom which side of the road to approach a waypoint. Accepts unrestricted (default), curb or null. If set to unrestricted , the map matched route can approach waypoints from either side of the road. If set to curb , the map matched 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.
    
    Parameters:
    
    approaches - null if you'd like the default approaches, else one of the options found in DirectionsCriteria.ApproachesCriteria.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.2.0
  - addWaypointNames
```
@NonNull
public MapboxMapMatching.Builder addWaypointNames(@Nullable
                                                           java.lang.String... waypointNames)
```
    Custom names for waypoints used for the arrival instruction, each separated by ; . Values can be any string and total number of all characters cannot exceed 500. If provided, the list of waypointNames must be the same length as the list of waypoints, but you can skip a coordinate and show its position with the ; separator.
    
    Parameters:
    
    waypointNames - Custom names for waypoints used for the arrival instruction.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.3.0
  - addIgnore
```
@NonNull
public MapboxMapMatching.Builder addIgnore(@Nullable
                                                    java.lang.String... ignore)
```
    Ignore certain routing restrictions when map matching.
    This option is only available for the mapbox/driving profile.
    
    Parameters:
    
    ignore - routing restrictions
    
    Returns:
    
    this builder for chaining options together
  - baseUrl
```
@NonNull
public abstract MapboxMapMatching.Builder baseUrl(java.lang.String baseUrl)
```
    Optionally change the APIs base URL to something other then the default Mapbox one.
    
    Parameters:
    
    baseUrl - base url used as end point
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - autoBuild
```
@NonNull
protected abstract MapboxMapMatching autoBuild()
```
  - build
```
@NonNull
public MapboxMapMatching build()
```
    This uses the provided parameters set using the MapboxMapMatching.Builder and first checks that all values are valid, formats the values as strings for easier consumption by the API, and lastly creates a new MapboxMapMatching object with the values provided.
    
    Returns:
    
    a new instance of Mapbox Map Matching
    
    Throws:
    
    com.mapbox.core.exceptions.ServicesException - when a provided parameter is detected to be incorrect
    
    Since:
    
    2.1.0

Class MapboxMapMatching.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

post

get

accessToken

tidy

user

profile

geometries

radiuses

waypoints

waypointIndices

steps

overview

bannerInstructions

voiceInstructions

voiceUnits

roundaboutExits

annotations

annotations

timestamps

timestamps

coordinates

coordinates

coordinate

language

language

clientAppName

addApproaches

addWaypointNames

addIgnore

baseUrl

autoBuild

build