MapboxOptimizedTrips.Builder (libjava-services 2.2.2 API)

java.lang.Object
- com.mapbox.services.api.MapboxBuilder
- - com.mapbox.services.api.optimizedtrips.v1.MapboxOptimizedTrips.Builder<T>

Enclosing class:: MapboxOptimizedTrips

public static class MapboxOptimizedTrips.Builder<T extends MapboxOptimizedTrips.Builder>
extends MapboxBuilder

Optimized Trips v1 builder

Since:: 2.1.0

Field Summary
- Fields inherited from class com.mapbox.services.api.MapboxBuilder
  baseUrl, clientAppName

Constructor Summary

Constructors
Constructor and Description

Builder()
Constructor

Constructors
Constructor and Description
`Builder()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MapboxOptimizedTrips`	`build()` Build method
`java.lang.String`	`getAccessToken()`
`java.lang.String[]`	`getAnnotation()` Deprecated. Use `getAnnotations()`
`java.lang.String[]`	`getAnnotations()` Determine whether or not you are currently requesting additional metadata along the route.
`java.lang.String`	`getBearings()` Determine whether you are filtering the road segment the waypoint will be placed on by direction and dictating the angle of approach.
`java.lang.String`	`getCoordinates()` Set the list of coordinates for the Optimized Trips service.
`java.lang.String`	`getDestination()` Returned route ends at `DirectionsCriteria.SOURCE_ANY` or `DirectionsCriteria.SOURCE_LAST` coordinate.
`java.lang.String`	`getDistributions()` If distribution values are set inside your request, this will return a String containing the given values.
`java.lang.String`	`getGeometries()` The SDK currently only supports `Polyline` geometry (not GeoJSON) to simplify the response.
`java.lang.String`	`getLanguage()`
`java.lang.String`	`getOverview()` Determine whether you want the route geometry to be full, simplified, etc.
`java.lang.String`	`getProfile()` The current profile set for usage with the Optimized Trips API.
`java.lang.String`	`getRadiuses()` Get the maximum distance in meters you have set that each coordinate is allowed to move when snapped to a nearby road segment.
`java.lang.Boolean`	`getRoundTrip()` set whether the route is a roundtrip (route returns to first location).
`java.lang.String`	`getSource()` Returned route starts at `DirectionsCriteria.SOURCE_ANY` (default )or `DirectionsCriteria.SOURCE_FIRST` coordinate.
`java.lang.Boolean`	`getSteps()` Determine whether or not you are requesting for the steps information or not in your request.
`java.lang.String`	`getUser()`
`T`	`setAccessToken(java.lang.String accessToken)` Required to call when building `MapboxOptimizedTrips.Builder`.
`T`	`setAnnotation(java.lang.String... annotation)` Deprecated. use `getAnnotations()` instead
`T`	`setAnnotations(java.lang.String... annotation)` Whether or not to return additional metadata along the route.
`T`	`setBaseUrl(java.lang.String baseUrl)` Optionally change the APIs base URL to something other then the default Mapbox one.
`T`	`setBearings(double[]... bearings)` Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach.
`T`	`setClientAppName(java.lang.String appName)` Base package name or other simple string identifier
`T`	`setCoordinates(java.util.List<com.mapbox.services.commons.models.Position> coordinates)` Set the list of coordinates for the Optimized Trips service.
`T`	`setDestination(java.lang.String destination)` Returned route ends at `DirectionsCriteria.SOURCE_ANY` or `DirectionsCriteria.SOURCE_LAST` coordinate.
`T`	`setDistributions(double[]... distributions)` Specify pick-up and drop-off locations for a trip by providing a `double[]` each with a number pair that correspond with the coordinates list.
`T`	`setGeometries(java.lang.String geometries)` The SDK currently only supports `Polyline` geometry (not GeoJSON) to simplify the response.
`T`	`setLanguage(java.lang.String language)` Optionally set the language of returned turn-by-turn text instructions.
`T`	`setOverview(java.lang.String overview)` Optionally, set whether you want the route geometry to be full, simplified, etc.
`T`	`setProfile(java.lang.String profile)`
`T`	`setRadiuses(double[] radiuses)` Optionally, set the maximum distance in meters that each coordinate is allowed to move when snapped to a nearby road segment.
`T`	`setRoundTrip(java.lang.Boolean roundTrip)` set whether the route is a roundtrip (route returns to first location).
`T`	`setSource(java.lang.String source)` Returned route starts at `DirectionsCriteria.SOURCE_ANY` (default )or `DirectionsCriteria.SOURCE_FIRST` coordinate.
`T`	`setSteps(java.lang.Boolean steps)` Optionally, call if you'd like to include step information within route.
`T`	`setUser(java.lang.String user)`

