Package com.highmobility.autoapi

Class VehicleInformation.State.Builder

java.lang.Object

com.highmobility.autoapi.SetCommand.Builder<VehicleInformation.State.Builder>

com.highmobility.autoapi.VehicleInformation.State.Builder

Enclosing class:

VehicleInformation.State

public static final class VehicleInformation.State.Builder
extends SetCommand.Builder<VehicleInformation.State.Builder>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VehicleInformation.State.Builder	addEquipment(Property<String> equipment)	Add a single equipment
VehicleInformation.State.Builder	addExtraEquipmentCode(Property<String> extraEquipmentCode)	Add a single extra equipment code
VehicleInformation.State	build()
VehicleInformation.State.Builder	setBuildDate(Property<Calendar> buildDate)
VehicleInformation.State.Builder	setColourName(Property<String> colourName)
VehicleInformation.State.Builder	setCountryCode(Property<String> countryCode)
VehicleInformation.State.Builder	setDataQuality(Property<VehicleInformation.DataQuality> dataQuality)
VehicleInformation.State.Builder	setDisplayUnit(Property<VehicleInformation.DisplayUnit> displayUnit)
VehicleInformation.State.Builder	setDrive(Property<VehicleInformation.Drive> drive)
VehicleInformation.State.Builder	setDriverSeatLocation(Property<VehicleInformation.DriverSeatLocation> driverSeatLocation)
VehicleInformation.State.Builder	setEngineMaxTorque(Property<com.highmobility.autoapi.value.measurement.Torque> engineMaxTorque)
VehicleInformation.State.Builder	setEngineVolume(Property<com.highmobility.autoapi.value.measurement.Volume> engineVolume)
VehicleInformation.State.Builder	setEquipments(Property<String>[] equipments)	Add an array of equipments
VehicleInformation.State.Builder	setExtraEquipmentCodes(Property<String>[] extraEquipmentCodes)	Add an array of extra equipment codes
VehicleInformation.State.Builder	setFuelTankCapacity(Property<com.highmobility.autoapi.value.measurement.Volume> fuelTankCapacity)
VehicleInformation.State.Builder	setGearbox(Property<VehicleInformation.Gearbox> gearbox)
VehicleInformation.State.Builder	setLanguage(Property<String> language)
VehicleInformation.State.Builder	setLastDataTransferDate(Property<Calendar> lastDataTransferDate)
VehicleInformation.State.Builder	setLicensePlate(Property<String> licensePlate)
VehicleInformation.State.Builder	setModelKey(Property<String> modelKey)
VehicleInformation.State.Builder	setModelName(Property<String> modelName)
VehicleInformation.State.Builder	setModelYear(Property<Integer> modelYear)
VehicleInformation.State.Builder	setName(Property<String> name)
VehicleInformation.State.Builder	setNumberOfDoors(Property<Integer> numberOfDoors)
VehicleInformation.State.Builder	setNumberOfSeats(Property<Integer> numberOfSeats)
VehicleInformation.State.Builder	setPower(Property<com.highmobility.autoapi.value.measurement.Power> power)
VehicleInformation.State.Builder	setPowerInKW(Property<com.highmobility.autoapi.value.measurement.Power> powerInKW)	Deprecated. removed the unit from the name.
VehicleInformation.State.Builder	setPowertrain(Property<EngineType> powertrain)
VehicleInformation.State.Builder	setPowertrainSecondary(Property<EngineType> powertrainSecondary)
VehicleInformation.State.Builder	setSalesDesignation(Property<String> salesDesignation)
VehicleInformation.State.Builder	setSeries(Property<String> series)
VehicleInformation.State.Builder	setTimeformat(Property<VehicleInformation.Timeformat> timeformat)
VehicleInformation.State.Builder	setTimeZone(Property<VehicleInformation.TimeZone> timeZone)
VehicleInformation.State.Builder	setVehicleMass(Property<com.highmobility.autoapi.value.measurement.Mass> vehicleMass)

Methods inherited from class com.highmobility.autoapi.SetCommand.Builder

addProperty, getProperties, setBrand, setNonce, setSignature, setTimestamp, setVin

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public VehicleInformation.State build()

Overrides:

build in class SetCommand.Builder<VehicleInformation.State.Builder>

setPowertrain

public VehicleInformation.State.Builder setPowertrain(Property<EngineType> powertrain)

Parameters:

powertrain - Type of the (primary) powertrain

Returns:

The builder

setModelName

public VehicleInformation.State.Builder setModelName(Property<String> modelName)

Parameters:

modelName - The vehicle model name

Returns:

The builder

setName

public VehicleInformation.State.Builder setName(Property<String> name)

Parameters:

name - The vehicle name (nickname)

Returns:

The builder

setLicensePlate

public VehicleInformation.State.Builder setLicensePlate(Property<String> licensePlate)

Parameters:

licensePlate - The license plate number

Returns:

The builder

setSalesDesignation

public VehicleInformation.State.Builder setSalesDesignation(Property<String> salesDesignation)

Parameters:

salesDesignation - The sales designation of the model

Returns:

The builder

setModelYear

public VehicleInformation.State.Builder setModelYear(Property<Integer> modelYear)

Parameters:

modelYear - The vehicle model manufacturing year number

Returns:

The builder

setColourName

public VehicleInformation.State.Builder setColourName(Property<String> colourName)

Parameters:

colourName - The colour name

Returns:

The builder

setPowerInKW

@Deprecated
public VehicleInformation.State.Builder setPowerInKW(Property<com.highmobility.autoapi.value.measurement.Power> powerInKW)

