com.tomtom.online.sdk.data

Class CommonParamsBuilder

java.lang.Object

com.tomtom.online.sdk.data.CommonParamsBuilder

All Implemented Interfaces:

com.tomtom.online.sdk.common.jni.JniNativeHandleOwner, CommonParams<CommonParamsBuilder>, PostCommonParams<CommonParamsBuilder>, SupportsReportParam<CommonParamsBuilder>

public class CommonParamsBuilder
extends java.lang.Object
implements CommonParams<CommonParamsBuilder>, PostCommonParams<CommonParamsBuilder>, SupportsReportParam<CommonParamsBuilder>, com.tomtom.online.sdk.common.jni.JniNativeHandleOwner

Class used for building commonly used params using native handle to native service.

Field Summary

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

EMPTY_HANDLE

Constructor Summary

Constructors

Constructor and Description
CommonParamsBuilder() Constructor for params builder that creates a native handle.

Method Summary

Modifier and Type	Method and Description
void	dispose()
long	getNativeHandle()
CommonParamsBuilder	withAccelerationEfficiency(java.lang.Double accelerationEfficiency) Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e.
CommonParamsBuilder	withAllowVignettes(java.util.List<java.lang.String> allowVignettes) A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which toll roads with vignettes are allowed.
CommonParamsBuilder	withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW) Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW).
CommonParamsBuilder	withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour) Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour.
CommonParamsBuilder	withAvoidAreas(java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas) A list of rectangles that define areas that are to be avoided during reachable range calculation.
CommonParamsBuilder	withAvoidType(Avoid avoidType) Specifies what the route calculation should try to avoid when determining the route.
CommonParamsBuilder	withAvoidVignettes(java.util.List<java.lang.String> avoidVignettes) A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided.
CommonParamsBuilder	withConsiderTraffic(java.lang.Boolean considerTraffic) Specifies if all available traffic information should be considered during routing.
CommonParamsBuilder	withConstantSpeedConsumptionInKWhPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm) Specifies the speed-dependent component of consumption.
CommonParamsBuilder	withConstantSpeedConsumptionInLitersPerHundredKm(SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm) Specifies the speed-dependent component of consumption.
CommonParamsBuilder	withCurrentChargeInKWh(java.lang.Double currentChargeInKWh) Specifies the current electric energy supply in kilowatt hours (kWh).
CommonParamsBuilder	withCurrentFuelInLiters(java.lang.Double currentFuelInLiters) Specifies the current supply of fuel in liters.
CommonParamsBuilder	withDecelerationEfficiency(java.lang.Double decelerationEfficiency) Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e.
CommonParamsBuilder	withDepartAt(java.util.Date departAt) Specifies the departure time.
CommonParamsBuilder	withDownhillEfficiency(java.lang.Double downhillEfficiency) Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e.
CommonParamsBuilder	withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter) Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ).
CommonParamsBuilder	withHilliness(Hilliness hilliness) Specifies the hilliness type for route calculation.
CommonParamsBuilder	withIsVehicleCommercial(java.lang.Boolean isVehicleCommercial) Specifies if the vehicle is used for commercial to calculate route.
CommonParamsBuilder	withMaxChargeInKWh(java.lang.Double maxChargeInKWh) Specifies the capacity of the vehicle's battery in kilowatt hours (kWh).
CommonParamsBuilder	withReport(Report report) Specifies what data should be reported for diagnostic purposes.
CommonParamsBuilder	withRouteType(RouteType routeType) Specifies the route type.
CommonParamsBuilder	withTravelMode(TravelMode travelMode) Specifies the travel mode for route calculation.
CommonParamsBuilder	withUphillEfficiency(java.lang.Double uphillEfficiency) Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e.
CommonParamsBuilder	withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg) Specifies the vehicle axle weight for route calculation.
CommonParamsBuilder	withVehicleEngineType(VehicleEngineType vehicleEngineType) Specifies the vehicle engine type for route query.
CommonParamsBuilder	withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters) Specifies the vehicle height for route calculation.
CommonParamsBuilder	withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters) Specifies the vehicle length for route calculation.
CommonParamsBuilder	withVehicleLoadType(VehicleLoadType vehicleLoadType) Specifies the vehicle load type for route calculation.
CommonParamsBuilder	withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph) Specifies the vehicle max speed for route calculation.
CommonParamsBuilder	withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg) Specifies the vehicle weight in kilograms for route calculation.
CommonParamsBuilder	withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters) Specifies the vehicle width for route calculation.
CommonParamsBuilder	withWindingness(Windingness windingness) Specifies the windingness type for route calculation.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonParamsBuilder

