com.smartdevicelink.proxy.rpc.enums

Enum IgnitionStatus

java.lang.Object

java.lang.Enum<IgnitionStatus>

com.smartdevicelink.proxy.rpc.enums.IgnitionStatus

All Implemented Interfaces:

Serializable, Comparable<IgnitionStatus>

public enum IgnitionStatus
extends Enum<IgnitionStatus>

Reflects the status of ignition.

Since:

SmartDeviceLink 2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESSORY Ignition is in mode accessory
INVALID Signal is invalid
OFF Ignition is off
RUN Ignition is in mode run
START Ignition is in mode run
UNKNOWN Ignition status currently unknown

Method Summary

Modifier and Type	Method and Description
static IgnitionStatus	valueForString(String value) Convert String to IgnitionStatus
static IgnitionStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static IgnitionStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final IgnitionStatus UNKNOWN

Ignition status currently unknown

OFF

public static final IgnitionStatus OFF

Ignition is off

ACCESSORY

public static final IgnitionStatus ACCESSORY

Ignition is in mode accessory

RUN

public static final IgnitionStatus RUN

Ignition is in mode run

START

public static final IgnitionStatus START

Ignition is in mode run

INVALID

public static final IgnitionStatus INVALID

Signal is invalid

Method Detail

values

public static IgnitionStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IgnitionStatus c : IgnitionStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static IgnitionStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

valueForString

public static IgnitionStatus valueForString(String value)

Convert String to IgnitionStatus

Parameters:

value - String

Returns:

IgnitionStatus