Package org.openhab.core.automation.util

Class ActionInputsHelper

java.lang.Object

org.openhab.core.automation.util.ActionInputsHelper

@NonNullByDefault
public class ActionInputsHelper
extends Object

This is an utility class to convert the Inputs of a ActionType into a list of ConfigDescriptionParameters and to convert serialised inputs to the Java types required by the Inputs of a ActionType.

Author:

Laurent Garnier and Florian Hotze - Initial contribution

Constructor Summary

Constructors

Constructor	Description
ActionInputsHelper(TimeZoneProvider timeZoneProvider, UnitProvider unitProvider)

Method Summary

Modifier and Type	Method	Description
List<ConfigDescriptionParameter>	mapActionInputsToConfigDescriptionParameters(List<Input> inputs)	Maps a list of Inputs to a list of ConfigDescriptionParameters.
ConfigDescriptionParameter	mapActionInputToConfigDescriptionParameter(Input input)	Maps an Input to a ConfigDescriptionParameter.
Map<String,Object>	mapSerializedInputsToActionInputs(ActionType actionType, Map<String,Object> arguments)	Maps serialised inputs to the Java types required by the Inputs of the given ActionType.
Object	mapSerializedInputToActionInput(Input input, Object argument)	Maps a serialised input to the Java type required by the given Input.

Methods inherited from class java.lang.Object

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

Constructor Details

ActionInputsHelper

public ActionInputsHelper(TimeZoneProvider timeZoneProvider,
 UnitProvider unitProvider)

Method Details

mapActionInputsToConfigDescriptionParameters

public List<ConfigDescriptionParameter> mapActionInputsToConfigDescriptionParameters(List<Input> inputs)
                                                                              throws IllegalArgumentException

Maps a list of Inputs to a list of ConfigDescriptionParameters.

Parameters:

inputs - the list of inputs to map to config description parameters

Returns:

the list of config description parameters

Throws:

IllegalArgumentException - if at least one of the input parameters has an unsupported type

mapActionInputToConfigDescriptionParameter

public ConfigDescriptionParameter mapActionInputToConfigDescriptionParameter(Input input)
                                                                      throws IllegalArgumentException

Maps an Input to a ConfigDescriptionParameter.

Parameters:

input - the input to map to a config description parameter

Returns:

the config description parameter

Throws:

IllegalArgumentException - if the input parameter has an unsupported type

mapSerializedInputsToActionInputs

public Map<String,Object> mapSerializedInputsToActionInputs(ActionType actionType,
 Map<String,Object> arguments)

Maps serialised inputs to the Java types required by the Inputs of the given ActionType.

Parameters:

actionType - the action type whose inputs to consider

arguments - the serialised arguments

Returns:

the mapped arguments

mapSerializedInputToActionInput

public Object mapSerializedInputToActionInput(Input input,
 Object argument)
                                       throws IllegalArgumentException

Maps a serialised input to the Java type required by the given Input.

Parameters:

input - the input whose type to consider

argument - the serialised argument

Returns:

the mapped argument

Throws:

IllegalArgumentException - if the mapping failed