MapboxIsochrone.Builder (services API)

java.lang.Object
- com.mapbox.api.isochrone.MapboxIsochrone.Builder

Enclosing class:

MapboxIsochrone
```
public abstract static class MapboxIsochrone.Builder
extends java.lang.Object
```
This builder is used to create a new request to the Mapbox Isochrone API. At a bare minimum, your request must include an access token, a directions routing profile (driving, walking, or cycling),and a comma separated list of time for the contours. All other fields can be left alone in order to use the default behaviour of the API.
Note to contributors: All optional booleans in this builder use the object Boolean rather than the primitive to allow for unset (null) values.

Since:

4.6.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 MapboxIsochrone.Builder`	`accessToken(java.lang.String accessToken)` A valid Mapbox access token.
`MapboxIsochrone.Builder`	`addContoursColors(java.lang.String... contoursColors)` A list of separate String which has a list of comma-separated HEX color values to use for each isochrone contour.
`MapboxIsochrone.Builder`	`addContoursMinutes(java.lang.Integer... listOfMinuteValues)` An integer list of minute values to use for each isochrone contour.
`abstract MapboxIsochrone.Builder`	`baseUrl(java.lang.String baseUrl)` Optionally change the APIs base URL to something other then the default Mapbox one.
`MapboxIsochrone`	`build()` Build a new `MapboxIsochrone` object.
`MapboxIsochrone.Builder`	`coordinates(com.mapbox.geojson.Point queryPoint)` A `Point` object which represents a {longitude,latitude} coordinate pair around which to center the isochrone lines.
`abstract MapboxIsochrone.Builder`	`coordinates(java.lang.String queryPoint)` A string which represents a {longitude,latitude} coordinate pair around which to center the isochrone lines.
`abstract MapboxIsochrone.Builder`	`denoise(java.lang.Float denoise)` A floating point value from 0.0 to 1.0 that can be used to remove smaller contours.
`abstract MapboxIsochrone.Builder`	`generalize(java.lang.Float generalize)` A positive floating point value in meters used as the tolerance for Douglas-Peucker generalization.
`abstract MapboxIsochrone.Builder`	`polygons(java.lang.Boolean polygons)` Specify whether to return the contours as GeoJSON `Polygon` (true) or `LineString` (false).
`abstract MapboxIsochrone.Builder`	`profile(java.lang.String profile)` A Mapbox Directions routing profile ID.
`abstract MapboxIsochrone.Builder`	`user(java.lang.String user)` The username for the account that the Isochrone 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
  - baseUrl
```
public abstract MapboxIsochrone.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:
    
    4.6.0
  - accessToken
```
public abstract MapboxIsochrone.Builder accessToken(@NonNull
                                                    java.lang.String accessToken)
```
    A valid Mapbox access token.
    
    Parameters:
    
    accessToken - the Mapbox access token to use for the Isochrone API call
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - user
```
public abstract MapboxIsochrone.Builder user(@NonNull
                                             java.lang.String user)
```
    The username for the account that the Isochrone engine runs on. In most cases, this should always remain the default value of IsochroneCriteria.PROFILE_DEFAULT_USER.
    
    Parameters:
    
    user - a non-null string which will replace the default user used in the Isochrone request
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.7.0
  - profile
```
public abstract MapboxIsochrone.Builder profile(@Nullable
                                                java.lang.String profile)
```
    A Mapbox Directions routing profile ID. Options are IsochroneCriteria.PROFILE_DRIVING for travel times by car, IsochroneCriteria.PROFILE_WALKING for pedestrian and hiking travel times, and IsochroneCriteria.PROFILE_CYCLING for travel times by bicycle.
    
    Parameters:
    
    profile - a Mapbox Directions profile
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - coordinates
```
public MapboxIsochrone.Builder coordinates(@NonNull
                                           com.mapbox.geojson.Point queryPoint)
```
    A Point object which represents a {longitude,latitude} coordinate pair around which to center the isochrone lines.
    
    Parameters:
    
    queryPoint - center query point for the isochrone calculation
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - coordinates
```
public abstract MapboxIsochrone.Builder coordinates(@NonNull
                                                    java.lang.String queryPoint)
```
    A string which represents a {longitude,latitude} coordinate pair around which to center the isochrone lines. The String should be "longitude,latitude".
    
    Parameters:
    
    queryPoint - center query point for the isochrone calculation
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - addContoursMinutes
```
public MapboxIsochrone.Builder addContoursMinutes(@NonNull
                                                  java.lang.Integer... listOfMinuteValues)
```
    An integer list of minute values to use for each isochrone contour. You must pass in at least one minute amount and you can specify up to four contours. Times must be in increasing order. For example, "5,20,40,50" and not "20,10,40,55". The maximum time that can be specified is 60 minutes.
    
    Parameters:
    
    listOfMinuteValues - an integer list with at least one number for the minutes which represent each contour
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - addContoursColors
```
public MapboxIsochrone.Builder addContoursColors(@Nullable
                                                 java.lang.String... contoursColors)
```
    A list of separate String which has a list of comma-separated HEX color values to use for each isochrone contour.
    For example, .contoursColors("6706ce","04e813","4286f4")
    The colors should be specified as hex values without a leading # (for example, ff0000 for red). If this parameter is used, there must be the same number of colors as there are entries in contours_minutes. If no colors are specified, the Isochrone API will assign a default rainbow color scheme to the output.
    
    Parameters:
    
    contoursColors - the list of at least one color value to use for the polygon fill areas in the API response
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - polygons
```
public abstract MapboxIsochrone.Builder polygons(@Nullable
                                                 java.lang.Boolean polygons)
```
    Specify whether to return the contours as GeoJSON Polygon (true) or LineString (false). If no boolean is set, false is the default, which results in LineString being delivered.
    When polygons=true, any contour that forms a ring is returned as a Polygon.
    
    Parameters:
    
    polygons - a boolean whether you want the API response to include Polygon geometries to represent the various contours.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - denoise
```
public abstract MapboxIsochrone.Builder denoise(@Nullable
                                                java.lang.Float denoise)
```
    A floating point value from 0.0 to 1.0 that can be used to remove smaller contours. The default is 1.0. A value of 1.0 will only return the largest contour for a given time value. A value of 0.5 drops any contours that are less than half the area of the largest contour in the set of contours for that same time value.
    
    Parameters:
    
    denoise - an optional number to determine the shape of small contours
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - generalize
```
public abstract MapboxIsochrone.Builder generalize(@Nullable
                                                   java.lang.Float generalize)
```
    A positive floating point value in meters used as the tolerance for Douglas-Peucker generalization. There is no upper bound. If no value is specified in the request, the Isochrone API will choose the most optimized generalization to use for the request. Note that the generalization of contours can lead to self-intersections, as well as intersections of adjacent contours.
    
    Parameters:
    
    generalize - an optional number to determine how smooth or jagged the contour lines/polygons contours are
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0
  - build
```
public MapboxIsochrone build()
```
    Build a new MapboxIsochrone object.
    
    Returns:
    
    this builder for chaining options together
    
    Since:
    
    4.6.0

Class MapboxIsochrone.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

baseUrl

accessToken

user

profile

coordinates

coordinates

addContoursMinutes

addContoursColors

polygons

denoise

generalize

build