Methods inherited from class com.mapbox.services.api.MapboxBuilder
getBaseUrl, getClientAppName, validateAccessToken

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

- Constructor Detail
  - Builder
```
public Builder()
```
    Constructor
    
    Since:
    
    2.1.0
- Method Detail
  - setAccessToken
```
public T setAccessToken(java.lang.String accessToken)
```
    Required to call when building MapboxOptimizedTrips.Builder.
    
    Specified by:
    
    setAccessToken in class MapboxBuilder
    
    Parameters:
    
    accessToken - Mapbox access token, You must have a Mapbox account inorder to use the Optimized Trip API.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setUser
```
public T setUser(java.lang.String user)
```
    Parameters:
    
    user - User string
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setProfile
```
public T setProfile(java.lang.String profile)
```
    Parameters:
    
    profile - Profile string
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setCoordinates
```
public T setCoordinates(java.util.List<com.mapbox.services.commons.models.Position> coordinates)
```
    Set the list of coordinates for the Optimized Trips service. If you've previously set an origin with setOrigin() or a destination with setDestination(), those will be overridden.
    
    Parameters:
    
    coordinates - List of Position giving origin and destination(s) coordinates.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setRoundTrip
```
public T setRoundTrip(java.lang.Boolean roundTrip)
```
    set whether the route is a roundtrip (route returns to first location). This defaults to true, but must be carefully set depending on whether you have used setSource(String) and setDestination(String).
    
    Parameters:
    
    roundTrip - boolean true if you'd like the route to return to original position, else false.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setSource
