com.smartdevicelink.proxy.rpc.enums

Enum SystemAction

java.lang.Object

java.lang.Enum<SystemAction>

com.smartdevicelink.proxy.rpc.enums.SystemAction

All Implemented Interfaces:

Serializable, Comparable<SystemAction>

public enum SystemAction
extends Enum<SystemAction>

Enumeration that describes system actions that can be triggered.

Since:

SmartDeviceLink 2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT_ACTION Default action occurs.
KEEP_CONTEXT Current system context is maintained.
STEAL_FOCUS App is brought into HMI_FULL.

Method Summary

Modifier and Type	Method and Description
static SystemAction	valueForString(String value) Convert String to SystemAction
static SystemAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static SystemAction[]	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

DEFAULT_ACTION

public static final SystemAction DEFAULT_ACTION

Default action occurs. Standard behavior (e.g. SoftButton clears overlay).

STEAL_FOCUS

public static final SystemAction STEAL_FOCUS

App is brought into HMI_FULL.

KEEP_CONTEXT

public static final SystemAction KEEP_CONTEXT

Current system context is maintained. An overlay is persisted even though a SoftButton has been pressed and the notification sent.

Method Detail

values

public static SystemAction[] 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 (SystemAction c : SystemAction.values())
    System.out.println(c);

Returns:

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

valueOf

public static SystemAction 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 SystemAction valueForString(String value)

Convert String to SystemAction

Parameters:

value - String

Returns:

SystemAction