com.mapbox.api.directions.v5.models

Class Bearing

java.lang.Object

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

com.mapbox.api.directions.v5.models.Bearing

All Implemented Interfaces:

java.io.Serializable

public abstract class Bearing
extends DirectionsJsonObject

A value pair of an angle() which is a clockwise value from true north between 0 and 360, and a degrees() which is the range of degrees by which the angle can deviate.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bearing.Builder This builder can be used to set the values describing the Bearing.

Constructor Summary

Constructors

Constructor and Description
Bearing()

Method Summary

Modifier and Type	Method and Description
abstract double	angle() Clockwise value from true north between 0 and 360.
static Bearing.Builder	builder() Build a new instance of this builder.
abstract double	degrees() Range of degrees by which the angle can deviate.
abstract Bearing.Builder	toBuilder() Convert the current Bearing to its builder holding the currently assigned values.

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

Bearing

public Bearing()

Method Detail

builder

public static Bearing.Builder builder()

Build a new instance of this builder.

Returns:

Bearing.Builder

angle

public abstract double angle()

Clockwise value from true north between 0 and 360.

Defaults to 45°.

Returns:

value

degrees

public abstract double degrees()

Range of degrees by which the angle can deviate.

Defaults to 90°.

Returns:

value

toBuilder

@NonNull
public abstract Bearing.Builder toBuilder()

Convert the current Bearing 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 Bearing.

Returns:

a Bearing.Builder with the same values set to match the ones defined in this Bearing