Package org.openhab.core.types
Enum Class UnDefType
- All Implemented Interfaces:
Serializable
,Comparable<UnDefType>
,Constable
,PrimitiveType
,State
,Type
There are situations when item states do not have any defined value.
This might be because they have not been initialized yet (never
received a state update so far) or because their state is ambiguous
(e.g. a dimmed light that is treated as a switch (ON/OFF) will have
an undefined state if it is dimmed to 50%).
- Author:
- Kai Kreuzer - Initial contribution
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionFormats the value of this type according to a pattern (seeFormatter
).Get a string representation that contains the whole internal representation of the type.toString()
static UnDefType
Returns the enum constant of this class with the specified name.static UnDefType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNDEF
-
NULL
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
format
Description copied from interface:Type
Formats the value of this type according to a pattern (seeFormatter
). -
toString
-
toFullString
Description copied from interface:Type
Get a string representation that contains the whole internal representation of the type.The returned string could be consumed by the static 'valueOf(String)' method of the respective type to build a new type that is equal to this type.
- Specified by:
toFullString
in interfaceType
- Returns:
- a full string representation of the type to be consumed by 'valueOf(String)'
-