Package org.openhab.core.thing.binding.firmware

Enum Class ProgressStep

java.lang.Object

java.lang.Enum<ProgressStep>

org.openhab.core.thing.binding.firmware.ProgressStep

All Implemented Interfaces:

Serializable, Comparable<ProgressStep>, Constable

@NonNullByDefault
public enum ProgressStep
extends Enum<ProgressStep>

The ProgressStep enumeration defines the possible progress steps for a firmware update. The actual sequence of the firmware update is defined by the operation ProgressCallback.defineSequence(ProgressStep...).

Author:

Thomas Höfer - Initial contribution, Chris Jackson - Add WAITING

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
DOWNLOADING	The FirmwareUpdateHandler is going to download / read the firmware image by reading the input stream from Firmware.getBytes().
REBOOTING	The FirmwareUpdateHandler is going to reboot the device.
TRANSFERRING	The FirmwareUpdateHandler is going to transfer the firmware to the actual device.
UPDATING	The FirmwareUpdateHandler is going to trigger the firmware update for the actual device.
WAITING	The FirmwareUpdateHandler is waiting for the device to initiate the transfer.

Method Summary

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

DOWNLOADING

public static final ProgressStep DOWNLOADING

The FirmwareUpdateHandler is going to download / read the firmware image by reading the input stream from Firmware.getBytes().

WAITING

public static final ProgressStep WAITING

The FirmwareUpdateHandler is waiting for the device to initiate the transfer. For battery devices that may wake up periodically, this may take some time. For mains devices this step may be very short or omitted.

TRANSFERRING

public static final ProgressStep TRANSFERRING

The FirmwareUpdateHandler is going to transfer the firmware to the actual device.

UPDATING

public static final ProgressStep UPDATING

The FirmwareUpdateHandler is going to trigger the firmware update for the actual device.

REBOOTING

public static final ProgressStep REBOOTING

The FirmwareUpdateHandler is going to reboot the device.

Method Details

values

public static ProgressStep[] 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 ProgressStep 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