StepIntersection (services-directions-models API)

java.lang.Object
- com.mapbox.api.directions.v5.models.DirectionsJsonObject
- - com.mapbox.api.directions.v5.models.StepIntersection

All Implemented Interfaces:

java.io.Serializable
```
public abstract class StepIntersection
extends DirectionsJsonObject
```
Object representing an intersection along the step.

Since:

1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StepIntersection.Builder
This builder can be used to set the values describing the StepIntersection.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StepIntersection.Builder` This builder can be used to set the values describing the `StepIntersection`.

Constructor Summary

Constructors
Constructor and Description

StepIntersection()

Constructors
Constructor and Description
`StepIntersection()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract java.lang.Integer`	`adminIndex()` The zero-based index into the admin list on the route leg for this intersection.
`abstract java.util.List<java.lang.Integer>`	`bearings()` An integer list of bearing values available at the step intersection.
`static StepIntersection.Builder`	`builder()` Create a new instance of this class by using the `StepIntersection.Builder` class.
`abstract java.util.List<java.lang.String>`	`classes()` A list of strings signifying the classes of the road exiting the intersection.
`abstract java.util.List<java.lang.Boolean>`	`entry()` A list of entry flags, corresponding in a 1:1 relationship to the bearings.
`static StepIntersection`	`fromJson(java.lang.String json)` Create a new instance of this class by passing in a formatted valid JSON String.
`abstract java.lang.Integer`	`geometryIndex()` The zero-based index for the intersection.
`abstract java.lang.Integer`	`in()` Index into bearings/entry array.
`abstract Interchange`	`interchange()`
`abstract java.lang.Boolean`	`isUrban()` A boolean indicating whether the road exiting the intersection is considered to be in an urban area.
`abstract Junction`	`junction()`
`abstract java.util.List<IntersectionLanes>`	`lanes()` Array of lane objects that represent the available turn lanes at the intersection.
`com.mapbox.geojson.Point`	`location()` A `Point` representing this intersection location.
`abstract MapboxStreetsV8`	`mapboxStreetsV8()` An object containing detailed information about the road exiting the intersection along the route.
`abstract MergingArea`	`mergingArea()` Object containing information about merging area starting at intersection.
`abstract java.lang.Integer`	`out()` Index out of the bearings/entry array.
`abstract java.lang.Boolean`	`railwayCrossing()` Indicates whether there is a railway crossing at the intersection.
`protected abstract double[]`	`rawLocation()` A `Point` representing this intersection location.
`abstract RestStop`	`restStop()` An object containing information about passing rest stops along the route.
`abstract java.lang.Boolean`	`stopSign()` Indicates whether there is a stop sign at the intersection.
`abstract StepIntersection.Builder`	`toBuilder()` Convert the current `StepIntersection` to its builder holding the currently assigned values.
`abstract TollCollection`	`tollCollection()` An object containing information about a toll collection point along the route.
`abstract java.lang.Boolean`	`trafficSignal()` Indicates whether there is a traffic signal at the intersection.
`abstract java.lang.String`	`tunnelName()` Name of the tunnel.
`static com.google.gson.TypeAdapter<StepIntersection>`	`typeAdapter(com.google.gson.Gson gson)` Gson type adapter for parsing Gson to this class.
`abstract java.lang.Boolean`	`yieldSign()` Indicates whether there is a yield sign at the intersection.

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
  - StepIntersection
```
public StepIntersection()
```
- Method Detail
  - builder
```
public static StepIntersection.Builder builder()
```
    Create a new instance of this class by using the StepIntersection.Builder class.
    
    Returns:
    
    this classes StepIntersection.Builder for creating a new instance
    
    Since:
    
    3.0.0
  - location
```
@NonNull
public com.mapbox.geojson.Point location()
```
    A Point representing this intersection location.
    
    Returns:
    
    GeoJson Point representing this intersection location
    
    Since:
    
    3.0.0
  - rawLocation
```
@NonNull
 @SerializedName(value="location")
