Package org.openhab.core.thing.binding.generic

Class ChannelValueConverterConfig

java.lang.Object

org.openhab.core.thing.binding.generic.ChannelValueConverterConfig

@NonNullByDefault
public class ChannelValueConverterConfig
extends Object

The ChannelValueConverterConfig is a base class for the channel configuration of things using the ChannelHandlers

Author:

Jan N. Klug - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable String	closedValue
ColorChannelHandler.ColorMode	colorMode
@Nullable String	decreaseValue
@Nullable String	downValue
@Nullable String	fastforwardValue
@Nullable String	increaseValue
ChannelMode	mode
@Nullable String	moveValue
@Nullable String	nextValue
@Nullable String	offValue
@Nullable String	onValue
@Nullable String	openValue
@Nullable String	pauseValue
@Nullable String	playValue
@Nullable String	previousValue
@Nullable String	rewindValue
BigDecimal	step
@Nullable String	stopValue
@Nullable String	unit
@Nullable String	upValue

Constructor Summary

Constructors

Constructor	Description
ChannelValueConverterConfig()

Method Summary

Modifier and Type	Method	Description
@Nullable String	commandToFixedValue(Command command)	maps a command to a user-defined string
@Nullable State	fixedValueToState(String string)	maps a user-defined string to a state

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

mode

public ChannelMode mode

unit

public @Nullable String unit

onValue

public @Nullable String onValue

offValue

public @Nullable String offValue

step

public BigDecimal step

increaseValue

public @Nullable String increaseValue

decreaseValue

public @Nullable String decreaseValue

colorMode

public ColorChannelHandler.ColorMode colorMode

openValue

public @Nullable String openValue

closedValue

public @Nullable String closedValue

upValue

public @Nullable String upValue

downValue

public @Nullable String downValue

stopValue

public @Nullable String stopValue

moveValue

public @Nullable String moveValue

playValue

public @Nullable String playValue

pauseValue

public @Nullable String pauseValue

nextValue

public @Nullable String nextValue

previousValue

public @Nullable String previousValue

rewindValue

public @Nullable String rewindValue

fastforwardValue

public @Nullable String fastforwardValue

Constructor Details

ChannelValueConverterConfig

public ChannelValueConverterConfig()

Method Details

commandToFixedValue

public @Nullable String commandToFixedValue(Command command)

maps a command to a user-defined string

Parameters:

command - the command to map

Returns:

a string or null if no mapping found

fixedValueToState

public @Nullable State fixedValueToState(String string)

maps a user-defined string to a state

Parameters:

string - the string to map

Returns:

the state or null if no mapping found