com.ibm.wiotp.sdk.devicemgmt

Enum DeviceFirmware.FirmwareState

java.lang.Object

java.lang.Enum<DeviceFirmware.FirmwareState>

com.ibm.wiotp.sdk.devicemgmt.DeviceFirmware.FirmwareState

All Implemented Interfaces:

Serializable, Comparable<DeviceFirmware.FirmwareState>

Enclosing class:

DeviceFirmware

public static enum DeviceFirmware.FirmwareState
extends Enum<DeviceFirmware.FirmwareState>

The firmware update process is separated into two distinct actions, Downloading Firmware, and Updating Firmware. The status of each of these actions is stored in a separate attribute on the device. The mgmt.firmware.state attribute describes the status of the firmware download. The possible values for mgmt.firmware.state are:

mgmt.firmware.state

Value	State	Meaning
0	Idle	The device is currently not in the process of downloading firmware
1	Downloading	The device is currently downloading firmware
2	Downloaded	The device has successfully downloaded a firmware update and it is ready to install

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWNLOADED
DOWNLOADING
IDLE

Method Summary

Modifier and Type	Method and Description
int	getState() Returns the current Firmware download State
static DeviceFirmware.FirmwareState	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeviceFirmware.FirmwareState[]	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

IDLE

public static final DeviceFirmware.FirmwareState IDLE

DOWNLOADING

public static final DeviceFirmware.FirmwareState DOWNLOADING

DOWNLOADED

public static final DeviceFirmware.FirmwareState DOWNLOADED

Method Detail

values

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

Returns:

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

valueOf

public static DeviceFirmware.FirmwareState 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

getState

public int getState()

Returns the current Firmware download State

Returns:

state