protected abstract double[] rawLocation()
```
    A Point representing this intersection location. Since the rawLocation isn't public, it's okay to be mutable as long as nothing in this SDK changes values.
    
    Returns:
    
    GeoJson Point representing this intersection location
    
    Since:
    
    3.0.0
  - bearings
```
@Nullable
public abstract java.util.List<java.lang.Integer> bearings()
```
    An integer list of bearing values available at the step intersection.
    
    Returns:
    
    An array of bearing values (for example [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.
    
    Since:
    
    1.3.0
  - classes
```
@Nullable
public abstract java.util.List<java.lang.String> classes()
```
    A list of strings signifying the classes of the road exiting the intersection. Possible values:
    - toll: the road continues on a toll road
    - ferry: the road continues on a ferry
    - restricted: the road continues on with access restrictions
    - motorway: the road continues on a motorway
    - tunnel: the road continues on a tunnel
    Returns:
    
    a string list containing the classes of the road exiting the intersection
    
    Since:
    
    3.0.0
  - entry
```
@Nullable
public abstract java.util.List<java.lang.Boolean> entry()
```
    A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.
    
    Returns:
    
    a list of entry flags, corresponding in a 1:1 relationship to the bearings
    
    Since:
    
    1.3.0
  - in
```
@Nullable
public abstract java.lang.Integer in()
```
    Index into bearings/entry array. Used to calculate the bearing before the turn. Namely, the clockwise angle from true north to the direction of travel before the maneuver/passing the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for departure maneuvers.
    
    Returns:
    
    index into bearings/entry array
    
    Since:
    
    1.3.0
  - out
```
@Nullable
public abstract java.lang.Integer out()
```
    Index out of the bearings/entry array. Used to extract the bearing after the turn. Namely, The clockwise angle from true north to the direction of travel after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.
    
    Returns:
    
    index out of the bearings/entry array
    
    Since:
    
    1.3.0
  - lanes
```
@Nullable
public abstract java.util.List<IntersectionLanes> lanes()
```
    Array of lane objects that represent the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present. Lanes are provided in their order on the street, from left to right.
    
    Returns:
    
    array of lane objects that represent the available turn lanes at the intersection
    
    Since:
    
    2.0.0
  - geometryIndex
```
@Nullable
 @SerializedName(value="geometry_index")
public abstract java.lang.Integer geometryIndex()
```
    The zero-based index for the intersection. This value can be used to apply the duration annotation that corresponds with the intersection. Only available on the driving profile.
    
    Returns:
    
    index for the intersection
  - isUrban
```
@Nullable
 @SerializedName(value="is_urban")
public abstract java.lang.Boolean isUrban()
```
    A boolean indicating whether the road exiting the intersection is considered to be in an urban area. This value is determined by the density of the surrounding road network. Only available on the DirectionsCriteria.PROFILE_DRIVING profile.
    
    Returns:
    
    a value indicating whether the road exiting the intersection is in an urban area
  - adminIndex
```
@Nullable
 @SerializedName(value="admin_index")
public abstract java.lang.Integer adminIndex()
```
    The zero-based index into the admin list on the route leg for this intersection. Use this field to look up the ISO-3166-1 country code for this point on the route. Only available on the `driving` profile.
    
    Returns:
    
    a zero-based index into the admin list on the route leg.
    
    See Also:
    
    RouteLeg.admins()
  - restStop
```
@Nullable
 @SerializedName(value="rest_stop")
public abstract RestStop restStop()
```
    An object containing information about passing rest stops along the route. Only available on the `driving` profile.
    
    Returns:
    
    an object containing information about passing rest stops along the route.
  - tollCollection
```
@Nullable
 @SerializedName(value="toll_collection")