public CommonParamsBuilder()

Constructor for params builder that creates a native handle.

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

withReport

@NonNull
public CommonParamsBuilder withReport(Report report)

Description copied from interface: SupportsReportParam

Specifies what data should be reported for diagnostic purposes.

Specified by:

withReport in interface SupportsReportParam<CommonParamsBuilder>

Returns:

reference to the common params object

withDepartAt

@NonNull
public CommonParamsBuilder withDepartAt(java.util.Date departAt)

Description copied from interface: CommonParams

Specifies the departure time.

Specified by:

withDepartAt in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withRouteType

@NonNull
public CommonParamsBuilder withRouteType(RouteType routeType)

Description copied from interface: CommonParams

Specifies the route type.

Specified by:

withRouteType in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withConsiderTraffic

@NonNull
public CommonParamsBuilder withConsiderTraffic(java.lang.Boolean considerTraffic)

Description copied from interface: CommonParams

Specifies if all available traffic information should be considered during routing.

Specified by:

withConsiderTraffic in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withAvoidType

@NonNull
public CommonParamsBuilder withAvoidType(Avoid avoidType)

Description copied from interface: CommonParams

Specifies what the route calculation should try to avoid when determining the route. Can be specified multiple times.

Specified by:

withAvoidType in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withTravelMode

@NonNull
public CommonParamsBuilder withTravelMode(TravelMode travelMode)

Description copied from interface: CommonParams

Specifies the travel mode for route calculation.

Specified by:

withTravelMode in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withHilliness

@NonNull
public CommonParamsBuilder withHilliness(Hilliness hilliness)

Description copied from interface: CommonParams

Specifies the hilliness type for route calculation.

Specified by:

withHilliness in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withWindingness

@NonNull
public CommonParamsBuilder withWindingness(Windingness windingness)

Description copied from interface: CommonParams

Specifies the windingness type for route calculation.

Specified by:

withWindingness in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleMaxSpeedInKph

@NonNull
public CommonParamsBuilder withVehicleMaxSpeedInKph(java.lang.Integer vehicleMaxSpeedInKph)

Description copied from interface: CommonParams

Specifies the vehicle max speed for route calculation.

Specified by:

withVehicleMaxSpeedInKph in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleWeightInKg

@NonNull
public CommonParamsBuilder withVehicleWeightInKg(java.lang.Integer vehicleWeightInKg)

Description copied from interface: CommonParams

Specifies the vehicle weight in kilograms for route calculation.

Specified by:

withVehicleWeightInKg in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleAxleWeightInKg

@NonNull
public CommonParamsBuilder withVehicleAxleWeightInKg(java.lang.Integer vehicleAxleWeightInKg)

Description copied from interface: CommonParams

Specifies the vehicle axle weight for route calculation.

Specified by:

withVehicleAxleWeightInKg in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleLengthInMeters

@NonNull
public CommonParamsBuilder withVehicleLengthInMeters(java.lang.Double vehicleLengthInMeters)

Description copied from interface: CommonParams

Specifies the vehicle length for route calculation.

Specified by:

withVehicleLengthInMeters in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleWidthInMeters

@NonNull
public CommonParamsBuilder withVehicleWidthInMeters(java.lang.Double vehicleWidthInMeters)

Description copied from interface: CommonParams

Specifies the vehicle width for route calculation.

Specified by:

withVehicleWidthInMeters in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleHeightInMeters

@NonNull
public CommonParamsBuilder withVehicleHeightInMeters(java.lang.Double vehicleHeightInMeters)

