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

Class GenericChannelHandler

java.lang.Object

org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

org.openhab.core.thing.binding.generic.converter.GenericChannelHandler

All Implemented Interfaces:

ChannelHandler

@NonNullByDefault
public class GenericChannelHandler
extends org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

The GenericChannelHandler implements simple conversions for different item types

Author:

Jan N. Klug - Initial contribution

Nested Class Summary

Nested classes/interfaces inherited from interface org.openhab.core.thing.binding.generic.ChannelHandler

ChannelHandler.Factory

Field Summary

Fields inherited from class org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

channelConfig

Constructor Summary

Constructors

Constructor	Description
GenericChannelHandler(Function<String,State> toState, Consumer<State> updateState, Consumer<Command> postCommand, @Nullable Consumer<String> sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig)

Method Summary

Modifier and Type	Method	Description
protected @Nullable Command	toCommand(String value)	check if this converter received a value that needs to be sent as command
protected Optional<State>	toState(String value)	convert the received value to a state
protected String	toString(Command command)	convert a command to a string

Methods inherited from class org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

process, send

Methods inherited from class java.lang.Object

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

Constructor Details

GenericChannelHandler

public GenericChannelHandler(Function<String,State> toState,
 Consumer<State> updateState,
 Consumer<Command> postCommand,
 @Nullable Consumer<String> sendValue,
 ChannelTransformation stateTransformations,
 ChannelTransformation commandTransformations,
 ChannelValueConverterConfig channelConfig)

Method Details

toState

protected Optional<State> toState(String value)

Description copied from class: org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

convert the received value to a state

Specified by:

toState in class org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

Parameters:

value - the value

Returns:

the state that represents the value of UNDEF if conversion failed

toCommand

protected @Nullable Command toCommand(String value)

Description copied from class: org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

check if this converter received a value that needs to be sent as command

Specified by:

toCommand in class org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

Parameters:

value - the value

Returns:

the command or null

toString

protected String toString(Command command)

Description copied from class: org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

convert a command to a string

Specified by:

toString in class org.openhab.core.thing.internal.binding.generic.converter.AbstractTransformingChannelHandler

Parameters:

command - the command

Returns:

the string representation of the command