public abstract TollCollection tollCollection()
```
    An object containing information about a toll collection point along the route. This is a payment booth or overhead electronic gantry payment booth or overhead electronic gantry where toll charge is collected. Only available on the DirectionsCriteria.PROFILE_DRIVING profile.
    
    Returns:
    
    an object containing information about a toll collection point along the route.
  - mapboxStreetsV8
```
@Nullable
 @SerializedName(value="mapbox_streets_v8")
public abstract MapboxStreetsV8 mapboxStreetsV8()
```
    An object containing detailed information about the road exiting the intersection along the route. Properties in this object correspond to properties in the classes() specification. Only available on the DirectionsCriteria.PROFILE_DRIVING profile.
    
    Returns:
    
    an object containing detailed road information.
  - tunnelName
```
@Nullable
 @SerializedName(value="tunnel_name")
public abstract java.lang.String tunnelName()
```
    Name of the tunnel. Value may be present if classes() contains "tunnel".
    
    Returns:
    
    name of the tunnel
  - railwayCrossing
```
@Nullable
 @SerializedName(value="railway_crossing")
public abstract java.lang.Boolean railwayCrossing()
```
    Indicates whether there is a railway crossing at the intersection.
    
    Returns:
    
    whether there is a railway crossing at the intersection
  - trafficSignal
```
@Nullable
 @SerializedName(value="traffic_signal")
public abstract java.lang.Boolean trafficSignal()
```
    Indicates whether there is a traffic signal at the intersection.
    
    Returns:
    
    whether there is a traffic signal at the intersection
  - stopSign
```
@Nullable
 @SerializedName(value="stop_sign")
public abstract java.lang.Boolean stopSign()
```
    Indicates whether there is a stop sign at the intersection.
    
    Returns:
    
    whether there is a stop sign at the intersection
  - yieldSign
```
@Nullable
 @SerializedName(value="yield_sign")
public abstract java.lang.Boolean yieldSign()
```
    Indicates whether there is a yield sign at the intersection.
    
    Returns:
    
    whether there is a yield sign at the intersection
  - interchange
```
@Nullable
 @SerializedName(value="ic")
public abstract Interchange interchange()
```
  - junction
```
@Nullable
 @SerializedName(value="jct")
public abstract Junction junction()
```
  - mergingArea
```
@Nullable
 @SerializedName(value="merging_area")
public abstract MergingArea mergingArea()
```
    Object containing information about merging area starting at intersection.
    
    Returns:
    
    MergingArea object if present, null otherwise.
  - toBuilder
```
public abstract StepIntersection.Builder toBuilder()
```
    Convert the current StepIntersection to its builder holding the currently assigned values. This allows you to modify a single property and then rebuild the object resulting in an updated and modified StepIntersection.
    
    Returns:
    
    a StepIntersection.Builder with the same values set to match the ones defined in this StepIntersection
    
    Since:
    
    3.1.0
  - typeAdapter
```
public static com.google.gson.TypeAdapter<StepIntersection> typeAdapter(com.google.gson.Gson gson)
```
    Gson type adapter for parsing Gson to this class.
    
    Parameters:
    
    gson - the built Gson object
    
    Returns:
    
    the type adapter for this class
    
    Since:
    
    3.0.0
  - fromJson
```
public static StepIntersection fromJson(java.lang.String json)
```
    Create a new instance of this class by passing in a formatted valid JSON String.
    
    Parameters:
    
    json - a formatted valid JSON string defining a StepIntersection
    
    Returns:
    
    a new instance of this class defined by the values passed inside this static factory method
    
    Since:
    
    3.4.0

Class StepIntersection

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

StepIntersection

Method Detail

builder

location

rawLocation

bearings

classes

entry

in

out

lanes

geometryIndex

isUrban

adminIndex

restStop

tollCollection

mapboxStreetsV8

tunnelName

railwayCrossing

trafficSignal

stopSign

yieldSign

interchange

junction

mergingArea

toBuilder

typeAdapter

fromJson