Package com.highmobility.autoapi.value

Enum Class Availability.UpdateRate

java.lang.Object

java.lang.Enum<Availability.UpdateRate>

com.highmobility.autoapi.value.Availability.UpdateRate

All Implemented Interfaces:

ByteEnum, Serializable, Comparable<Availability.UpdateRate>, Constable

Enclosing class:

Availability

public static enum Availability.UpdateRate
extends Enum<Availability.UpdateRate>
implements ByteEnum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOT_AVAILABLE	The property is not available for the vehicle.
ON_CHANGE	The property data is update as soon as the vehicle updates it internally.
TRIP	The property data is updated regularly during a trip.
TRIP_END	The property data is updated by the end of each trip.
TRIP_HIGH	The property data is updated with high frequency during a trip.
TRIP_START_END	The property data is updated at the start and end of each trip.
UNKNOWN	The property data is updated sporadically.

Method Summary

Modifier and Type	Method	Description
static Availability.UpdateRate	fromByte(byte byteValue)
byte	getByte()
static Availability.UpdateRate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Availability.UpdateRate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRIP_HIGH

public static final Availability.UpdateRate TRIP_HIGH

The property data is updated with high frequency during a trip.

TRIP

public static final Availability.UpdateRate TRIP

The property data is updated regularly during a trip.

TRIP_START_END

public static final Availability.UpdateRate TRIP_START_END

The property data is updated at the start and end of each trip.

TRIP_END

public static final Availability.UpdateRate TRIP_END

The property data is updated by the end of each trip.

UNKNOWN

public static final Availability.UpdateRate UNKNOWN

The property data is updated sporadically.

NOT_AVAILABLE

public static final Availability.UpdateRate NOT_AVAILABLE

The property is not available for the vehicle.

ON_CHANGE

public static final Availability.UpdateRate ON_CHANGE

The property data is update as soon as the vehicle updates it internally.

Method Details

values

public static Availability.UpdateRate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Availability.UpdateRate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromByte

public static Availability.UpdateRate fromByte(byte byteValue)
                                        throws CommandParseException

Throws:

CommandParseException

getByte

public byte getByte()

Specified by:

getByte in interface ByteEnum