CarValue

Added in 1.1.0

Kotlin |Java

@CarProtocol
@RequiresCarApi(value = 3)
public final class CarValue<T>

A data value object returned from car hardware with associated metadata including status, timestamp, and the actual value.

Parameters
`<T>`	data type which is returned by the `CarValue`

Summary

Constants
`static final int`	`STATUS_SUCCESS = 1` `CarValue` was obtained successfully.
`static final int`	`STATUS_UNAVAILABLE = 3` `CarValue` attempted for unavailable property, sensor, or action.
`static final int`	`STATUS_UNIMPLEMENTED = 2` `CarValue` attempted for unimplemented property, sensor, or action.
`static final int`	`STATUS_UNKNOWN = 0` `CarValue` has unknown status.

Public constructors
`CarValue(@Nullable T value, long timestampMillis, int status)` Constructs a new instance of a `CarValue`.
`@ExperimentalCarApi CarValue( @Nullable T value, long timestampMillis, int status, @NonNull List<CarZone> zones )` Constructs a new instance of a `CarValue`.

Public methods
`boolean`	`equals(@Nullable Object other)`
`@NonNull List<CarZone>`	`@ExperimentalCarApi getCarZones()` Returns a list of car zones associated with this `CarValue`.
`int`	`getStatus()` Returns the status of this particular result such as success, unavailable, or unimplemented.
`long`	`getTimestampMillis()` Returns the time in milliseconds at which the event happened.
`@Nullable T`	`getValue()` Returns a the data value or `null` if the status is not successful.
`int`	`hashCode()`
`@NonNull String`	`toString()`

Constants

STATUS_SUCCESS

Added in 1.1.0

public static final int STATUS_SUCCESS = 1

CarValue was obtained successfully.

STATUS_UNAVAILABLE

Added in 1.1.0

public static final int STATUS_UNAVAILABLE = 3

CarValue attempted for unavailable property, sensor, or action.

For example, the car hardware might not be able to return a value such as climate at the current time because the engine is off and will set the status to this value.

STATUS_UNIMPLEMENTED

Added in 1.1.0

public static final int STATUS_UNIMPLEMENTED = 2

CarValue attempted for unimplemented property, sensor, or action.

For example, the car hardware might not be able to return a value such as speed or energy level and will set the status to this value.

STATUS_UNKNOWN

Added in 1.1.0

public static final int STATUS_UNKNOWN = 0

CarValue has unknown status.

Public constructors

CarValue

Added in 1.1.0

public CarValue(@Nullable T value, long timestampMillis, int status)

Constructs a new instance of a CarValue. Uses CAR_ZONE_GLOBAL as the zone for this instance.

Parameters
`@Nullable T value`	data to be returned with the result
`long timestampMillis`	the time in milliseconds when the value was generated (see `getTimestampMillis`)
`int status`	the status code associated with this value

CarValue

Added in 1.3.0

@ExperimentalCarApi
public CarValue(
    @Nullable T value,
    long timestampMillis,
    int status,
    @NonNull List<CarZone> zones
)

Constructs a new instance of a CarValue.

Parameters
`@Nullable T value`	data to be returned with the result
`long timestampMillis`	the time in milliseconds when the value was generated (see `getTimestampMillis`)
`int status`	the status code associated with this value
`@NonNull List<CarZone> zones`	the car zones associated with this value

Public methods

equals

public boolean equals(@Nullable Object other)

getCarZones

Added in 1.3.0

@ExperimentalCarApi
public @NonNull List<CarZone> getCarZones()

Returns a list of car zones associated with this CarValue.

For a global vehicle function, the list will only contain GLOBAL_ZONE. Returns an empty list when getStatus is STATUS_UNIMPLEMENTED.

getStatus

Added in 1.1.0

public int getStatus()

Returns the status of this particular result such as success, unavailable, or unimplemented.

getTimestampMillis

Added in 1.1.0

public long getTimestampMillis()

Returns the time in milliseconds at which the event happened.

For a given property, sensor, or action, each new value's timestamp should be monotonically increasing using the same time base as SystemClock.elapsedRealtime().

getValue

Added in 1.1.0

public @Nullable T getValue()

Returns a the data value or null if the status is not successful.

See also
`getStatus`

hashCode

public int hashCode()

toString

public @NonNull String toString()