```
public T setSource(java.lang.String source)
```
    Returned route starts at DirectionsCriteria.SOURCE_ANY (default )or DirectionsCriteria.SOURCE_FIRST coordinate.
    
    Parameters:
    
    source - either "any" or "first".
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setDestination
```
public T setDestination(java.lang.String destination)
```
    Returned route ends at DirectionsCriteria.SOURCE_ANY or DirectionsCriteria.SOURCE_LAST coordinate.
    
    Parameters:
    
    destination - either "any" or "last".
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setGeometries
```
public T setGeometries(java.lang.String geometries)
```
    The SDK currently only supports Polyline geometry (not GeoJSON) to simplify the response. You do have the option on whether the precision is 5 or 6 using either DirectionsCriteria.GEOMETRY_POLYLINE or DirectionsCriteria.GEOMETRY_POLYLINE6.
    
    Parameters:
    
    geometries - A String constant which equals either "polyline" or "polyline6".
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setRadiuses
```
public T setRadiuses(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:
    
    Builder
    
    Since:
    
    2.1.0
  - setOverview
```
public T setOverview(java.lang.String overview)
```
    Optionally, set whether you want the route geometry to be full, simplified, etc.
    
    Parameters:
    
    overview - String defining type of overview you'd like the API to give. Use one of the constants.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setSteps
```
public T setSteps(java.lang.Boolean steps)
```
    Optionally, call if you'd like to include step information within route.
    
    Parameters:
    
    steps - true if you'd like step information.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setBearings
```
public T setBearings(double[]... bearings)
```
    Optionally, Use to filter the road segment the waypoint will be placed on by direction and dictates the angle of approach. This option should always be used in conjunction with the setRadiuses(double[]) parameter. The parameter takes two values per waypoint: the first is an angle clockwise from true north between 0 and 360. The second is the range of degrees the angle can deviate by. We recommend a value of 45 degrees or 90 degrees for the range, as bearing measurements tend to be inaccurate. This is useful for making sure we reroute vehicles on new routes that 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. If provided, the list of bearings must be the same length as the list of waypoints, but you can skip a coordinate and show its position by passing in a double array with no values included like so: new double[] {}.
    
    Parameters:
    
    bearings - a double array with two values indicating the angle and the other value indicating the deviating range.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setAnnotation
```
@Deprecated
public T setAnnotation(java.lang.String... annotation)
```
    Deprecated. use getAnnotations() instead
    
    Whether or not to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, and DirectionsCriteria.ANNOTATION_SPEED. Several annotations can be used by separating them with ,.
    
    Parameters:
    
    annotation - String referencing one of the annotations direction criteria's.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
    
    See Also:
    
    RouteLeg object documentation
  - setAnnotations
```
public T setAnnotations(java.lang.String... annotation)
```
    Whether or not to return additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, and DirectionsCriteria.ANNOTATION_SPEED. Several annotations can be used by separating them with ,.
    
    Parameters:
    
    annotation - String referencing one of the annotations direction criteria's.
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
    
    See Also:
    
    RouteLeg object documentation
  - setBaseUrl
```
public T setBaseUrl(java.lang.String baseUrl)
```
    Optionally change the APIs base URL to something other then the default Mapbox one.
    
    Specified by:
    
    setBaseUrl in class MapboxBuilder
    
    Parameters:
    
    baseUrl - base url used as end point
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setClientAppName
```
public T setClientAppName(java.lang.String appName)
```
    Base package name or other simple string identifier
    
    Specified by:
    
    setClientAppName in class MapboxBuilder
    
    Parameters:
    
    appName - base package name or other simple string identifier
    
    Returns:
    
    Builder
    
    Since:
    
    2.1.0
  - setLanguage
```
public T setLanguage(java.lang.String language)
```
    Optionally set the language of returned turn-by-turn text instructions. The default is en for English.
    
    Parameters:
    
    language - The locale in which results should be returned.
    
    Returns:
    
    Builder
    
    Since:
    
    2.2.0
    
    See Also:
    
    Supported languages
  - setDistributions
```
public T setDistributions(double[]... distributions)
```
    Specify pick-up and drop-off locations for a trip by providing a double[] each with a number pair that correspond with the coordinates list. The first number indicates what place the coordinate of the pick-up location is in the coordinates list, and the second number indicates what place the coordinate of the drop-off location is in the coordinates list. Each pair must contain exactly two numbers. Pick-up and drop-off locations in one pair cannot be the same. The returned solution will visit pick-up locations before visiting drop-off locations. The depot (first location) can only be a pick-up location but not a drop-off location.
    
    Parameters:
    
    distributions - double[] with two values, first being the pickup coordinate in the coordinates list and the second number being the coordinate in the coordinates list which should be the drop off location.
    
    Returns:
    
    Builder
    
    Since:
    
    2.2.0
  - getProfile
```
public java.lang.String getProfile()
```
    The current profile set for usage with the Optimized Trips API.
    
    Returns:
    
    DirectionsCriteria.PROFILE_DRIVING, DirectionsCriteria.PROFILE_CYCLING, or DirectionsCriteria.PROFILE_WALKING
    
    Since:
    
    2.1.0
  - getRoundTrip
```
public java.lang.Boolean getRoundTrip()
```
    set whether the route is a roundtrip (route returns to first location). This defaults to true, but must be carefully set depending on whether you have used setSource(String) and setDestination(String).
    
    Returns:
    
    boolean true if MapboxOptimizedTrips has been set to have the route return to original position, else false.
    
    Since:
    
    2.1.0
  - getSource
```
public java.lang.String getSource()
```
    Returned route starts at DirectionsCriteria.SOURCE_ANY (default )or DirectionsCriteria.SOURCE_FIRST coordinate.
    
    Returns:
    
    either "any" or "first".
    
    Since:
    
    2.1.0
  - getDestination
```
public java.lang.String getDestination()
```
    Returned route ends at DirectionsCriteria.SOURCE_ANY or DirectionsCriteria.SOURCE_LAST coordinate.
    
    Returns:
    
    either "any" or "last".
    
    Since:
    
    2.1.0
  - getCoordinates
```
public java.lang.String getCoordinates()
```
    Set the list of coordinates for the Optimized Trips service. If you've previously set an origin with setOrigin() or a destination with setDestination(), those will be overridden.
    
    Returns:
    
    List of Position giving origin and destination(s) coordinates.
    
    Since:
    
    2.1.0
  - getGeometries
```
public java.lang.String getGeometries()
```
    The SDK currently only supports Polyline geometry (not GeoJSON) to simplify the response. You do have the option on whether the precision is 5 or 6 using either DirectionsCriteria.GEOMETRY_POLYLINE or DirectionsCriteria.GEOMETRY_POLYLINE6.
    
    Returns:
    
    a String constant which equals either "polyline" or "polyline6".
    
    Since:
    
    2.1.0
  - getRadiuses
```
public java.lang.String getRadiuses()
```
    Get the maximum distance in meters you have set that each coordinate is allowed to move when snapped to a nearby road segment.
    
    Returns:
    
    String containing the radiuses defined in unit meters.
    
    Since:
    
    2.1.0
  - getUser
```
public java.lang.String getUser()
```
    Returns:
    
    User string
    
    Since:
    
    2.1.0
  - getOverview
```
public java.lang.String getOverview()
```
    Determine whether you want the route geometry to be full, simplified, etc.
    
    Returns:
    
    String defining type of overview you'd like the API to give. Use one of the constants.
    
    Since:
    
    2.1.0
  - getSteps
```
public java.lang.Boolean getSteps()
```
    Determine whether or not you are requesting for the steps information or not in your request.
    
    Returns:
    
    true if you'd like step information.
    
    Since:
    
    2.1.0
  - getBearings
```
public java.lang.String getBearings()
```
    Determine whether you are filtering the road segment the waypoint will be placed on by direction and dictating the angle of approach.
    
    Returns:
    
    String with two values indicating the angle and the other value indicating the deviating range.
    
    Since:
    
    2.1.0
  - getAnnotation
```
@Deprecated
public java.lang.String[] getAnnotation()
```
    Deprecated. Use getAnnotations()
    
    Determine whether or not you are currently requesting additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, and DirectionsCriteria.ANNOTATION_SPEED. Several annotations can be used by separating them with ,.
    
    Returns:
    
    String referencing one of the annotations direction criteria's.
    
    Since:
    
    2.1.0
  - getAnnotations
```
public java.lang.String[] getAnnotations()
```
    Determine whether or not you are currently requesting additional metadata along the route. Possible values are: DirectionsCriteria.ANNOTATION_DISTANCE, DirectionsCriteria.ANNOTATION_DURATION, and DirectionsCriteria.ANNOTATION_SPEED. Several annotations can be used by separating them with ,.
    
    Returns:
    
    String referencing one of the annotations direction criteria's.
    
    Since:
    
    2.1.0
  - getAccessToken
```
public java.lang.String getAccessToken()
```
    Specified by:
    
    getAccessToken in class MapboxBuilder
    
    Returns:
    
    your Mapbox access token.
    
    Since:
    
    2.1.0
  - getLanguage
```
public java.lang.String getLanguage()
```
    Returns:
    
    The language the turn-by-turn directions will be in.
    
    Since:
    
    2.2.0
  - getDistributions
```
public java.lang.String getDistributions()
```
    If distribution values are set inside your request, this will return a String containing the given values.
    
    Returns:
    
    String containing the provided distribution values.
    
    Since:
    
    2.2.0
  - build
```
public MapboxOptimizedTrips build()
                           throws ServicesException
```
    Build method
    
    Specified by:
    
    build in class MapboxBuilder
    
    Returns:
    
    MapboxOptimizedTrips
    
    Throws:
    
    ServicesException - occurs if your request you've built isn't valid and/or contains errors.
    
    Since:
    
    2.1.0

Class MapboxOptimizedTrips.Builder<T extends MapboxOptimizedTrips.Builder>

Field Summary

Fields inherited from class com.mapbox.services.api.MapboxBuilder

Constructor Summary

Method Summary

Methods inherited from class com.mapbox.services.api.MapboxBuilder

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setAccessToken

setUser

setProfile

setCoordinates

setRoundTrip

setSource

setDestination

setGeometries

setRadiuses

setOverview

setSteps

setBearings

setAnnotation

setAnnotations

setBaseUrl

setClientAppName

setLanguage

setDistributions

getProfile

getRoundTrip

getSource

getDestination

getCoordinates

getGeometries

getRadiuses

getUser

getOverview

getSteps

getBearings

getAnnotation

getAnnotations

getAccessToken

getLanguage

getDistributions

build