com.smartdevicelink.managers.screen.menu

Enum DynamicMenuUpdatesMode

java.lang.Object

java.lang.Enum<DynamicMenuUpdatesMode>

com.smartdevicelink.managers.screen.menu.DynamicMenuUpdatesMode

All Implemented Interfaces:

Serializable, Comparable<DynamicMenuUpdatesMode>

public enum DynamicMenuUpdatesMode
extends Enum<DynamicMenuUpdatesMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORCE_OFF FORCE_OFF: Forces off compatibility mode.
FORCE_ON FORCE_ON: This mode forces the menu manager to always dynamically update menu items for each menu update.
ON_WITH_COMPAT_MODE ON_WITH_COMPAT_MODE: This mode checks whether the phone is connected to a SYNC Gen 3 head unit, which has known menu ordering issues.

Method Summary

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

FORCE_ON

public static final DynamicMenuUpdatesMode FORCE_ON

FORCE_ON: This mode forces the menu manager to always dynamically update menu items for each menu update. This will provide the best performance but may cause ordering issues on some SYNC Gen 3 head units.

FORCE_OFF

public static final DynamicMenuUpdatesMode FORCE_OFF

FORCE_OFF: Forces off compatibility mode. This will force the menu manager to delete and re-add each menu item for every menu update. This mode is generally not advised due to performance issues.

ON_WITH_COMPAT_MODE

public static final DynamicMenuUpdatesMode ON_WITH_COMPAT_MODE

ON_WITH_COMPAT_MODE: This mode checks whether the phone is connected to a SYNC Gen 3 head unit, which has known menu ordering issues. If it is, it will always delete and re-add every menu item, if not, it will dynamically update the menus.

Method Detail

values

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

Returns:

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

valueOf

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