Description copied from interface: CommonParams

Specifies the vehicle height for route calculation.

Specified by:

withVehicleHeightInMeters in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withIsVehicleCommercial

@NonNull
public CommonParamsBuilder withIsVehicleCommercial(java.lang.Boolean isVehicleCommercial)

Description copied from interface: CommonParams

Specifies if the vehicle is used for commercial to calculate route.

Specified by:

withIsVehicleCommercial in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleLoadType

@NonNull
public CommonParamsBuilder withVehicleLoadType(VehicleLoadType vehicleLoadType)

Description copied from interface: CommonParams

Specifies the vehicle load type for route calculation.

Specified by:

withVehicleLoadType in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withVehicleEngineType

@NonNull
public CommonParamsBuilder withVehicleEngineType(VehicleEngineType vehicleEngineType)

Description copied from interface: CommonParams

Specifies the vehicle engine type for route query.

Specified by:

withVehicleEngineType in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withConstantSpeedConsumptionInLitersPerHundredKm

@NonNull
public CommonParamsBuilder withConstantSpeedConsumptionInLitersPerHundredKm(@NonNull
                                                                                     SpeedToConsumptionMap constantSpeedConsumptionInLitersPerHundredKm)

Description copied from interface: CommonParams

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in liters-per-100km pairs. Applicable only for combustion engines.

Specified by:

withConstantSpeedConsumptionInLitersPerHundredKm in interface CommonParams<CommonParamsBuilder>

Parameters:

constantSpeedConsumptionInLitersPerHundredKm - constraints: size - [1, 25], consumption value - [0.01, 100000.0]

Returns:

reference to the common params object

withCurrentFuelInLiters

@NonNull
public CommonParamsBuilder withCurrentFuelInLiters(java.lang.Double currentFuelInLiters)

Description copied from interface: CommonParams

Specifies the current supply of fuel in liters. Applicable only for combustion engines.

Specified by:

withCurrentFuelInLiters in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withAuxiliaryPowerInLitersPerHour

@NonNull
public CommonParamsBuilder withAuxiliaryPowerInLitersPerHour(java.lang.Double auxiliaryPowerInLitersPerHour)

Description copied from interface: CommonParams

Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour. It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc. Applicable only for combustion engines.

Specified by:

withAuxiliaryPowerInLitersPerHour in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withFuelEnergyDensityInMJoulesPerLiter

@NonNull
public CommonParamsBuilder withFuelEnergyDensityInMJoulesPerLiter(java.lang.Double fuelEnergyDensityInMJoulesPerLiter)

Description copied from interface: CommonParams

Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the *Efficiency parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel. Applicable only for combustion engines.

Specified by:

withFuelEnergyDensityInMJoulesPerLiter in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withAccelerationEfficiency

@NonNull
public CommonParamsBuilder withAccelerationEfficiency(java.lang.Double accelerationEfficiency)

Description copied from interface: CommonParams

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e. KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. Applicable only for combustion engines. If used at all, must be used in conjunction with #withDecelerationEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well.

Specified by:

withAccelerationEfficiency in interface CommonParams<CommonParamsBuilder>

Parameters:

accelerationEfficiency - valid values: [0.0, 1/decelerationEfficiency]

Returns:

reference to the common params object

withDecelerationEfficiency

@NonNull
public CommonParamsBuilder withDecelerationEfficiency(java.lang.Double decelerationEfficiency)

Description copied from interface: CommonParams

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e. ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. Applicable only for combustion engines. If used at all, must be used in conjunction with #withAccelerationEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well.

Specified by:

withDecelerationEfficiency in interface CommonParams<CommonParamsBuilder>

Parameters:

decelerationEfficiency - valid values: [0.0, 1/accelerationEfficiency]

Returns:

reference to the common params object

withUphillEfficiency

@NonNull
public CommonParamsBuilder withUphillEfficiency(java.lang.Double uphillEfficiency)

Description copied from interface: CommonParams

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e. PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter. Applicable only for combustion engines. If used at all, must be used in conjunction with #withDownhillEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well.

Specified by:

