Package com.highmobility.autoapi

Enum Class FailureMessage.FailureReason

java.lang.Object

java.lang.Enum<FailureMessage.FailureReason>

com.highmobility.autoapi.FailureMessage.FailureReason

All Implemented Interfaces:

ByteEnum, Serializable, Comparable<FailureMessage.FailureReason>, Constable

Enclosing class:

FailureMessage

public static enum FailureMessage.FailureReason
extends Enum<FailureMessage.FailureReason>
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
EXECUTION_TIMEOUT	Command failed to execute in time for an unknown reason
INCORRECT_STATE	Command can not be executed in the current vehicle state
INVALID_COMMAND	Command not recognised
OEM_ERROR	API call to an OEM returned an error
PENDING	Capability is being refreshed
PRIVACY_MODE_ACTIVE	Privacy mode is turned on, meaning vehicle location and other "private" data is not transmitted by the vehicle.
RATE_LIMIT	Capability rate limit has been exceeded
UNAUTHORISED	User has not been authenticated or lacks permissions
UNSUPPORTED_CAPABILITY	Vehicle has not the capability to perform the command
VEHICLE_ASLEEP	Vehicle has to be waken up before the command can be used.

Method Summary

Modifier and Type	Method	Description
static FailureMessage.FailureReason	fromByte(byte byteValue)
byte	getByte()
static FailureMessage.FailureReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FailureMessage.FailureReason[]	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

UNSUPPORTED_CAPABILITY

public static final FailureMessage.FailureReason UNSUPPORTED_CAPABILITY

Vehicle has not the capability to perform the command

UNAUTHORISED

public static final FailureMessage.FailureReason UNAUTHORISED

User has not been authenticated or lacks permissions

INCORRECT_STATE

public static final FailureMessage.FailureReason INCORRECT_STATE

Command can not be executed in the current vehicle state

EXECUTION_TIMEOUT

public static final FailureMessage.FailureReason EXECUTION_TIMEOUT

Command failed to execute in time for an unknown reason

VEHICLE_ASLEEP

public static final FailureMessage.FailureReason VEHICLE_ASLEEP

Vehicle has to be waken up before the command can be used. If this is for a virtual vehicle, the emulator has to be loaded

INVALID_COMMAND

public static final FailureMessage.FailureReason INVALID_COMMAND

Command not recognised

PENDING

public static final FailureMessage.FailureReason PENDING

Capability is being refreshed

RATE_LIMIT

public static final FailureMessage.FailureReason RATE_LIMIT

Capability rate limit has been exceeded

OEM_ERROR

public static final FailureMessage.FailureReason OEM_ERROR

API call to an OEM returned an error

PRIVACY_MODE_ACTIVE

public static final FailureMessage.FailureReason PRIVACY_MODE_ACTIVE

Privacy mode is turned on, meaning vehicle location and other "private" data is not transmitted by the vehicle.

Method Details

values

public static FailureMessage.FailureReason[] 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 FailureMessage.FailureReason 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 FailureMessage.FailureReason fromByte(byte byteValue)
                                             throws CommandParseException

Throws:

CommandParseException

getByte

public byte getByte()

Specified by:

getByte in interface ByteEnum