public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rework ThingActions (#8732)

Browse Source 
* Remove proxy workarounds
* Move ThingActions and a few other classes into the internal package
* Use more consistent action labels/descriptions

Related to:

* openhab/openhab-core#1714
* openhab/openhab-core#1639

Signed-off-by: Wouter Born <github@maindrain.net>
This commit is contained in:
Wouter Born
2020-10-14 19:01:12 +02:00
committed by GitHub
parent 4adc214c69
commit bef1046258
86 changed files with 708 additions and 2096 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/IRadioThermostatThingActions.java
View File

@@ -1,28 +0,0 @@
/**
* Copyright (c) 2010-2020 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.radiothermostat.internal;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
/**
* The {@link IRadioThermostatThingActions} defines the interface for all thing actions supported by the binding.
* These methods, parameters, and return types are explained in {@link RadioThermostatThingActions}.
*
* @author Michael Lobstein - Initial contribution
*/
@NonNullByDefault
public interface IRadioThermostatThingActions {
void sendRawCommand(@Nullable String rawCommand);
}

43
bundles/org.openhab.binding.radiothermostat/src/main/java/org/openhab/binding/radiothermostat/internal/RadioThermostatThingActions.java
View File

@@ -12,9 +12,6 @@
*/
package org.openhab.binding.radiothermostat.internal;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.radiothermostat.internal.handler.RadioThermostatHandler;
@@ -30,24 +27,22 @@ import org.slf4j.LoggerFactory;
* Some automation actions to be used with a {@link RadioThermostatThingActions}
*
* @author Michael Lobstein - initial contribution
*
*/
@ThingActionsScope(name = "radiothermostat")
@NonNullByDefault
public class RadioThermostatThingActions implements ThingActions, IRadioThermostatThingActions {
public class RadioThermostatThingActions implements ThingActions {
private final Logger logger = LoggerFactory.getLogger(RadioThermostatThingActions.class);
private @Nullable RadioThermostatHandler handler;
@Override
@RuleAction(label = "sendRawCommand", description = "Action that sends raw command to the thermostat")
@RuleAction(label = "send a raw command", description = "Send a raw command to the thermostat.")
public void sendRawCommand(@ActionInput(name = "sendRawCommand") @Nullable String rawCommand) {
RadioThermostatHandler localHandler = handler;
if (rawCommand == null) {
logger.warn("sendRawCommand called with null command, ignoring");
return;
}
RadioThermostatHandler localHandler = handler;
if (localHandler != null) {
localHandler.handleRawCommand(rawCommand);
logger.debug("sendRawCommand called with raw command: {}", rawCommand);
@@ -55,9 +50,12 @@ public class RadioThermostatThingActions implements ThingActions, IRadioThermost
}
/** Static alias to support the old DSL rules engine and make the action available there. */
public static void sendRawCommand(@Nullable ThingActions actions, @Nullable String rawCommand)
throws IllegalArgumentException {
invokeMethodOf(actions).sendRawCommand(rawCommand);
public static void sendRawCommand(@Nullable ThingActions actions, @Nullable String rawCommand) {
if (actions instanceof RadioThermostatThingActions) {
((RadioThermostatThingActions) actions).sendRawCommand(rawCommand);
} else {
throw new IllegalArgumentException("Actions is not an instance of RadioThermostatThingActions");
}
}
@Override
@@ -67,27 +65,6 @@ public class RadioThermostatThingActions implements ThingActions, IRadioThermost
@Override
public @Nullable ThingHandler getThingHandler() {
return this.handler;
}
private static IRadioThermostatThingActions invokeMethodOf(@Nullable ThingActions actions) {
if (actions == null) {
throw new IllegalArgumentException("actions cannot be null");
}
if (actions.getClass().getName().equals(RadioThermostatThingActions.class.getName())) {
if (actions instanceof RadioThermostatThingActions) {
return (IRadioThermostatThingActions) actions;
} else {
return (IRadioThermostatThingActions) Proxy.newProxyInstance(
IRadioThermostatThingActions.class.getClassLoader(),
new Class[] { IRadioThermostatThingActions.class },
(Object proxy, Method method, Object[] args) -> {
Method m = actions.getClass().getDeclaredMethod(method.getName(),
method.getParameterTypes());
return m.invoke(actions, args);
});
}
}
throw new IllegalArgumentException("Actions is not an instance of RadioThermostatThingActions");
return handler;
}
}