Package org.openhab.core.library.types

Enum Class OnOffType

java.lang.Object

java.lang.Enum<OnOffType>

org.openhab.core.library.types.OnOffType

All Implemented Interfaces:

Serializable, Comparable<OnOffType>, Constable, Command, PrimitiveType, State, Type

@NonNullByDefault
public enum OnOffType
extends Enum<OnOffType>
implements PrimitiveType, State, Command

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

Enum Constants

Enum Constant	Description
OFF
ON

Method Summary

Modifier and Type	Method	Description
<T extends State> @Nullable T	as(@Nullable Class<T> target)	Convert this State's value into another type
String	format(String pattern)	Formats the value of this type according to a pattern (see Formatter).
static OnOffType	from(boolean state)
static OnOffType	from(String state)	Converts a String value "ON" or "1" to ON or else to OFF.
String	toFullString()	Get a string representation that contains the whole internal representation of the type.
String	toString()
static OnOffType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OnOffType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ON

public static final OnOffType ON

OFF

public static final OnOffType OFF

Method Details

values

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

from

public static OnOffType from(String state)

Converts a String value "ON" or "1" to ON or else to OFF.

Parameters:

state - String to convert to OnOffType

Returns:

returns the ON or OFF state based on the String

from

public static OnOffType from(boolean state)

Parameters:

state - boolean to convert to OnOffType

Returns:

returns the ON or OFF state based on the boolean

format

public String format(String pattern)

Description copied from interface: Type

Formats the value of this type according to a pattern (see Formatter).

Specified by:

format in interface Type

Parameters:

pattern - the pattern to use

Returns:

the formatted string

toString

public String toString()

Overrides:

toString in class Enum<OnOffType>

toFullString

public String 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 interface Type

Returns:

a full string representation of the type to be consumed by 'valueOf(String)'

as

public <T extends State> @Nullable T as(@Nullable Class<T> target)

Description copied from interface: State

Convert this State's value into another type

Specified by:

as in interface State

Parameters:

target - the desired State type

Returns:

the State's value in the given type's representation, or null if the conversion was not possible