com.nbmap.api.optimization.v1.models

Class OptimizationWaypoint

java.lang.Object

com.nbmap.api.optimization.v1.models.OptimizationWaypoint

All Implemented Interfaces:

java.io.Serializable

public abstract class OptimizationWaypoint
extends java.lang.Object
implements java.io.Serializable

This is a single input coordinated snapped to the road and path network. The full list of the waypoints appear in the list in the order of the input coordinates.

Since:

2.2.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
OptimizationWaypoint()

Method Summary

Modifier and Type	Method and Description
static OptimizationWaypoint.Builder	builder() Create a new instance of this class by using the OptimizationWaypoint.Builder class.
com.nbmap.geojson.Point	location() A Point representing this waypoint location.
abstract java.lang.String	name() Provides the way name which the waypoint's coordinate is snapped to.
abstract OptimizationWaypoint.Builder	toBuilder() Convert the current OptimizationWaypoint to its builder holding the currently assigned values.
abstract int	tripsIndex() Index to the trip object in the trips array that contains this waypoint.
static com.google.gson.TypeAdapter<OptimizationWaypoint>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract int	waypointIndex() Index of the waypoint inside the optimization route.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptimizationWaypoint

public OptimizationWaypoint()

Method Detail

builder

@NonNull
public static OptimizationWaypoint.Builder builder()

Create a new instance of this class by using the OptimizationWaypoint.Builder class.

Returns:

this classes OptimizationWaypoint.Builder for creating a new instance

Since:

3.0.0

waypointIndex

@SerializedName(value="waypoint_index")
public abstract int waypointIndex()

Index of the waypoint inside the optimization route.

Returns:

index value

Since:

2.2.0

tripsIndex

@SerializedName(value="trips_index")
public abstract int tripsIndex()

Index to the trip object in the trips array that contains this waypoint.

Returns:

index value

Since:

2.2.0

name

@Nullable
public abstract java.lang.String name()

Provides the way name which the waypoint's coordinate is snapped to.

Returns:

string with the name of the way the coordinate snapped to

Since:

2.2.0

location

@Nullable
public com.nbmap.geojson.Point location()

A Point representing this waypoint location.

Returns:

GeoJson Point representing this waypoint location

Since:

3.0.0

toBuilder

public abstract OptimizationWaypoint.Builder toBuilder()

Convert the current OptimizationWaypoint to its builder holding the currently assigned values. This allows you to modify a single variable and then rebuild the object resulting in an updated and modified OptimizationWaypoint.

Returns:

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

Since:

3.1.0

typeAdapter

public static com.google.gson.TypeAdapter<OptimizationWaypoint> 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