MapboxMatrix.Builder (services API)

java.lang.Object
- com.mapbox.api.matrix.v1.MapboxMatrix.Builder

Enclosing class:

MapboxMatrix
```
public abstract static class MapboxMatrix.Builder
extends java.lang.Object
```
This builder is used to create a new request to the Mapbox Matrix API. At a bare minimum, your request must include an access token, and a list of coordinates. All other fields can be left alone inorder to use the default behaviour of the API.
By default, the directions profile is set to driving (without traffic) but can be changed to reflect your users use-case.
Note to contributors: All optional booleans in this builder use the object Boolean rather than the primitive to allow for unset (null) values.

Since:

1.0.0

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract MapboxMatrix.Builder`	`accessToken(java.lang.String accessToken)` Required to call when this is being built.
`MapboxMatrix.Builder`	`addAnnotations(java.lang.String... annotations)` Optionally pass in annotations to control to change which data to return.
`MapboxMatrix.Builder`	`addApproaches(java.lang.String... approaches)` A semicolon-separated list indicating the side of the road from which to approach waypoints in a requested route.
`abstract MapboxMatrix.Builder`	`baseUrl(java.lang.String baseUrl)` Optionally change the APIs base URL to something other then the default Mapbox one.
`MapboxMatrix`	`build()` This uses the provided parameters set using the `MapboxMatrix.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 `MapboxMatrix` object with the values provided.
`abstract MapboxMatrix.Builder`	`clientAppName(java.lang.String clientAppName)` Base package name or other simple string identifier.
`MapboxMatrix.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.
`MapboxMatrix.Builder`	`coordinateListSizeLimit(java.lang.Integer coordinateListSizeLimit)` Override the standard maximum coordinate list size of 25 so that you can make a Matrix API call with a list of coordinates as large as the value you give to this method.
`MapboxMatrix.Builder`	`coordinates(java.util.List<com.mapbox.geojson.Point> coordinates)` Add a list of `Point`'s which define the points to perform the matrix on.
`MapboxMatrix.Builder`	`destinations(java.lang.Integer... destinations)` Optionally pass in indexes to generate an asymmetric matrix.
`abstract MapboxMatrix.Builder`	`profile(java.lang.String profile)` This selects which mode of transportation the user will be using to accurately give the matrix durations.
`MapboxMatrix.Builder`	`sources(java.lang.Integer... sources)` Optionally pass in indexes to generate an asymmetric matrix.
`abstract MapboxMatrix.Builder`	`user(java.lang.String user)` The username for the account that the directions engine runs on.

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
  - user
```
public abstract MapboxMatrix.Builder user(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 directions request
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - coordinates
```
public MapboxMatrix.Builder coordinates(java.util.List<com.mapbox.geojson.Point> coordinates)
```
    Add a list of Point's which define the points to perform the matrix on. The minimum points is 2 and the maximum points allowed in totals 25. You can use this method in conjunction with coordinate(Point).
    
    Parameters:
    
    coordinates - a List full of Points which define the points to perform the matrix on
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - coordinate
```
public MapboxMatrix.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 25 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 duration between all other points
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    3.0.0
  - profile
```
public abstract MapboxMatrix.Builder profile(@NonNull
                                             java.lang.String profile)
```
    This selects which mode of transportation the user will be using to accurately give the matrix durations. 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
  - accessToken
```
public abstract MapboxMatrix.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 Optimization API
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - addAnnotations
```
public MapboxMatrix.Builder addAnnotations(@Nullable
                                           java.lang.String... annotations)
```
    Optionally pass in annotations to control to change which data to return.
    
    Parameters:
    
    annotations - 1 or more annotations
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.1.0
  - addApproaches
```
public MapboxMatrix.Builder addApproaches(@Nullable
                                          java.lang.String... approaches)
```
    A semicolon-separated list indicating the side of the road from which to approach waypoints in a requested route. Accepts unrestricted (default, route can arrive at the waypoint from either side of the road) or curb (route will arrive at the waypoint on the driving_side of the region). If provided, the number of approaches must be the same as the number of waypoints. However, you can skip a coordinate and show its position in the list with the ; separator.
    
    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:
    
    4.1.0
  - destinations
```
public MapboxMatrix.Builder destinations(@Nullable
                                         java.lang.Integer... destinations)
```
    Optionally pass in indexes to generate an asymmetric matrix.
    
    Parameters:
    
    destinations - 1 or more indexes as a integer, if more then one, separate with a comma
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    2.1.0
  - sources
```
public MapboxMatrix.Builder sources(@Nullable
                                    java.lang.Integer... sources)
```
    Optionally pass in indexes to generate an asymmetric matrix.
    
    Parameters:
    
    sources - 1 or more indexes as a integer, if more then one, separate with a comma
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - clientAppName
```
public abstract MapboxMatrix.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:
    
    2.1.0
  - baseUrl
```
public abstract MapboxMatrix.Builder baseUrl(@NonNull
                                             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
  - coordinateListSizeLimit
```
public MapboxMatrix.Builder coordinateListSizeLimit(@NonNull
                                                    java.lang.Integer coordinateListSizeLimit)
```
    Override the standard maximum coordinate list size of 25 so that you can make a Matrix API call with a list of coordinates as large as the value you give to this method. You should only use this method if the Mapbox team has enabled your Mapbox account to be able to request Matrix API information with a list of more than 25 coordinates.
    
    Parameters:
    
    coordinateListSizeLimit - the max limit of coordinates used by a single call
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    5.1.0
  - build
```
public MapboxMatrix build()
```
    This uses the provided parameters set using the MapboxMatrix.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 MapboxMatrix object with the values provided.
    
    Returns:
    
    a new instance of Mapbox Matrix
    
    Since:
    
    2.1.0

Class MapboxMatrix.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

user

coordinates

coordinate

profile

accessToken

addAnnotations

addApproaches

destinations

sources

clientAppName

baseUrl

coordinateListSizeLimit

build