withUphillEfficiency in interface CommonParams<CommonParamsBuilder>

Parameters:

uphillEfficiency - valid values: [0.0, 1/downhillEfficiency]

Returns:

reference to the common params object

withDownhillEfficiency

@NonNull
public CommonParamsBuilder withDownhillEfficiency(java.lang.Double downhillEfficiency)

Description copied from interface: CommonParams

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e. ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter. Applicable only for combustion engines. If used at all, must be used in conjunction with #withUphillEfficiency(double). If used, #withVehicleWeightInKg(int) has to be used as well.

Specified by:

withDownhillEfficiency in interface CommonParams<CommonParamsBuilder>

Parameters:

downhillEfficiency - valid values: [0.0, 1/uphillEfficiency]

Returns:

reference to the common params object

withConstantSpeedConsumptionInKWhPerHundredKm

@NonNull
public CommonParamsBuilder withConstantSpeedConsumptionInKWhPerHundredKm(@NonNull
                                                                                  SpeedToConsumptionMap constantSpeedConsumptionInKWhPerHundredKm)

Description copied from interface: CommonParams

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in kWh pairs. Applicable only for electric engines.

Specified by:

withConstantSpeedConsumptionInKWhPerHundredKm in interface CommonParams<CommonParamsBuilder>

Parameters:

constantSpeedConsumptionInKWhPerHundredKm - constraints: size - [1, 25], consumption value - [0.01, 100000.0]

Returns:

reference to the common params object

withCurrentChargeInKWh

@NonNull
public CommonParamsBuilder withCurrentChargeInKWh(java.lang.Double currentChargeInKWh)

Description copied from interface: CommonParams

Specifies the current electric energy supply in kilowatt hours (kWh). Applicable only for electric engines. If used at all, must be used in conjunction with #withMaxChargeInKWh(double).

Specified by:

withCurrentChargeInKWh in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withMaxChargeInKWh

@NonNull
public CommonParamsBuilder withMaxChargeInKWh(java.lang.Double maxChargeInKWh)

Description copied from interface: CommonParams

Specifies the capacity of the vehicle's battery in kilowatt hours (kWh). Applicable only for electric engines. If used at all, must be used in conjunction with #withCurrentChargeInKWh(double).

Specified by:

withMaxChargeInKWh in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withAuxiliaryPowerInKW

@NonNull
public CommonParamsBuilder withAuxiliaryPowerInKW(java.lang.Double auxiliaryPowerInKW)

Description copied from interface: CommonParams

Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc. Applicable only for electric engines.

Specified by:

withAuxiliaryPowerInKW in interface CommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withAvoidVignettes

@NonNull
public CommonParamsBuilder withAvoidVignettes(@NonNull
                                                       java.util.List<java.lang.String> avoidVignettes)

Description copied from interface: PostCommonParams

A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided. Toll roads with vignettes in countries not on the list are unaffected. It is an error to use both withAvoidVignettes and withAllowVignettes.

Specified by:

withAvoidVignettes in interface PostCommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withAllowVignettes

@NonNull
public CommonParamsBuilder withAllowVignettes(@Nullable
                                                       java.util.List<java.lang.String> allowVignettes)

Description copied from interface: PostCommonParams

A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which toll roads with vignettes are allowed. Specifying allowVignettes with some countries X is equivalent to specifying avoidVignette with all countries but X. Using withAllowVignettes with an empty list is the same as avoiding all toll roads with vignettes. It is an error to use both withAvoidVignettes and withAllowVignettes.

Specified by:

withAllowVignettes in interface PostCommonParams<CommonParamsBuilder>

Returns:

reference to the common params object

withAvoidAreas

@NonNull
public CommonParamsBuilder withAvoidAreas(@Nullable
                                                   java.util.List<com.tomtom.online.sdk.common.location.BoundingBox> avoidAreas)

Description copied from interface: PostCommonParams

A list of rectangles that define areas that are to be avoided during reachable range calculation.

Specified by:

withAvoidAreas in interface PostCommonParams<CommonParamsBuilder>

Returns:

reference to the common params object