From bdc78e1d6e8165d138aea6aace3b7aef4adff2ad Mon Sep 17 00:00:00 2001 From: "Jan N. Klug" Date: Sun, 5 Feb 2023 18:36:21 +0100 Subject: [PATCH] even better naming Signed-off-by: Jan N. Klug --- ...lValueHandler.java => ChannelHandler.java} | 9 +-- ...ontent.java => ChannelHandlerContent.java} | 6 +- .../generic/ChannelValueConverterConfig.java | 6 +- ...> AbstractTransformingChannelHandler.java} | 14 ++-- ...eHandler.java => ColorChannelHandler.java} | 6 +- ...Handler.java => DimmerChannelHandler.java} | 6 +- ...a => FixedValueMappingChannelHandler.java} | 6 +- ...andler.java => GenericChannelHandler.java} | 6 +- ...eHandler.java => ImageChannelHandler.java} | 12 ++-- ...Handler.java => NumberChannelHandler.java} | 6 +- ...Handler.java => PlayerChannelHandler.java} | 6 +- ....java => RollershutterChannelHandler.java} | 6 +- ...AbstractTransformingItemConverterTest.java | 22 +++---- .../generic/converter/ConverterTest.java | 64 +++++++++---------- 14 files changed, 87 insertions(+), 88 deletions(-) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/{ChannelValueHandler.java => ChannelHandler.java} (79%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/{ChannelValueConverterContent.java => ChannelHandlerContent.java} (85%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{AbstractTransformingChannelValueHandler.java => AbstractTransformingChannelHandler.java} (85%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{ColorChannelValueHandler.java => ColorChannelHandler.java} (94%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{DimmerChannelValueHandler.java => DimmerChannelHandler.java} (92%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{FixedValueMappingChannelValueHandler.java => FixedValueMappingChannelHandler.java} (86%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{GenericChannelValueHandler.java => GenericChannelHandler.java} (86%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{ImageChannelValueHandler.java => ImageChannelHandler.java} (74%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{NumberChannelValueHandler.java => NumberChannelHandler.java} (89%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{PlayerChannelValueHandler.java => PlayerChannelHandler.java} (90%) rename bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/{RollershutterChannelValueHandler.java => RollershutterChannelHandler.java} (91%) diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelHandler.java similarity index 79% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelHandler.java index 238b36eb6ca..8839167d4f9 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelHandler.java @@ -17,21 +17,22 @@ import org.openhab.core.types.Command; /** - * The {@link ChannelValueHandler} defines the interface for converting received {@link ChannelValueConverterContent} + * The {@link ChannelHandler} defines the interface for converting received {@link ChannelHandlerContent} * to {@link org.openhab.core.types.State}s for posting updates to {@link org.openhab.core.thing.Channel}s and * {@link Command}s to values for sending * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public interface ChannelValueHandler { +public interface ChannelHandler { /** * called to process a given content for this channel * - * @param content raw content to process (null results in {@link org.openhab.core.types.UnDefType#UNDEF}) + * @param content raw content to process (null results in + * {@link org.openhab.core.types.UnDefType#UNDEF}) */ - void process(@Nullable ChannelValueConverterContent content); + void process(@Nullable ChannelHandlerContent content); /** * called to send a command to this channel diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueConverterContent.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelHandlerContent.java similarity index 85% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueConverterContent.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelHandlerContent.java index 94db24dd6e5..ed5b4ad3e15 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueConverterContent.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelHandlerContent.java @@ -19,17 +19,17 @@ import org.eclipse.jdt.annotation.Nullable; /** - * The {@link ChannelValueConverterContent} defines the pre-processed response + * The {@link ChannelHandlerContent} defines the pre-processed response * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class ChannelValueConverterContent { +public class ChannelHandlerContent { private final byte[] rawContent; private final Charset encoding; private final @Nullable String mediaType; - public ChannelValueConverterContent(byte[] rawContent, String encoding, @Nullable String mediaType) { + public ChannelHandlerContent(byte[] rawContent, String encoding, @Nullable String mediaType) { this.rawContent = rawContent; this.mediaType = mediaType; diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueConverterConfig.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueConverterConfig.java index 233f656b7f8..72dd8a8a053 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueConverterConfig.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/ChannelValueConverterConfig.java @@ -26,13 +26,13 @@ import org.openhab.core.library.types.RewindFastforwardType; import org.openhab.core.library.types.StopMoveType; import org.openhab.core.library.types.UpDownType; -import org.openhab.core.thing.binding.generic.converter.ColorChannelValueHandler; +import org.openhab.core.thing.binding.generic.converter.ColorChannelHandler; import org.openhab.core.types.Command; import org.openhab.core.types.State; /** * The {@link ChannelValueConverterConfig} is a base class for the channel configuration of things - * using the {@link ChannelValueHandler}s + * using the {@link ChannelHandler}s * * @author Jan N. Klug - Initial contribution */ @@ -57,7 +57,7 @@ public class ChannelValueConverterConfig { public @Nullable String decreaseValue; // color - public ColorChannelValueHandler.ColorMode colorMode = ColorChannelValueHandler.ColorMode.RGB; + public ColorChannelHandler.ColorMode colorMode = ColorChannelHandler.ColorMode.RGB; // contact public @Nullable String openValue; diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingChannelHandler.java similarity index 85% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingChannelHandler.java index 12dcd814810..1db25c50938 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingChannelHandler.java @@ -17,22 +17,22 @@ import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.Nullable; +import org.openhab.core.thing.binding.generic.ChannelHandler; +import org.openhab.core.thing.binding.generic.ChannelHandlerContent; import org.openhab.core.thing.binding.generic.ChannelMode; import org.openhab.core.thing.binding.generic.ChannelTransformation; -import org.openhab.core.thing.binding.generic.ChannelValueHandler; import org.openhab.core.thing.binding.generic.ChannelValueConverterConfig; -import org.openhab.core.thing.binding.generic.ChannelValueConverterContent; import org.openhab.core.types.Command; import org.openhab.core.types.State; import org.openhab.core.types.UnDefType; /** - * The {@link AbstractTransformingChannelValueHandler} is a base class for an item converter with transformations + * The {@link AbstractTransformingChannelHandler} is a base class for an item converter with transformations * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public abstract class AbstractTransformingChannelValueHandler implements ChannelValueHandler { +public abstract class AbstractTransformingChannelHandler implements ChannelHandler { private final Consumer updateState; private final Consumer postCommand; private final @Nullable Consumer sendValue; @@ -41,7 +41,7 @@ public abstract class AbstractTransformingChannelValueHandler implements Channel protected final ChannelValueConverterConfig channelConfig; - public AbstractTransformingChannelValueHandler(Consumer updateState, Consumer postCommand, + public AbstractTransformingChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { this.updateState = updateState; @@ -53,7 +53,7 @@ public AbstractTransformingChannelValueHandler(Consumer updateState, Cons } @Override - public void process(@Nullable ChannelValueConverterContent content) { + public void process(@Nullable ChannelHandlerContent content) { if (content == null) { updateState.accept(UnDefType.UNDEF); return; @@ -108,7 +108,7 @@ public void send(Command command) { @FunctionalInterface public interface Factory { - ChannelValueHandler create(Consumer updateState, Consumer postCommand, + ChannelHandler create(Consumer updateState, Consumer postCommand, @Nullable Consumer sendHttpValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig); } diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ColorChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ColorChannelHandler.java similarity index 94% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ColorChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ColorChannelHandler.java index ac0a0f54ec3..0a5e90d4143 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ColorChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ColorChannelHandler.java @@ -29,20 +29,20 @@ import org.openhab.core.types.UnDefType; /** - * The {@link ColorChannelValueHandler} implements {@link org.openhab.core.library.items.ColorItem} conversions + * The {@link ColorChannelHandler} implements {@link org.openhab.core.library.items.ColorItem} conversions * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class ColorChannelValueHandler extends AbstractTransformingChannelValueHandler { +public class ColorChannelHandler extends AbstractTransformingChannelHandler { private static final BigDecimal BYTE_FACTOR = BigDecimal.valueOf(2.55); private static final BigDecimal HUNDRED = BigDecimal.valueOf(100); private static final Pattern TRIPLE_MATCHER = Pattern.compile("(?\\d+),(?\\d+),(?\\d+)"); private State state = UnDefType.UNDEF; - public ColorChannelValueHandler(Consumer updateState, Consumer postCommand, + public ColorChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { super(updateState, postCommand, sendValue, stateTransformations, commandTransformations, channelConfig); diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/DimmerChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/DimmerChannelHandler.java similarity index 92% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/DimmerChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/DimmerChannelHandler.java index 16be800a86f..58e4a33c566 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/DimmerChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/DimmerChannelHandler.java @@ -26,18 +26,18 @@ import org.openhab.core.types.UnDefType; /** - * The {@link DimmerChannelValueHandler} implements {@link org.openhab.core.library.items.DimmerItem} conversions + * The {@link DimmerChannelHandler} implements {@link org.openhab.core.library.items.DimmerItem} conversions * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class DimmerChannelValueHandler extends AbstractTransformingChannelValueHandler { +public class DimmerChannelHandler extends AbstractTransformingChannelHandler { private static final BigDecimal HUNDRED = BigDecimal.valueOf(100); private State state = UnDefType.UNDEF; - public DimmerChannelValueHandler(Consumer updateState, Consumer postCommand, + public DimmerChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { super(updateState, postCommand, sendValue, stateTransformations, commandTransformations, channelConfig); diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/FixedValueMappingChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/FixedValueMappingChannelHandler.java similarity index 86% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/FixedValueMappingChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/FixedValueMappingChannelHandler.java index bda36e01670..c7b44735928 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/FixedValueMappingChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/FixedValueMappingChannelHandler.java @@ -25,15 +25,15 @@ import org.openhab.core.types.UnDefType; /** - * The {@link FixedValueMappingChannelValueHandler} implements mapping conversions for different item-types + * The {@link FixedValueMappingChannelHandler} implements mapping conversions for different item-types * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class FixedValueMappingChannelValueHandler extends AbstractTransformingChannelValueHandler { +public class FixedValueMappingChannelHandler extends AbstractTransformingChannelHandler { - public FixedValueMappingChannelValueHandler(Consumer updateState, Consumer postCommand, + public FixedValueMappingChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { super(updateState, postCommand, sendValue, stateTransformations, commandTransformations, channelConfig); diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/GenericChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/GenericChannelHandler.java similarity index 86% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/GenericChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/GenericChannelHandler.java index 75fde4630b5..7ea9f3077c4 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/GenericChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/GenericChannelHandler.java @@ -25,15 +25,15 @@ import org.openhab.core.types.UnDefType; /** - * The {@link GenericChannelValueHandler} implements simple conversions for different item types + * The {@link GenericChannelHandler} implements simple conversions for different item types * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class GenericChannelValueHandler extends AbstractTransformingChannelValueHandler { +public class GenericChannelHandler extends AbstractTransformingChannelHandler { private final Function toState; - public GenericChannelValueHandler(Function toState, Consumer updateState, + public GenericChannelHandler(Function toState, Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ImageChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ImageChannelHandler.java similarity index 74% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ImageChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ImageChannelHandler.java index 9cd2e422a59..ff23ea3289b 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ImageChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/ImageChannelHandler.java @@ -17,28 +17,28 @@ import org.eclipse.jdt.annotation.NonNullByDefault; import org.eclipse.jdt.annotation.Nullable; import org.openhab.core.library.types.RawType; -import org.openhab.core.thing.binding.generic.ChannelValueHandler; -import org.openhab.core.thing.binding.generic.ChannelValueConverterContent; +import org.openhab.core.thing.binding.generic.ChannelHandler; +import org.openhab.core.thing.binding.generic.ChannelHandlerContent; import org.openhab.core.types.Command; import org.openhab.core.types.State; import org.openhab.core.types.UnDefType; /** - * The {@link ImageChannelValueHandler} implements {@link org.openhab.core.library.items.ImageItem} conversions + * The {@link ImageChannelHandler} implements {@link org.openhab.core.library.items.ImageItem} conversions * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class ImageChannelValueHandler implements ChannelValueHandler { +public class ImageChannelHandler implements ChannelHandler { private final Consumer updateState; - public ImageChannelValueHandler(Consumer updateState) { + public ImageChannelHandler(Consumer updateState) { this.updateState = updateState; } @Override - public void process(@Nullable ChannelValueConverterContent content) { + public void process(@Nullable ChannelHandlerContent content) { if (content == null) { updateState.accept(UnDefType.UNDEF); return; diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/NumberChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/NumberChannelHandler.java similarity index 89% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/NumberChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/NumberChannelHandler.java index 90f0f617cba..2bab96a5c8b 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/NumberChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/NumberChannelHandler.java @@ -28,14 +28,14 @@ import org.openhab.core.types.UnDefType; /** - * The {@link NumberChannelValueHandler} implements {@link org.openhab.core.library.items.NumberItem} conversions + * The {@link NumberChannelHandler} implements {@link org.openhab.core.library.items.NumberItem} conversions * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class NumberChannelValueHandler extends AbstractTransformingChannelValueHandler { +public class NumberChannelHandler extends AbstractTransformingChannelHandler { - public NumberChannelValueHandler(Consumer updateState, Consumer postCommand, + public NumberChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { super(updateState, postCommand, sendValue, stateTransformations, commandTransformations, channelConfig); diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/PlayerChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/PlayerChannelHandler.java similarity index 90% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/PlayerChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/PlayerChannelHandler.java index 583b79a9b3d..b86445fa962 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/PlayerChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/PlayerChannelHandler.java @@ -26,17 +26,17 @@ import org.openhab.core.types.State; /** - * The {@link PlayerChannelValueHandler} implements {@link org.openhab.core.library.items.RollershutterItem} + * The {@link PlayerChannelHandler} implements {@link org.openhab.core.library.items.RollershutterItem} * conversions * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class PlayerChannelValueHandler extends AbstractTransformingChannelValueHandler { +public class PlayerChannelHandler extends AbstractTransformingChannelHandler { private @Nullable String lastCommand; // store last command to prevent duplicate commands - public PlayerChannelValueHandler(Consumer updateState, Consumer postCommand, + public PlayerChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { super(updateState, postCommand, sendValue, stateTransformations, commandTransformations, channelConfig); diff --git a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/RollershutterChannelValueHandler.java b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/RollershutterChannelHandler.java similarity index 91% rename from bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/RollershutterChannelValueHandler.java rename to bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/RollershutterChannelHandler.java index 84f4a67b19d..3c57d504272 100644 --- a/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/RollershutterChannelValueHandler.java +++ b/bundles/org.openhab.core.thing/src/main/java/org/openhab/core/thing/binding/generic/converter/RollershutterChannelHandler.java @@ -28,16 +28,16 @@ import org.openhab.core.types.UnDefType; /** - * The {@link RollershutterChannelValueHandler} implements {@link org.openhab.core.library.items.RollershutterItem} + * The {@link RollershutterChannelHandler} implements {@link org.openhab.core.library.items.RollershutterItem} * conversions * * @author Jan N. Klug - Initial contribution */ @NonNullByDefault -public class RollershutterChannelValueHandler extends AbstractTransformingChannelValueHandler { +public class RollershutterChannelHandler extends AbstractTransformingChannelHandler { - public RollershutterChannelValueHandler(Consumer updateState, Consumer postCommand, + public RollershutterChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateTransformations, ChannelTransformation commandTransformations, ChannelValueConverterConfig channelConfig) { super(updateState, postCommand, sendValue, stateTransformations, commandTransformations, channelConfig); diff --git a/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingItemConverterTest.java b/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingItemConverterTest.java index acab2fbda81..34683409611 100644 --- a/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingItemConverterTest.java +++ b/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/AbstractTransformingItemConverterTest.java @@ -31,16 +31,16 @@ import org.mockito.MockitoAnnotations; import org.mockito.Spy; import org.openhab.core.library.types.StringType; +import org.openhab.core.thing.binding.generic.ChannelHandlerContent; import org.openhab.core.thing.binding.generic.ChannelTransformation; import org.openhab.core.thing.binding.generic.ChannelValueConverterConfig; -import org.openhab.core.thing.binding.generic.ChannelValueConverterContent; import org.openhab.core.types.Command; import org.openhab.core.types.State; import org.openhab.core.types.UnDefType; /** * The {@link AbstractTransformingItemConverterTest} is a test class for the - * {@link AbstractTransformingChannelValueHandler} + * {@link AbstractTransformingChannelHandler} * * @author Jan N. Klug - Initial contribution */ @@ -76,9 +76,9 @@ public void close() throws Exception { @Test public void undefOnNullContentTest() { - TestChannelValueHandler realConverter = new TestChannelValueHandler(updateState, postCommand, sendHttpValue, + TestChannelHandler realConverter = new TestChannelHandler(updateState, postCommand, sendHttpValue, stateChannelTransformation, commandChannelTransformation, false); - TestChannelValueHandler converter = spy(realConverter); + TestChannelHandler converter = spy(realConverter); converter.process(null); // make sure UNDEF is send as state update @@ -94,10 +94,10 @@ public void undefOnNullContentTest() { @Test public void commandIsPostedAsCommand() { - TestChannelValueHandler converter = new TestChannelValueHandler(updateState, postCommand, sendHttpValue, + TestChannelHandler converter = new TestChannelHandler(updateState, postCommand, sendHttpValue, stateChannelTransformation, commandChannelTransformation, true); - converter.process(new ChannelValueConverterContent("TEST".getBytes(StandardCharsets.UTF_8), "", null)); + converter.process(new ChannelHandlerContent("TEST".getBytes(StandardCharsets.UTF_8), "", null)); // check state transformation is applied verify(stateChannelTransformation).apply(any()); @@ -111,10 +111,10 @@ public void commandIsPostedAsCommand() { @Test public void updateIsPostedAsUpdate() { - TestChannelValueHandler converter = new TestChannelValueHandler(updateState, postCommand, sendHttpValue, + TestChannelHandler converter = new TestChannelHandler(updateState, postCommand, sendHttpValue, stateChannelTransformation, commandChannelTransformation, false); - converter.process(new ChannelValueConverterContent("TEST".getBytes(StandardCharsets.UTF_8), "", null)); + converter.process(new ChannelHandlerContent("TEST".getBytes(StandardCharsets.UTF_8), "", null)); // check state transformation is applied verify(stateChannelTransformation).apply(any()); @@ -128,7 +128,7 @@ public void updateIsPostedAsUpdate() { @Test public void sendCommandSendsCommand() { - TestChannelValueHandler converter = new TestChannelValueHandler(updateState, postCommand, sendHttpValue, + TestChannelHandler converter = new TestChannelHandler(updateState, postCommand, sendHttpValue, stateChannelTransformation, commandChannelTransformation, false); converter.send(new StringType("TEST")); @@ -143,10 +143,10 @@ public void sendCommandSendsCommand() { verify(sendHttpValue, only()).accept("TEST"); } - private static class TestChannelValueHandler extends AbstractTransformingChannelValueHandler { + private static class TestChannelHandler extends AbstractTransformingChannelHandler { private boolean hasCommand; - public TestChannelValueHandler(Consumer updateState, Consumer postCommand, + public TestChannelHandler(Consumer updateState, Consumer postCommand, @Nullable Consumer sendValue, ChannelTransformation stateChannelTransformation, ChannelTransformation commandChannelTransformation, boolean hasCommand) { super(updateState, postCommand, sendValue, stateChannelTransformation, commandChannelTransformation, diff --git a/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/ConverterTest.java b/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/ConverterTest.java index ba6c8432ad1..1d5e2e6b24e 100644 --- a/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/ConverterTest.java +++ b/bundles/org.openhab.core.thing/src/test/java/org/openhab/core/thing/binding/generic/converter/ConverterTest.java @@ -36,9 +36,9 @@ import org.openhab.core.library.types.StringType; import org.openhab.core.library.unit.SIUnits; import org.openhab.core.library.unit.Units; +import org.openhab.core.thing.binding.generic.ChannelHandlerContent; import org.openhab.core.thing.binding.generic.ChannelTransformation; import org.openhab.core.thing.binding.generic.ChannelValueConverterConfig; -import org.openhab.core.thing.binding.generic.ChannelValueConverterContent; import org.openhab.core.types.Command; import org.openhab.core.types.State; import org.openhab.core.types.UnDefType; @@ -61,9 +61,8 @@ public class ConverterTest { @Test public void numberItemConverter() { - NumberChannelValueHandler converter = new NumberChannelValueHandler(updateStateMock, postCommandMock, - sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), - new ChannelValueConverterConfig()); + NumberChannelHandler converter = new NumberChannelHandler(updateStateMock, postCommandMock, sendValueMock, + new ChannelTransformation(null), new ChannelTransformation(null), new ChannelValueConverterConfig()); // without unit Assertions.assertEquals(Optional.of(new DecimalType(1234)), converter.toState("1234")); @@ -80,8 +79,8 @@ sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), public void numberItemConverterWithUnit() { ChannelValueConverterConfig channelConfig = new ChannelValueConverterConfig(); channelConfig.unit = "W"; - NumberChannelValueHandler converter = new NumberChannelValueHandler(updateStateMock, postCommandMock, - sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), channelConfig); + NumberChannelHandler converter = new NumberChannelHandler(updateStateMock, postCommandMock, sendValueMock, + new ChannelTransformation(null), new ChannelTransformation(null), channelConfig); // without unit Assertions.assertEquals(Optional.of(new QuantityType<>(500, Units.WATT)), converter.toState("500")); @@ -93,19 +92,19 @@ public void numberItemConverterWithUnit() { @Test public void stringTypeConverter() { - GenericChannelValueHandler converter = createConverter(StringType::new); + GenericChannelHandler converter = createConverter(StringType::new); Assertions.assertEquals(Optional.of(new StringType("Test")), converter.toState("Test")); } @Test public void decimalTypeConverter() { - GenericChannelValueHandler converter = createConverter(DecimalType::new); + GenericChannelHandler converter = createConverter(DecimalType::new); Assertions.assertEquals(Optional.of(new DecimalType(15.6)), converter.toState("15.6")); } @Test public void pointTypeConverter() { - GenericChannelValueHandler converter = createConverter(PointType::new); + GenericChannelHandler converter = createConverter(PointType::new); Assertions.assertEquals( Optional.of(new PointType(new DecimalType(51.1), new DecimalType(7.2), new DecimalType(100))), converter.toState("51.1, 7.2, 100")); @@ -115,10 +114,10 @@ public void pointTypeConverter() { public void playerItemTypeConverter() { ChannelValueConverterConfig cfg = new ChannelValueConverterConfig(); cfg.playValue = "PLAY"; - ChannelValueConverterContent content = new ChannelValueConverterContent("PLAY".getBytes(StandardCharsets.UTF_8), - "UTF-8", null); - PlayerChannelValueHandler converter = new PlayerChannelValueHandler(updateStateMock, postCommandMock, - sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), cfg); + ChannelHandlerContent content = new ChannelHandlerContent("PLAY".getBytes(StandardCharsets.UTF_8), "UTF-8", + null); + PlayerChannelHandler converter = new PlayerChannelHandler(updateStateMock, postCommandMock, sendValueMock, + new ChannelTransformation(null), new ChannelTransformation(null), cfg); converter.process(content); converter.process(content); @@ -129,11 +128,11 @@ public void playerItemTypeConverter() { @Test public void colorItemTypeRGBConverter() { ChannelValueConverterConfig cfg = new ChannelValueConverterConfig(); - cfg.colorMode = ColorChannelValueHandler.ColorMode.RGB; - ChannelValueConverterContent content = new ChannelValueConverterContent( - "123,34,47".getBytes(StandardCharsets.UTF_8), "UTF-8", null); - ColorChannelValueHandler converter = new ColorChannelValueHandler(updateStateMock, postCommandMock, - sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), cfg); + cfg.colorMode = ColorChannelHandler.ColorMode.RGB; + ChannelHandlerContent content = new ChannelHandlerContent("123,34,47".getBytes(StandardCharsets.UTF_8), "UTF-8", + null); + ColorChannelHandler converter = new ColorChannelHandler(updateStateMock, postCommandMock, sendValueMock, + new ChannelTransformation(null), new ChannelTransformation(null), cfg); converter.process(content); Mockito.verify(updateStateMock).accept(HSBType.fromRGB(123, 34, 47)); @@ -142,11 +141,11 @@ public void colorItemTypeRGBConverter() { @Test public void colorItemTypeHSBConverter() { ChannelValueConverterConfig cfg = new ChannelValueConverterConfig(); - cfg.colorMode = ColorChannelValueHandler.ColorMode.HSB; - ChannelValueConverterContent content = new ChannelValueConverterContent( - "123,34,47".getBytes(StandardCharsets.UTF_8), "UTF-8", null); - ColorChannelValueHandler converter = new ColorChannelValueHandler(updateStateMock, postCommandMock, - sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), cfg); + cfg.colorMode = ColorChannelHandler.ColorMode.HSB; + ChannelHandlerContent content = new ChannelHandlerContent("123,34,47".getBytes(StandardCharsets.UTF_8), "UTF-8", + null); + ColorChannelHandler converter = new ColorChannelHandler(updateStateMock, postCommandMock, sendValueMock, + new ChannelTransformation(null), new ChannelTransformation(null), cfg); converter.process(content); Mockito.verify(updateStateMock).accept(new HSBType("123,34,47")); @@ -155,34 +154,33 @@ public void colorItemTypeHSBConverter() { @Test public void rollerSHutterConverter() { ChannelValueConverterConfig cfg = new ChannelValueConverterConfig(); - RollershutterChannelValueHandler converter = new RollershutterChannelValueHandler(updateStateMock, - postCommandMock, sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), cfg); + RollershutterChannelHandler converter = new RollershutterChannelHandler(updateStateMock, postCommandMock, + sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), cfg); // test 0 and 100 - ChannelValueConverterContent content = new ChannelValueConverterContent("0".getBytes(StandardCharsets.UTF_8), - "UTF-8", null); + ChannelHandlerContent content = new ChannelHandlerContent("0".getBytes(StandardCharsets.UTF_8), "UTF-8", null); converter.process(content); Mockito.verify(updateStateMock).accept(PercentType.ZERO); - content = new ChannelValueConverterContent("100".getBytes(StandardCharsets.UTF_8), "UTF-8", null); + content = new ChannelHandlerContent("100".getBytes(StandardCharsets.UTF_8), "UTF-8", null); converter.process(content); Mockito.verify(updateStateMock).accept(PercentType.HUNDRED); // test under/over-range (expect two times total for zero/100 - content = new ChannelValueConverterContent("-1".getBytes(StandardCharsets.UTF_8), "UTF-8", null); + content = new ChannelHandlerContent("-1".getBytes(StandardCharsets.UTF_8), "UTF-8", null); converter.process(content); Mockito.verify(updateStateMock, Mockito.times(2)).accept(PercentType.ZERO); - content = new ChannelValueConverterContent("105".getBytes(StandardCharsets.UTF_8), "UTF-8", null); + content = new ChannelHandlerContent("105".getBytes(StandardCharsets.UTF_8), "UTF-8", null); converter.process(content); Mockito.verify(updateStateMock, Mockito.times(2)).accept(PercentType.HUNDRED); // test value - content = new ChannelValueConverterContent("67".getBytes(StandardCharsets.UTF_8), "UTF-8", null); + content = new ChannelHandlerContent("67".getBytes(StandardCharsets.UTF_8), "UTF-8", null); converter.process(content); Mockito.verify(updateStateMock).accept(new PercentType(67)); } - public GenericChannelValueHandler createConverter(Function fcn) { - return new GenericChannelValueHandler(fcn, updateStateMock, postCommandMock, sendValueMock, + public GenericChannelHandler createConverter(Function fcn) { + return new GenericChannelHandler(fcn, updateStateMock, postCommandMock, sendValueMock, new ChannelTransformation(null), new ChannelTransformation(null), new ChannelValueConverterConfig()); } }