com.tomtom.online.sdk.data.reachablerange

Class ReachableRangeParamsBuilder

java.lang.Object

com.tomtom.online.sdk.data.reachablerange.ReachableRangeParamsBuilder

All Implemented Interfaces:

com.tomtom.online.sdk.common.jni.JniNativeHandleOwner, ReachableRangeParams

public class ReachableRangeParamsBuilder
extends java.lang.Object
implements ReachableRangeParams

Class used for building parameters of reachable range query using native handle from ReachableRangeParams interface.

Field Summary

Fields inherited from interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

EMPTY_HANDLE

Constructor Summary

Constructors

Constructor and Description
ReachableRangeParamsBuilder(LatLng origin) Creates an instance of ReachableRangeParamsBuilder with given point of origin.

Method Summary

Modifier and Type	Method and Description
void	dispose()
long	getNativeHandle()
ReachableRangeParams	withEnergyBudgetInKWh(java.lang.Double energyBudgetInKWh) Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be travelled using the specified Electric Consumption Model.
ReachableRangeParams	withFuelBudgetInLiters(java.lang.Double fuelBudgetInLiters) Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model.
ReachableRangeParams	withTimeBudgetInSeconds(java.lang.Double timeBudgetInSeconds) Time budget in seconds that determines the maximum range that can be travelled within given time.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReachableRangeParamsBuilder

public ReachableRangeParamsBuilder(LatLng origin)
                            throws java.lang.IllegalArgumentException

Creates an instance of ReachableRangeParamsBuilder with given point of origin.

Parameters:

origin - point from which the range calculation should start

Throws:

java.lang.IllegalArgumentException

Method Detail

getNativeHandle

public long getNativeHandle()

Specified by:

getNativeHandle in interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

dispose

public void dispose()

Specified by:

dispose in interface com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

withFuelBudgetInLiters

@NonNull
public ReachableRangeParams withFuelBudgetInLiters(java.lang.Double fuelBudgetInLiters)

Description copied from interface: ReachableRangeParams

Fuel budget in liters that determines the maximum range that can be travelled using the specified Combustion Consumption Model. Required only for vehicles with combustion engine if ReachableRangeParams.withTimeBudgetInSeconds(Double) is not used.

Specified by:

withFuelBudgetInLiters in interface ReachableRangeParams

Returns:

reference to the ReachableRangeParams object

withEnergyBudgetInKWh

@NonNull
public ReachableRangeParams withEnergyBudgetInKWh(java.lang.Double energyBudgetInKWh)

Description copied from interface: ReachableRangeParams

Electric energy budget in kilowatt hours (kWh) that determines the maximum range that can be travelled using the specified Electric Consumption Model. Required only for vehicles with electric engine if ReachableRangeParams.withTimeBudgetInSeconds(Double) is not used.

Specified by:

withEnergyBudgetInKWh in interface ReachableRangeParams

Returns:

reference to the ReachableRangeParams object

withTimeBudgetInSeconds

@NonNull
public ReachableRangeParams withTimeBudgetInSeconds(java.lang.Double timeBudgetInSeconds)

Description copied from interface: ReachableRangeParams

Time budget in seconds that determines the maximum range that can be travelled within given time. The consumption parameters will only affect eco-routes and thereby indirectly the driving time. Required only if neither ReachableRangeParams.withFuelBudgetInLiters(Double) nor ReachableRangeParams.withEnergyBudgetInKWh(Double) are called.

Specified by:

withTimeBudgetInSeconds in interface ReachableRangeParams

Returns:

reference to the ReachableRangeParams object