com.mapbox.api.directions.v5.models

Class Exclude

java.lang.Object

com.mapbox.api.directions.v5.models.DirectionsJsonObject

com.mapbox.api.directions.v5.models.Exclude

All Implemented Interfaces:

java.io.Serializable

public abstract class Exclude
extends DirectionsJsonObject

Defines excludes for RouteOptions.Builder.excludeObject(Exclude). This class provides type-safe way to read and build RouteOptions.exclude() parameter. All properties are strictly categorized after parsing. Unknown data types or flags are ignored. If you want to work with exclude criteria which is not yet supported, consider using raw RouteOptions.exclude() directly.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Exclude.Builder Use this builder to build an Exclude object.

Constructor Summary

Constructors

Constructor and Description
Exclude()

Method Summary

Modifier and Type	Method and Description
static Exclude.Builder	builder() Build a new instance of Exclude.
abstract java.util.List<java.lang.String>	criteria() Exclude certain road types from routing.
abstract java.util.List<com.mapbox.geojson.Point>	points() Exclude certain points from routing.

Methods inherited from class com.mapbox.api.directions.v5.models.DirectionsJsonObject

getUnrecognizedJsonProperties, getUnrecognizedPropertiesNames, getUnrecognizedProperty, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Exclude

public Exclude()

Method Detail

builder

@NonNull
public static Exclude.Builder builder()

Build a new instance of Exclude. Nothing is excluded by default.

criteria

@Nullable
public abstract java.util.List<java.lang.String> criteria()

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

Returns:

a list of strings matching one of the DirectionsCriteria.ExcludeCriteria exclusions

points

@Nullable
public abstract java.util.List<com.mapbox.geojson.Point> points()

Exclude certain points from routing. The default is to not exclude anything.

Returns:

a list of points excluded from the routing.