Package org.openhab.core.thing.firmware

Enum Class FirmwareStatus

java.lang.Object

java.lang.Enum<FirmwareStatus>

org.openhab.core.thing.firmware.FirmwareStatus

All Implemented Interfaces:

Serializable, Comparable<FirmwareStatus>, Constable

@NonNullByDefault
public enum FirmwareStatus
extends Enum<FirmwareStatus>

The FirmwareStatus enumeration defines all possible statuses for the Firmware of a Thing . The property Thing.PROPERTY_FIRMWARE_VERSION must be set for a thing in order that its firmware status can be determined.

Author:

Thomas Höfer - Initial contribution

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
UNKNOWN	The firmware status can not be determined and hence it is unknown.
UP_TO_DATE	The firmware of the thing is up to date.
UPDATE_AVAILABLE	There is a newer firmware of the thing available.
UPDATE_EXECUTABLE	There is a newer firmware of the thing available and the firmware update for the thing can be executed.

Method Summary

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

UNKNOWN

public static final FirmwareStatus UNKNOWN

The firmware status can not be determined and hence it is unknown. Either the Thing.PROPERTY_FIRMWARE_VERSION is not set for the thing or there is no FirmwareProvider that provides a firmware for the ThingTypeUID of the thing.

UP_TO_DATE

public static final FirmwareStatus UP_TO_DATE

The firmware of the thing is up to date.

UPDATE_AVAILABLE

public static final FirmwareStatus UPDATE_AVAILABLE

There is a newer firmware of the thing available. However the thing is not in a state where its firmware can be updated, i.e. the operation FirmwareUpdateHandler.isUpdateExecutable() returned false.

UPDATE_EXECUTABLE

public static final FirmwareStatus UPDATE_EXECUTABLE

There is a newer firmware of the thing available and the firmware update for the thing can be executed.

Method Details

values

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