Deprecated.

removed the unit from the name. Replaced by VehicleInformation.State.getPower()

Parameters:

powerInKW - The power of the vehicle

Returns:

The builder

setNumberOfDoors

public VehicleInformation.State.Builder setNumberOfDoors(Property<Integer> numberOfDoors)

Parameters:

numberOfDoors - The number of doors

Returns:

The builder

setNumberOfSeats

public VehicleInformation.State.Builder setNumberOfSeats(Property<Integer> numberOfSeats)

Parameters:

numberOfSeats - The number of seats

Returns:

The builder

setEngineVolume

public VehicleInformation.State.Builder setEngineVolume(Property<com.highmobility.autoapi.value.measurement.Volume> engineVolume)

Parameters:

engineVolume - The engine volume displacement

Returns:

The builder

setEngineMaxTorque

public VehicleInformation.State.Builder setEngineMaxTorque(Property<com.highmobility.autoapi.value.measurement.Torque> engineMaxTorque)

Parameters:

engineMaxTorque - The maximum engine torque

Returns:

The builder

setGearbox

public VehicleInformation.State.Builder setGearbox(Property<VehicleInformation.Gearbox> gearbox)

Parameters:

gearbox - The gearbox

Returns:

The builder

setDisplayUnit

public VehicleInformation.State.Builder setDisplayUnit(Property<VehicleInformation.DisplayUnit> displayUnit)

Parameters:

displayUnit - The display unit

Returns:

The builder

setDriverSeatLocation

public VehicleInformation.State.Builder setDriverSeatLocation(Property<VehicleInformation.DriverSeatLocation> driverSeatLocation)

Parameters:

driverSeatLocation - The driver seat location

Returns:

The builder

setEquipments

public VehicleInformation.State.Builder setEquipments(Property<String>[] equipments)

Add an array of equipments

Parameters:

equipments - The equipments. Names of equipment the vehicle is equipped with

Returns:

The builder

addEquipment

public VehicleInformation.State.Builder addEquipment(Property<String> equipment)

Add a single equipment

Parameters:

equipment - The equipment. Names of equipment the vehicle is equipped with

Returns:

The builder

setPower

public VehicleInformation.State.Builder setPower(Property<com.highmobility.autoapi.value.measurement.Power> power)

Parameters:

power - The power of the vehicle

Returns:

The builder

setLanguage

public VehicleInformation.State.Builder setLanguage(Property<String> language)

Parameters:

language - The language on headunit

Returns:

The builder

setTimeformat

public VehicleInformation.State.Builder setTimeformat(Property<VehicleInformation.Timeformat> timeformat)

Parameters:

timeformat - The timeformat on headunit

Returns:

The builder

setDrive

public VehicleInformation.State.Builder setDrive(Property<VehicleInformation.Drive> drive)

Parameters:

drive - Wheels driven by the engine

Returns:

The builder

setPowertrainSecondary

public VehicleInformation.State.Builder setPowertrainSecondary(Property<EngineType> powertrainSecondary)

Parameters:

powertrainSecondary - The powertrain secondary

Returns:

The builder

setFuelTankCapacity

public VehicleInformation.State.Builder setFuelTankCapacity(Property<com.highmobility.autoapi.value.measurement.Volume> fuelTankCapacity)

Parameters:

fuelTankCapacity - The fuel tank capacity measured in liters

Returns:

The builder

setBuildDate

public VehicleInformation.State.Builder setBuildDate(Property<Calendar> buildDate)

Parameters:

buildDate - Build (construction) date of the vehicle.

Returns:

The builder

setCountryCode

public VehicleInformation.State.Builder setCountryCode(Property<String> countryCode)

Parameters:

countryCode - The country code of the vehicle.

Returns:

The builder

setModelKey

public VehicleInformation.State.Builder setModelKey(Property<String> modelKey)

Parameters:

modelKey - The model key of the vehicle.

Returns:

The builder

setDataQuality

public VehicleInformation.State.Builder setDataQuality(Property<VehicleInformation.DataQuality> dataQuality)

Parameters:

dataQuality - Evaluation of the timeliness of the available vehicle data.

Returns:

The builder

setExtraEquipmentCodes

public VehicleInformation.State.Builder setExtraEquipmentCodes(Property<String>[] extraEquipmentCodes)

Add an array of extra equipment codes

Parameters:

extraEquipmentCodes - The extra equipment codes. Codes of the extra equipment the vehicle has

Returns:

The builder

addExtraEquipmentCode

public VehicleInformation.State.Builder addExtraEquipmentCode(Property<String> extraEquipmentCode)

Add a single extra equipment code

Parameters:

extraEquipmentCode - The extra equipment code. Codes of the extra equipment the vehicle has

Returns:

The builder

setSeries

public VehicleInformation.State.Builder setSeries(Property<String> series)

Parameters:

series - The vehicle model's series

Returns:

The builder

setLastDataTransferDate

public VehicleInformation.State.Builder setLastDataTransferDate(Property<Calendar> lastDataTransferDate)

Parameters:

lastDataTransferDate - The last trip date

Returns:

The builder

setTimeZone

public VehicleInformation.State.Builder setTimeZone(Property<VehicleInformation.TimeZone> timeZone)

Parameters:

timeZone - Time zone setting in the vehicle.

Returns:

The builder

setVehicleMass

public VehicleInformation.State.Builder setVehicleMass(Property<com.highmobility.autoapi.value.measurement.Mass> vehicleMass)

Parameters:

vehicleMass - Vehicle mass.

Returns:

The builder