/**
* Configure the optional elements of the Ruby Environment
*
- * @param engine Engine in which to configure environment
+ * @param scriptEngine Engine in which to configure environment
*/
public void configureRubyEnvironment(ScriptEngine scriptEngine) {
getConfigurationElements(OptionalConfigurationElement.Type.RUBY_ENVIRONMENT).forEach(configElement -> {
@Override
public @Nullable Object get(String scriptIdentifier, String type) throws IllegalArgumentException {
-
Map<String, Object> forScript = idToTypes.computeIfAbsent(scriptIdentifier, k -> new HashMap<>());
return forScript.computeIfAbsent(type,
k -> Objects.nonNull(types.get(k)) ? types.get(k).apply(scriptIdentifier) : null);
@Override
public @Nullable Object get(String scriptIdentifier, String type) throws IllegalArgumentException {
-
Map<String, Object> forScript = idToTypes.computeIfAbsent(scriptIdentifier, k -> new HashMap<>());
return forScript.computeIfAbsent(type,
k -> Objects.nonNull(types.get(k)) ? types.get(k).apply(scriptIdentifier) : null);
/**
* Notify listener about state change of on/off and brightness state
*
- * @param zoneID zone ID for which change occurred
+ * @param zoneId zone ID for which change occurred
* @param onOff new on/off state
* @param brightness new brightness
*/
import com.google.gson.JsonObject;
/**
- * The {@link $AirqHandler} is responsible for retrieving all information from the air-Q device
+ * The {@link AirqHandler} is responsible for retrieving all information from the air-Q device
* and change properties and channels accordingly.
*
* @author Aurelio Caliaro - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link AirQualityBinding} class defines common constants, which are
+ * The {@link AirQualityBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Gaël L'hopital - Initial contribution
import org.eclipse.jdt.annotation.Nullable;
/**
- * The {@link ADCCommand} class represents an alarm decoder command, and contains the static methods and definitions
+ * The {@link ADCommand} class represents an alarm decoder command, and contains the static methods and definitions
* used to construct one. Not all supported AD commands are necessarily used by the current binding.
*
* @author Bob Adair - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link AllPlayBinding} class defines common constants, which are
+ * The {@link AllPlayBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Dominic Lerbs - Initial contribution
/**
* Callback method to handle a captured packet.
*
- * @param macAddress The mac address which sent the packet
+ * @param sourceMacAddress The mac address which sent the packet
*/
void packetCaptured(MacAddress sourceMacAddress);
}
// shuffle command
if (channelId.equals(CHANNEL_SHUFFLE)) {
if (command instanceof OnOffType value) {
-
connection.command(device, "{\"type\":\"ShuffleCommand\",\"shuffle\":\""
+ (value == OnOffType.ON ? "true" : "false") + "\"}");
}
}
androidtvPKI.setCaCert(shimX509ClientChain[0]);
androidtvPKI.saveKeyStore(config.keystorePassword, this.encryptionKey);
-
}
} catch (Exception e) {
logger.trace("setShimX509ClientChain Exception", e);
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link AnthemCommend} is responsible for creating commands to be sent to the
+ * The {@link AnthemCommand} is responsible for creating commands to be sent to the
* Anthem processor.
*
* @author Mark Hilbush - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link AstroBinding} class defines common constants, which are
+ * The {@link AstroBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Gerhard Riegler - Initial contribution
/**
* Adds the provided {@link Job} to the queue (cannot be {@code null})
- *
- * @return {@code true} if the {@code job} is added to the queue, otherwise {@code false}
*/
public void schedule(Job job, Calendar eventAt) {
long sleepTime;
/**
* Sends a synchronous HTTP request.
*
- * The result will be handled in {@link #handleHttpSuccessResponse(String, String) or
+ * The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or
* {@link #handleHttpResultError(Throwable)}.
*
* If the response should be returned use {@link #getSyncRequest(String, String)} instead.
/**
* Sends an asynchronous HTTP request so it does not wait for an answer.
*
- * The result will be handled in {@link #handleHttpSuccessResponse(String, String) or
+ * The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or
* {@link #handleHttpResultError(Throwable)}.
*
* @param url the URL to which the request is sent to
/**
* Raises a new error.
*
- * @param exception the exception
+ * @param ex the exception
*/
public void raiseError(Exception ex) {
raiseError(ex, "");
/**
* Raises a new error.
*
- * @param exception the exception
+ * @param ex the exception
* @param infoMessage optional info message
*/
public void raiseError(Exception ex, @Nullable String infoMessage) {
/**
* Constructor.
*
- * @param interfaceName name of interface
+ * @param ifName name of interface
* @param jsonObject with ipInfo
*/
public AsuswrtIpInfo(String ifName, JsonObject jsonObject) {
/**
* Fire Event
*
- * @param channelUID chanelUID event belongs to
+ * @param channel chanelUID event belongs to
* @param event event-name is fired
*/
protected void fireEvent(String channel, String event) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link AtlonaBinding} class defines common constants, which are used across the whole binding.
+ * The {@link AtlonaBindingConstants} class defines common constants, which are used across the whole binding.
*
* @author Tim Roberts - Initial contribution
* @author Michael Lobstein - Add support for AT-PRO3HD 44/66 M
/**
*
- * A callback to {@link AtlonaHandler} that can be used to update the status, properties and state of the thing.
+ * A callback to {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+ * that can be used to update the status, properties and state of the thing.
*
* @author Tim Roberts - Initial contribution
*/
@NonNullByDefault
public interface AtlonaHandlerCallback {
/**
- * Callback to the {@link AtlonaHandler} to update the status of the thing.
+ * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+ * to update the status of the thing.
*
* @param status a non-null {@link org.openhab.core.thing.ThingStatus}
* @param detail a non-null {@link org.openhab.core.thing.ThingStatusDetail}
void statusChanged(ThingStatus status, ThingStatusDetail detail, @Nullable String msg);
/**
- * Callback to the {@link AtlonaHandler} to update the state of an item
+ * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+ * to update the state of an item
*
* @param channelId the non-null, non-empty channel id
- * @param state the new non-null {@State}
+ * @param state the new non-null {@link State}
*/
void stateChanged(String channelId, State state);
/**
- * Callback to the {@link AtlonaHandler} to update the property of a thing
+ * Callback to the {@link org.openhab.binding.atlona.internal.handler.AtlonaHandler}
+ * to update the property of a thing
*
* @param propertyName a non-null, non-empty property name
* @param propertyValue a non-null, possibly empty property value
public class AtlonaPro3Config {
/**
- * Constant field used in {@link AtlonaDiscovery} to set the config property during discovery. Value of this field
+ * Constant field used in {@link org.openhab.binding.atlona.internal.discovery.AtlonaDiscovery}
+ * to set the config property during discovery. Value of this field
* needs to match {@link #ipAddress}
*/
public static final String IP_ADDRESS = "ipAddress";
* Handles commands to specific channels. This implementation will offload much of its work to the
* {@link AtlonaPro3PortocolHandler}. Basically we validate the type of command for the channel then call the
* {@link AtlonaPro3PortocolHandler} to handle the actual protocol. Special use case is the {@link RefreshType}
- * where we call {{@link #handleRefresh(String)} to handle a refresh of the specific channel (which in turn calls
+ * where we call {{@link #handleRefresh(ChannelUID)} to handle a refresh of the specific channel (which in turn
+ * calls
* {@link AtlonaPro3PortocolHandler} to handle the actual refresh
*/
@Override
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link AutelisBinding} class defines common constants, which are used
+ * The {@link AutelisBindingConstants} class defines common constants, which are used
* across the whole binding.
*
* @author Dan Cunningham - Initial contribution
* used across the whole binding.
*
* @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
*/
@NonNullByDefault
public class AutomowerBindingConstants {
/**
* @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
*/
public class Calendar {
private List<CalendarTask> tasks = new ArrayList<>();
/**
* @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
*/
public class Planner {
private long nextStartTimestamp;
* sent to one of the channels.
*
* @author Markus Pfleger - Initial contribution
- * @author Marcin Czeczko - Added support for planner & calendar data
+ * @author Marcin Czeczko - Added support for planner and calendar data
*/
@NonNullByDefault
public class AutomowerHandler extends BaseThingHandler {
/**
* Converts a FRITZ!Box value to a percent value.
*
- * @param fritzValue The FRITZ!Box value to be converted
+ * @param saturation The FRITZ!Box value to be converted
* @return The percent value
*/
public static PercentType toPercent(int saturation) {
import javax.xml.bind.annotation.XmlRootElement;
/**
- * See {@ TemplateModel}.
+ * See {@link TemplateModel}.
*
* @author Christoph Weitkamp - Initial contribution
*/
import javax.xml.bind.annotation.XmlRootElement;
/**
- * See {@ TemplateModel}.
+ * See {@link TemplateModel}.
*
* @author Christoph Weitkamp - Initial contribution
*/
*
* @param webIface Interface to FRITZ!Box
* @param ain AIN of the device that should be switched
- * @param level Opening level percentage (0 ... 100)
+ * @param levelPercentage Opening level percentage (0 ... 100)
*/
public FritzAhaSetLevelPercentageCallback(FritzAhaWebInterface webIface, String ain, BigDecimal levelPercentage) {
super(WEBSERVICE_PATH, "switchcmd=setlevelpercentage&level=" + levelPercentage + "&ain=" + ain, webIface, GET,
* The {@link BenqProjectorHandler} is responsible for handling commands, which are
* sent to one of the channels.
*
- * Based on 'epsonprojector' originally by Pauli Anttila & Yannick Schaus
+ * Based on 'epsonprojector' originally by Pauli Anttila and Yannick Schaus
*
* @author Michael Lobstein - Initial contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * Configuration class for {@link AirthingsBinding} device.
+ * Configuration class for Airthings device.
*
* @author Pauli Anttila - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * An extended {@link BluetoothDevice} class to handle BlueGiga specific information
+ * An extended {@link BaseBluetoothDevice} class to handle BlueGiga specific information
*
* @author Chris Jackson - Initial contribution
*/
};
/**
- * Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BluetoothDevice} for the BlueGiga
+ * Creates a new {@link BlueGigaBluetoothDevice} which extends {@link BaseBluetoothDevice} for the BlueGiga
* implementation
*
* @param bgHandler the {@link BlueGigaBridgeHandler} that provides the link to the dongle
public void bluegigaEventReceived(@Nullable BlueGigaResponse event) {
if (event instanceof BlueGigaScanResponseEvent scanEvent) {
if (initComplete) {
-
// We use the scan event to add any devices we hear to the devices list
// The device gets created, and then manages itself for discovery etc.
BluetoothAddress sender = new BluetoothAddress(scanEvent.getSender());
* FIFO queue. This method queues a {@link BlueGigaCommand} frame without
* waiting for a response.
*
- * @param transaction
+ * @param request
* {@link BlueGigaUniqueCommand}
*/
public void queueFrame(BlueGigaUniqueCommand request) {
if (bleCommand instanceof BlueGigaDeviceCommand devCommand
&& bleResponse instanceof BlueGigaDeviceResponse devResponse) {
-
logger.trace("Expected connection id: {}, received connection id: {}", devCommand.getConnection(),
devResponse.getConnection());
/**
* Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist.
*
- * @param bluetoothAddressType
+ * @param eirDataType
* the code to lookup
* @return enumeration value.
*/
/**
* Lookup function based on the type code. Returns {@link UNKNOWN} if the code does not exist.
*
- * @param bluetoothAddressType
+ * @param eirFlag
* the code to lookup
* @return enumeration value.
*/
*
* @param adapter the bridge handler through which this device is connected
* @param address the Bluetooth address of the device
- * @param name the name of the device
*/
public BlueZBluetoothDevice(BlueZBridgeHandler adapter, BluetoothAddress address) {
super(adapter, address);
/**
*
- * @param payload
+ * @param message
* @return true if this handler should be removed from the handler list
*/
boolean handleReceivedMessage(R message);
/**
*
- * @param payload
+ * @param message
+ * @param th
* @return true if this handler should be removed from the handler list
*/
boolean handleFailedMessage(T message, Throwable th);
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * Configuration class for {@link RadoneyeBinding} device.
+ * Configuration class for Radoneye device.
*
* @author Peter Obel - Initial contribution
*/
* Construct a Bluetooth device taking the Bluetooth address
*
* @param adapter
- * @param sender
+ * @param address
*/
public BaseBluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) {
super(adapter, address);
/**
* Sets the device transmit power
*
- * @param power the current transmitter power in dBm
+ * @param txPower the current transmitter power in dBm
*/
public void setTxPower(int txPower) {
this.txPower = txPower;
}
/**
- * Get the service to which this characteristic belongs
- *
- * @return the {@link BluetoothService}
+ * Set the service to which this characteristic belongs
*/
public void setService(BluetoothService service) {
this.service = service;
* Construct a Bluetooth device taking the Bluetooth address
*
* @param adapter
- * @param sender
+ * @param address
*/
public BluetoothDevice(BluetoothAdapter adapter, BluetoothAddress address) {
this.address = address;
/**
* Connects to a device. This is an asynchronous method. Once the connection state is updated, the
- * {@link BluetoothDeviceListener.onConnectionState} method will be called with the connection state.
+ * {@link BluetoothDeviceListener#onConnectionStateChange} method will be called with the connection state.
* <p>
* If the device is already connected, this will return false.
*
/**
* Disconnects from a device. Once the connection state is updated, the
- * {@link BluetoothDeviceListener.onConnectionState}
+ * {@link BluetoothDeviceListener#onConnectionStateChange}
* method will be called with the connection state.
* <p>
* If the device is not currently connected, this will return false.
/**
* Sets the device transmit power
*
- * @param power the current transmitter power in dBm
+ * @param txPower the current transmitter power in dBm
*/
public void setTxPower(int txPower) {
this.txPower = txPower;
/**
* Set the serial number of the device
*
- * @param model a {@link String} defining the serial number
+ * @param serialNumber a {@link String} defining the serial number
*/
public void setSerialNumberl(String serialNumber) {
this.serialNumber = serialNumber;
/**
* Set the hardware revision of the device
*
- * @param model a {@link String} defining the hardware revision
+ * @param hardwareRevision a {@link String} defining the hardware revision
*/
public void setHardwareRevision(String hardwareRevision) {
this.hardwareRevision = hardwareRevision;
/**
* Set the firmware revision of the device
*
- * @param model a {@link String} defining the firmware revision
+ * @param firmwareRevision a {@link String} defining the firmware revision
*/
public void setFirmwareRevision(String firmwareRevision) {
this.firmwareRevision = firmwareRevision;
/**
* Set the software revision of the device
*
- * @param model a {@link String} defining the software revision
+ * @param softwareRevision a {@link String} defining the software revision
*/
public void setSoftwareRevision(String softwareRevision) {
this.softwareRevision = softwareRevision;
/**
* This merges non-null identity fields from the given device into this snapshot.
- *
- * @return true if this snapshot changed as a result of this operation
*/
public void merge(BluetoothDeviceSnapshot device) {
Integer txPower = device.getTxPower();
/**
* The {@link BluetoothDiscoveryProcess} does the work of creating a DiscoveryResult from a set of
- * {@link BluetoothDisocveryParticipant}s
+ * {@link BluetoothDiscoveryParticipant}s
*
* @author Connor Petty - Initial Contribution
*/
/**
* Sets the beacon type for this packet
*
- * @beaconType the {@link BluetoothBeaconType} for this packet
+ * @param beaconType the {@link BluetoothBeaconType} for this packet
*/
public void setBeaconType(BluetoothBeaconType beaconType) {
this.beaconType = beaconType;
/**
* Constructor of the receiver runnable thread.
*
- * @param address The address of the Bond Bridge
+ * @param bridgeHandler The handler of the Bond Bridge
* @throws SocketException is some problem occurs opening the socket.
*/
public BPUPListener(BondBridgeHandler bridgeHandler) {
* Executes a device action
*
* @param deviceId The ID of the device
- * @param actionId The Bond action
+ * @param action The Bond action
* @param argument An additional argument for the actions (such as the fan speed)
*/
public synchronized void executeDeviceAction(String deviceId, BondDeviceAction action, @Nullable Integer argument) {
import org.eclipse.jdt.annotation.Nullable;
/**
- * The {@link BondHomeConfiguration} class contains fields mapping thing configuration parameters.
+ * The {@link BondDeviceConfiguration} class contains fields mapping thing configuration parameters.
*
* @author Sara Geleskie Damiano - Initial contribution
*/
/**
* Forwards a push update to a device
*
- * @param the {@link BPUPUpdate object}
+ * @param pushUpdate the {@link BPUPUpdate object}
*/
public void forwardUpdateToThing(BPUPUpdate pushUpdate) {
updateStatus(ThingStatus.ONLINE);
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * {@link} AuthorizationListener} is used for notifying {@link BoschAccountHandler}
- * when authorization state has changed and for notifying {@link BoschIndegoHandler}
+ * {@link AuthorizationListener} is used for notifying
+ * {@link org.openhab.binding.boschindego.internal.handler.BoschAccountHandler}
+ * when authorization state has changed and for notifying
+ * {@link org.openhab.binding.boschindego.internal.handler.BoschIndegoHandler}
* when authorization flow is completed.
*
* @author Jacob Laursen - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link BoschIndegoBinding} class defines common constants, which are
+ * The {@link BoschIndegoBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Jonas Fleck - Initial contribution
/**
* Sends a PUT/POST request to the server.
*
- * @param method the type of request ({@link HttpMethod.PUT} or {@link HttpMethod.POST})
+ * @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod.PUT} or
+ * {@link org.eclipse.jetty.http.HttpMethod.POST})
* @param path the relative path to which the request should be sent
* @param requestDto the DTO which should be sent to the server as JSON
* @throws IndegoAuthenticationException if request was rejected as unauthorized
package org.openhab.binding.boschindego.internal.dto.response.runtime;
/**
- * Total/session runtime information for {@link DeviceStateResponse}
+ * Total/session runtime information for
+ * {@link org.openhab.binding.boschindego.internal.dto.response.DeviceStateResponse}
*
* @author Jacob Laursen - Initial contribution
*/
/**
* Initializes this handler. Use this method to register all services of the device with
- * {@link #registerService(BoschSHCService)}.
+ * {@link #registerService(TService, Consumer<TState>, Collection<String>, boolean)}.
*/
@Override
public void initialize() {
}
/**
- * Returns a SmartHome URL for the endpoint - shortcut of {@link BoschSslUtil::getBoschShcUrl()}
+ * Returns a SmartHome URL for the endpoint - shortcut of {@link #getBoschShcUrl(String)}
*
* @param endpoint an endpoint, see https://apidocs.bosch-smarthome.com/local/index.html
* @return SmartHome URL for passed endpoint
import org.openhab.core.library.types.OnOffType;
/**
- * State for {@link ChildLockService} to activate and deactivate the child lock
- * of a device.
+ * State for {@link org.openhab.binding.boschshc.internal.services.childlock.ChildLockService}
+ * to activate and deactivate the child lock of a device.
*
* @author Christian Oeing - Initial contribution
*/
import org.openhab.binding.boschshc.internal.services.dto.BoschSHCServiceState;
/**
- * State for {@link PowerMeterService}
+ * State for {@link org.openhab.binding.boschshc.internal.services.powermeter.PowerMeterService}
*
* @author Stefan Kästle - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link BoseSoundTouchBindinConstantsg} class defines common constants, which are
+ * The {@link BoseSoundTouchBindinConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Christian Niessner - Initial contribution
/**
* Post RemoteKey on the device
*
- * @param command the command is Type of RemoteKeyType
+ * @param key the key is Type of RemoteKeyType
*/
public void postRemoteKey(RemoteKeyType key) {
sendPostRequestInWebSocket("key", "mainNode=\"keyPress\"",
/**
* Returns a Collection of all Presets
- *
- * @param operationModeType
*/
public Collection<ContentItem> getAllPresets() {
return mapOfPresets.values();
}
private void createScanner() {
-
long timestampOfLastScan = getTimestampOfLastScan();
BLDevice[] blDevices = new BLDevice[0];
try {
}
protected void refreshData() {
-
AdvancedStatusInfo advancedStatusInfo = advancedStatusInfoExpiringCache.getValue();
if (advancedStatusInfo == null) {
return;
import org.unbescape.html.HtmlEscape;
/**
- * The {@link BsbLanParameterHandler} is responsible for updating the data, which are
+ * The {@link BsbLanParameterConverter} is responsible for updating the data, which are
* sent to one of the channels.
*
* @author Peter Schraffl - Initial contribution
*
* @return the list of registered subscriptions, or an empty {@link List} in case of no subscriptions found
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
List<Subscription> getSubscriptions() throws SmartherGatewayException;
*
* @return the identifier this subscription has been registered under
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
String subscribePlant(String plantId, String notificationUrl) throws SmartherGatewayException;
* @param subscriptionId
* the identifier of the subscription to be removed for the given plant
*
- * @return {@code true} if the plant is successfully unsubscribed, {@code false} otherwise
- *
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
void unsubscribePlant(String plantId, String subscriptionId) throws SmartherGatewayException;
*
* @return the current status of the chronothermostat module
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
ModuleStatus getModuleStatus(String plantId, String moduleId) throws SmartherGatewayException;
/**
* Sends new settings to be applied to a given chronothermostat module.
*
- * @param settings
+ * @param moduleSettings
* the module settings to be applied
*
* @return {@code true} if the settings have been successfully applied, {@code false} otherwise
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
boolean setModuleStatus(ModuleSettings moduleSettings) throws SmartherGatewayException;
*
* @return the list of registered programs, or an empty {@link List} in case of no programs found
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
List<Program> getModulePrograms(String plantId, String moduleId) throws SmartherGatewayException;
*
* @return a string containing the name of the authorized BTicino/Legrand portal user
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API or no account handler found
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API or no account handler
+ * found
*/
public String dispatchAuthorization(String servletBaseURL, String state, String code)
throws SmartherGatewayException {
* @param notification
* the received notification to handle
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API or no notification handler found
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API or no notification handler
+ * found
*/
public void dispatchNotification(Notification notification) throws SmartherGatewayException {
final Sender sender = notification.getSender();
* @param plantId
* the identifier of the plant the notification endpoint belongs to
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
void registerNotification(String plantId) throws SmartherGatewayException;
* @param plantId
* the identifier of the plant the notification endpoint belongs to
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the Smarther API
+ * @throws SmartherGatewayException in case of communication issues with the Smarther API
*/
void unregisterNotification(String plantId) throws SmartherGatewayException;
}
*
* @return the list of registered plants, or an empty {@link List} in case of no plants found
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public List<Plant> getPlants() throws SmartherGatewayException {
try {
*
* @return the list of registered modules, or an empty {@link List} in case the plant contains no module
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public List<Module> getPlantModules(String plantId) throws SmartherGatewayException {
try {
*
* @return the current status of the chronothermostat module
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public ModuleStatus getModuleStatus(String plantId, String moduleId) throws SmartherGatewayException {
try {
*
* @return {@code true} if the settings have been successfully applied, {@code false} otherwise
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public boolean setModuleStatus(ModuleSettings settings) throws SmartherGatewayException {
// Prepare request payload
*
* @return the list of registered programs, or an empty {@link List} in case of no programs found
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public List<Program> getModulePrograms(String plantId, String moduleId) throws SmartherGatewayException {
try {
*
* @return the list of registered subscriptions, or an empty {@link List} in case of no subscriptions found
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public List<Subscription> getSubscriptions() throws SmartherGatewayException {
try {
*
* @return the identifier this subscription has been registered under
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public String subscribePlant(String plantId, String notificationUrl) throws SmartherGatewayException {
try {
*
* @return {@code true} if the plant is successfully unsubscribed, {@code false} otherwise
*
- * @throws {@link SmartherGatewayException}
- * in case of communication issues with the API gateway
+ * @throws SmartherGatewayException in case of communication issues with the API gateway
*/
public boolean unsubscribePlant(String plantId, String subscriptionId) throws SmartherGatewayException {
final ContentResponse response = requestBasic(DELETE, String.format(PATH_UNSUBSCRIBE, plantId, subscriptionId));
*
* @return the raw response returned by the API gateway
*
- * @throws {@link SmartherGatewayException}
- * if the call failed due to an issue with the API gateway
+ * @throws SmartherGatewayException if the call failed due to an issue with the API gateway
*/
public ContentResponse request(Function<HttpClient, Request> requester, String subscription, String authorization)
throws SmartherGatewayException {
*
* @return a {@link MeasureUnit} object representing the module operational temperature format
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the measure internal raw unit cannot be mapped to any valid measure unit
+ * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid
+ * measure unit
*/
public MeasureUnit getTemperatureFormatUnit() throws SmartherIllegalPropertyValueException {
return MeasureUnit.fromValue(temperatureFormat);
*
* @return {@code true} if the load state is active, {@code false} otherwise
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the load state internal raw value cannot be mapped to any valid load state enum value
+ * @throws SmartherIllegalPropertyValueException if the load state internal raw value cannot be mapped to any valid
+ * load state enum value
*/
public boolean isActive() throws SmartherIllegalPropertyValueException {
return LoadState.fromValue(loadState).isActive();
*
* @return the enum value representing the given raw value
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the raw value cannot be mapped to any valid enum value
+ * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
*/
public static Function fromValue(String value) throws SmartherIllegalPropertyValueException {
return lookup(Function.class, value);
*
* @return the enum value representing the given raw value
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the raw value cannot be mapped to any valid enum value
+ * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
*/
public static Mode fromValue(String value) throws SmartherIllegalPropertyValueException {
return lookup(Mode.class, value);
*
* @return the enum value representing the given raw value
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the raw value cannot be mapped to any valid enum value
+ * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
*/
public static LoadState fromValue(String value) throws SmartherIllegalPropertyValueException {
return lookup(LoadState.class, value);
*
* @return the enum value representing the given raw value
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the raw value cannot be mapped to any valid enum value
+ * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
*/
public static MeasureUnit fromValue(String value) throws SmartherIllegalPropertyValueException {
return lookup(MeasureUnit.class, value);
*
* @return the enum value representing the given raw value
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the raw value cannot be mapped to any valid enum value
+ * @throws SmartherIllegalPropertyValueException if the raw value cannot be mapped to any valid enum value
*/
public static BoostTime fromValue(int value) throws SmartherIllegalPropertyValueException {
return lookup(BoostTime.class, value);
*
* @return a {@link MeasureUnit} object representing the measure unit
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the measure internal raw unit cannot be mapped to any valid measure unit
+ * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid
+ * measure unit
*/
public MeasureUnit getMeasureUnit() throws SmartherIllegalPropertyValueException {
return MeasureUnit.fromValue(unit);
*
* @return the value and measure unit
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the measure internal raw unit cannot be mapped to any valid measure unit
+ * @throws SmartherIllegalPropertyValueException if the measure internal raw unit cannot be mapped to any valid
+ * measure unit
*/
public State toState() throws SmartherIllegalPropertyValueException {
State state = UnDefType.UNDEF;
*
* @return a {@link State} object representing the overall state of the sensor
*
- * @throws {@link SmartherIllegalPropertyValueException}
- * if the sensor internal raw state cannot be mapped to any valid value
+ * @throws SmartherIllegalPropertyValueException if the sensor internal raw state cannot be mapped to any valid
+ * value
*/
public State toState() throws SmartherIllegalPropertyValueException {
final Measure measure = getMeasure(0);
*
* @param message
* the error message returned from the API gateway
- * @param cause
+ * @param exception
* the cause (a null value is permitted, and indicates that the cause is nonexistent or unknown)
*/
public SmartherNotificationException(String message, Throwable exception) {
*
* @return a {@link LocalDate} object containing the parsed date
*
- * @throws {@link DateTimeParseException}
- * if the string cannot be parsed to a local date
+ * @throws DateTimeParseException if the string cannot be parsed to a local date
*/
public static LocalDate parseDate(@Nullable String str, String pattern) {
if (str == null) {
*
* @return a {@link LocalDateTime} object containing the parsed date and time
*
- * @throws {@link DateTimeParseException}
- * if the string cannot be parsed to a local date and time
+ * @throws DateTimeParseException if the string cannot be parsed to a local date and time
*/
public static LocalDateTime parseLocalTime(@Nullable String str, String pattern) {
if (str == null) {
*
* @return a {@link ZonedDateTime} object containing the parsed date and time with timezone
*
- * @throws {@link DateTimeParseException}
- * if the string cannot be parsed to a date and time with timezone
+ * @throws DateTimeParseException if the string cannot be parsed to a date and time with timezone
*/
public static ZonedDateTime parseZonedTime(@Nullable String str, String pattern) {
if (str == null) {
*
* @return a string representing the local date and time object
*
- * @throws {@link DateTimeException}
- * if an error occurs during printing
+ * @throws DateTimeException if an error occurs during printing
*/
public static String format(LocalDateTime date, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
*
* @return a string representing the date and time with timezone object
*
- * @throws {@link DateTimeException}
- * if an error occurs during printing
+ * @throws DateTimeException if an error occurs during printing
*/
public static String format(ZonedDateTime date, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
*
* @return a string representing the range between the two local date and time objects
*
- * @throws {@link DateTimeException}
- * if an error occurs during printing
+ * @throws DateTimeException if an error occurs during printing
*/
public static String formatRange(LocalDateTime date1, LocalDateTime date2, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
*
* @return a string representing the range between the two date and time with timezone objects
*
- * @throws {@link DateTimeException}
- * if an error occurs during printing
+ * @throws DateTimeException if an error occurs during printing
*/
public static String formatRange(ZonedDateTime date1, ZonedDateTime date2, String pattern) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern(pattern);
*
* @return the string read from stream
*
- * @throws {@link IOException}
- * if an I/O error occurs
+ * @throws IOException if an I/O error occurs
*/
public static String streamToString(InputStream input) throws IOException {
InputStreamReader reader = new InputStreamReader(input);
*
* @return the string read from stream
*
- * @throws {@link IOException}
- * if an I/O error occurs
+ * @throws IOException if an I/O error occurs
*/
public static String readerToString(Reader reader) throws IOException {
final StringWriter writer = new StringWriter();
/**
* Event handler to receive the data from the serial port
*
- * @param SerialPortEvent serialPortEvent The event that occurred on the serial port
+ * @param serialPortEvent The event that occurred on the serial port
*/
@Override
public void serialEvent(@Nullable SerialPortEvent serialPortEvent) {
* Method to Update a Channel
*
* @param channel
- * @param state
- * @param description
+ * @param data
*/
public abstract void updateChannel(ChannelUID channel, String data);
/**
* Receives Events from the bridge.
*
- * @param event.
+ * @param event
* @param thing
*/
public abstract void caddxEventReceived(CaddxEvent event, Thing thing);
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link CBusBinding} class defines common constants, which are
+ * The {@link CBusBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Scott Linton - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link CM11ABinding} class defines common constants, which are
+ * The {@link CM11ABindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Bob Raker - Initial contribution
*
* @param key
* command key
- * @param value
+ * @param command
* new state
* @return initialized ComfoAirCommand
*/
/**
* Open serial port.
*
- * @throws PortInUseException, UnsupportedCommOperationException, IOException
+ * @throws ComfoAirSerialException
*/
public void open() throws ComfoAirSerialException {
logger.debug("open(): Opening ComfoAir connection");
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link ConnectException} is thrown on errors relating the serial connection.
+ * The {@link ComfoAirSerialException} is thrown on errors relating the serial connection.
*
* @author Hans Böhm - Initial contribution
*/
* This method automatically acquires a connection.
*
* @return the server response to the command (never empty)
- * @throws {@link IOException} if communications failed with the server
+ * @throws IOException if communications failed with the server
*/
public String sendCommand(final String command) throws IOException {
synchronized (socketLock) {
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * Configuration for the {@link CoronaStatsCountryHandler}
+ * Configuration for the
+ * {@link org.openhab.binding.coronastats.internal.handler.CoronaStatsCountryHandler}
*
* @author Johannes Ott - Initial contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * Configuration for the {@link CoronaStatsWorldHandler}
+ * Configuration for the
+ * {@link org.openhab.binding.coronastats.internal.handler.CoronaStatsWorldHandler}
*
* @author Johannes Ott - Initial contribution
*/
logger.warn("Error querying device status: {}", e.getMessage());
return null;
});
-
} else if (CHANNEL_COLOR.equals(channelUID.getId())) {
DaliAddress address;
if (THING_TYPE_DEVICE_DT8.equals(this.thing.getThingTypeUID())) {
logger.warn("Error querying device status: {}", e.getMessage());
return null;
});
-
} else {
super.handleCommand(channelUID, command);
}
public CompletableFuture<QueryResult> executeQuery(Query query) {
try {
if (query instanceof Influx2QueryFactory.Influx2Query influxQuery) {
-
CompletableFuture<QueryResult> asyncResult = new CompletableFuture<>();
List<FluxRecord> records = new ArrayList<>();
client.query(influxQuery.getQuery(), (cancellable, record) -> { // onNext
import org.openhab.core.thing.type.ChannelTypeUID;
/**
- * The {@link DenonMarantzBinding} class defines common constants, which are
+ * The {@link DenonMarantzBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Jan-Willem Veldhuis - Initial contribution
*
* chapter "1.2.7 TripLabel" in Technical Interface Description for external Developers
*
- * @see
@see <a href="https://developers.deutschebahn.com/db-api-marketplace/apis/product/timetables">DB API
+ * @see
See <a href="https://developers.deutschebahn.com/db-api-marketplace/apis/product/timetables">DB API
* Marketplace</a>
*
* @author Sönke Küper - Initial contribution.
/**
* The {@link BridgeMDNSDiscoveryParticipant} is responsible for discovering digitalSTROM-Server. It uses the central
- * {@link MDNSDiscoveryService}.
+ * {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
* The {@link DeviceDiscoveryService} discovers all digitalSTROM-Devices, of one supported device-color-type. The
* device-color-type has to be given to the {@link #DeviceDiscoveryService(BridgeHandler, ThingTypeUID)} as
* {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at
- * {@link DeviceHandler#SUPPORTED_THING_TYPES}.
+ * {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler#SUPPORTED_THING_TYPES}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
}
/**
- * Removes the {@link Thing} of the given {@link Device}.
+ * Removes the {@link org.openhab.core.thing.Thing} of the given
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}.
*
* @param device (must not be null)
*/
/**
* Creates a {@link DiscoveryResult} for the given {@link Device}, if the {@link Device} is supported and the
- * {@link Device#getOutputMode()} is unequal {@link OutputModeEnum#DISABLED}.
+ * {@link Device#getOutputMode()} is unequal
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#DISABLED}.
*
* @param device (must not be null)
*/
/**
* Creates a new {@link DiscoveryServiceManager} and generates automatically all {@link SceneDiscoveryService}s and
- * {@link DeviceDiscoveryService}s for all supported {@link ThingType}s of the {@link DeviceHandler} and
- * {@link SceneHandler}.
+ * {@link org.openhab.binding.digitalstrom.internal.discovery.DeviceDiscoveryService}s for all supported
+ * {@link org.openhab.core.thing.type.ThingType}s of the
+ * {@link org.openhab.binding.digitalstrom.internal.handler.DeviceHandler} and {@link SceneHandler}.
*
* @param bridgeHandler (must not be null)
*/
/**
* The {@link SceneDiscoveryService} discovers all digitalSTROM-scene of one supported scene-type. The scene-type has to
* be given to the {@link #SceneDiscoveryService(BridgeHandler, ThingTypeUID)} as
- * {@link ThingTypeUID}. The supported {@link ThingTypeUID} can be found at {@link SceneHandler#SUPPORTED_THING_TYPES}
+ * {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID}
+ * can be found at {@link org.openhab.binding.digitalstrom.internal.handler.SceneHandler#SUPPORTED_THING_TYPES}
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
/**
* The {@link ZoneTemperatureControlDiscoveryService} discovers all digitalSTROM zones which have temperature control
* configured. The thing-type has to be given to the
- * {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as {@link ThingTypeUID}. The supported
- * {@link ThingTypeUID} can be found at {@link ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES}
+ * {@link #ZoneTemperatureControlDiscoveryService(BridgeHandler, ThingTypeUID)} as
+ * {@link org.openhab.core.thing.ThingTypeUID}. The supported {@link org.openhab.core.thing.ThingTypeUID}
+ * can be found at
+ * {@link org.openhab.binding.digitalstrom.internal.handler.ZoneTemperatureControlHandler#SUPPORTED_THING_TYPES}
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
/**
* The {@link SensorValues} acts as container for the digitalSTROM json-method <i>getSensorValues</i>. So the
- * {@link SensorValues} contains all {@link CachedSensorValue}s of a zone.
+ * {@link SensorValues} contains all
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s of a zone.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
}
/**
- * Returns the refenceZone, if control-mode is {@link ControlModes#ZONE_FOLLOWER}, otherwise null.
+ * Returns the refenceZone, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#ZONE_FOLLOWER}, otherwise
+ * null.
*
* @return the referenceZone
*/
}
/**
- * Returns the ctrlOffset, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlOffset, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlOffset
*/
}
/**
- * Returns the manualValue, if control-mode is {@link ControlModes#MANUAL}, otherwise null.
+ * Returns the manualValue, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#MANUAL}, otherwise null.
*
* @return the manualValue
*/
}
/**
- * Returns the emergencyValue, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the emergencyValue, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the emergencyValue
*/
}
/**
- * Returns the ctrlKp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlKp, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlKp
*/
}
/**
- * Returns the ctrlTs, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlTs, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlTs
*/
}
/**
- * Returns the ctrlTi, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlTi, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlTi
*/
}
/**
- * Returns the ctrlKd, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlKd, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlKd
*/
}
/**
- * Returns the ctrlImin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlImin, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlImin
*/
}
/**
- * Returns the ctrlImax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlImax, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlImax
*/
}
/**
- * Returns the ctrlYmin, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlYmin, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlYmin
*/
}
/**
- * Returns the ctrlYmax, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlYmax, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlYmax
*/
}
/**
- * Returns the ctrlAntiWindUp, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlAntiWindUp, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlAntiWindUp
*/
}
/**
- * Returns the ctrlKeepFloorWarm, if control-mode is {@link ControlModes#PID_CONTROL}, otherwise null.
+ * Returns the ctrlKeepFloorWarm, if control-mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}, otherwise null.
*
* @return the ctrlKeepFloorWarm
*/
}
/**
- * @see TemperatureControlStatus#getControlDSUID()
+ * @see org.openhab.binding.digitalstrom.internal.lib.climate.jsonresponsecontainer.impl.TemperatureControlStatus#getControlDSUID()
* @return the controlDSUID
*/
public String getControlDSUID() {
}
/**
- * @see TemperatureControlStatus#getIsConfigured()
+ * @see org.openhab.binding.digitalstrom.internal.lib.serverconnection.constants.JSONApiResponseKeysEnum#IS_CONFIGURED
* @return the isConfigured
*/
public Boolean getIsConfigured() {
/**
* The {@link WeatherSensorData} acts as container for the digitalSTROM json-method <i>getSensorValues</i>. The
- * {@link WeatherSensorData} contains all {@link CachedSensorValue}s and weather service information of the
- * digitalSTROM-server, if a weather service is set.
+ * {@link WeatherSensorData} contains all
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.datatypes.CachedSensorValue}s and weather service
+ * information of the digitalSTROM-server, if a weather service is set.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
*/
public static final String DEFAULT_APPLICATION_NAME = "openHAB";
/**
- * Defines the used tread pool name to get a thread pool from {@link ThreadPoolManager}.
+ * Defines the used tread pool name to get a thread pool from {@link org.openhab.core.common.ThreadPoolManager}.
*/
public static final String THREADPOOL_NAME = "digitalSTROM";
private int totalPowerUpdateInterval = DEFAULT_TOTAL_POWER_UPDATE_INTERVAL;
/**
- * Default time to wait between another {@link SensorJob} can be executed on a circuit.
+ * Default time to wait between another
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
+ * can be executed on a circuit.
*/
public static final int DEFAULT_SENSOR_READING_WAIT_TIME = 60000;
private int sensorReadingWaitTime = DEFAULT_SENSOR_READING_WAIT_TIME;
// max sensor reading cyclic to wait
/**
- * The default factor to prioritize medium {@link SensorJob}s down.
+ * The default factor to prioritize medium
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s down.
*/
public static final long DEFAULT_MEDIUM_PRIORITY_FACTOR = 5;
/**
- * The default factor to prioritize low {@link SensorJob}s down.
+ * The default factor to prioritize low
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s down.
*/
public static final long DEFAULT_LOW_PRIORITY_FACTOR = 10;
private long lowPriorityFactor = DEFAULT_LOW_PRIORITY_FACTOR;
/**
- * Defines the event polling interval of the {@link EventListener} in milliseconds.
+ * Defines the event polling interval of the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener} in milliseconds.
*/
private int eventListenerRefreshinterval = DEFAULT_POLLING_FREQUENCY;
/**
- * The default max standby active power for a device. It's needed to set a {@link Device} with output mode
- * {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode.
+ * The default max standby active power for a device. It's needed to set a
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE}
+ * on if it isen't any more in standby mode.
*/
public static final int DEFAULT_STANDBY_ACTIVE_POWER = 2;
}
/**
- * Sets the SSL-Certificate of the server, will be set automatically by the {@link HttpTransportImpl} if no
+ * Sets the SSL-Certificate of the server, will be set automatically by the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.impl.HttpTransportImpl} if no
* SSL-Certification path is set.
*
* @param cert of the digitalSTROM-Server to set
}
/**
- * Returns the time in milliseconds to wait between another {@link SensorJob} can be executed on a circuit.
+ * Returns the time in milliseconds to wait between another
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
+ * can be executed on a circuit.
*
* @return the sensor reading wait time in milliseconds
*/
}
/**
- * Sets the time in milliseconds to wait between another {@link SensorJob} can be executed on a circuit.
+ * Sets the time in milliseconds to wait between another
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
+ * can be executed on a circuit.
*
* @param sensorReadingWaitTime in milliseconds
*/
}
/**
- * Returns the factor to prioritize medium {@link SensorJob}s in the {@link SensorJobExecutor} down.
+ * Returns the factor to prioritize medium
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s
+ * in the {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down.
*
* @return the medium priority factor
*/
}
/**
- * Sets the factor to prioritize medium {@link SensorJob}s in the {@link SensorJobExecutor} down.
+ * Sets the factor to prioritize medium
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down.
*
* @param mediumPriorityFactor to set
*/
}
/**
- * Returns the factor to prioritize low {@link SensorJob}s in the {@link SensorJobExecutor} down.
+ * Returns the factor to prioritize low
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} down.
*
* @return the low priority factor
*/
}
/**
- * Sets the factor to prioritize low {@link SensorJob}s in the {@link SensorJobExecutor}down.
+ * Sets the factor to prioritize low
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}s in the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}down.
*
* @param lowPriorityFactor to set
*/
}
/**
- * Returns the polling interval in milliseconds to poll the {@link Event}s in the {@link EventListener}.
+ * Returns the polling interval in milliseconds to poll the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}s in the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*
* @return the EventListener refresh interval in milliseconds
*/
}
/**
- * Sets the polling interval in milliseconds to poll the {@link Event}s in the {@link EventListener}.
+ * Sets the polling interval in milliseconds to poll the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}s in the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*
* @param eventListenerRefreshinterval to set
*/
}
/**
- * Returns the max standby active power for a device. It's needed to set a {@link Device} with output mode
- * {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode.
+ * Returns the max standby active power for a device. It's needed to set a
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE}
+ * on if it isen't any more in standby mode.
*
* @return the standby active power
*/
}
/**
- * Sets the max standby active power for a device. It's needed to set a {@link Device} with output mode
- * {@link OutputModeEnum#WIPE} on if it isen't any more in standby mode.
+ * Sets the max standby active power for a device. It's needed to set a
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with output mode
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.OutputModeEnum#WIPE}
+ * on if it isen't any more in standby mode.
*
* @param standbyActivePower to set
*/
/**
* The {@link EventHandler} can be implemented to get informed by {@link EventItem}'s through the {@link EventListener}.
* <br>
- * For that the {@link #getSupportetEvents()} and {@link #supportsEvent(String)} methods have to be implemented, so that
+ * For that the {@link #getSupportedEvents()} and
+ * {@link #supportsEvent(String)} methods have to be implemented, so that
* the {@link EventListener} knows whitch events it has to subscribe at the digitalSTROM-server and which handler has
* to be informed. <br>
* The implementation of the {@link EventHandler} also has to be registered through
* {@link EventHandler} needs to be informed of another event-type, you can use the methods
* {@link #addSubscribe(String)} or {@link #addSubscribeEvents(List)} to add more than one event-type. To remove a
* subscribed event you can use the method {@link #removeSubscribe(String, String)}, you also have to change the return
- * of the {@link EventHandler} methods {@link EventHandler#getSupportetEvents()} and
+ * of the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventHandler} methods
+ * {@link EventHandler#getSupportedEvents()} and
* {@link EventHandler#supportsEvent(String)}.
* <br>
* To start and stop the listening you have to call the methods {@link #start()} and {@link #stop()}.
String getName();
/**
- * Returns {@link HashMap} with the properties fiels of this {@link EventItem}.
+ * Returns {@link java.util.HashMap} with the properties fiels of this {@link EventItem}.
* The key is an {@link EventResponseEnum} and represents the property name
* and the value is the property value.
*
Map<EventResponseEnum, String> getProperties();
/**
- * Returns {@link HashMap} with the source fields of this {@link EventItem}.
+ * Returns {@link java.util.HashMap} with the source fields of this {@link EventItem}.
* The key is an {@link EventResponseEnum} and represents the property name
* and the value is the property value.
*
import org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.ChangeableDeviceConfigEnum;
/**
- * The {@link DeviceStatusListener} is notified, if a {@link Device} status or configuration has changed, if a scene
- * configuration is added to a {@link Device} or if a device has been added or removed. The {@link DeviceStatusListener}
- * can be also registered by a {@link Circuit} to get informed by configuration or status changes.
+ * The {@link DeviceStatusListener} is notified, if a
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} status or configuration has changed,
+ * if a scene configuration is added to a {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
+ * or if a device has been added or removed. The {@link DeviceStatusListener}
+ * can be also registered by a {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Circuit}
+ * to get informed by configuration or status changes.
* <p>
* By implementation with the id {@link #DEVICE_DISCOVERY} this listener can be used as a device discovery to get
- * informed, if a new {@link Device} or {@link Circuit} is added or removed from the digitalSTROM-System.<br>
+ * informed, if a new {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} or
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Circuit} is added or removed from the
+ * digitalSTROM-System.<br>
* For that the {@link DeviceStatusListener} has to be registered on the
- * {@link DeviceStatusManager#registerDeviceListener(DeviceStatusListener)}. Then the {@link DeviceStatusListener} gets
- * informed by the methods {@link #onDeviceAdded(Object)} and {@link #onDeviceRemoved(Object)}.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.manager.DeviceStatusManager#registerDeviceListener(DeviceStatusListener)}.
+ * Then the {@link DeviceStatusListener} gets informed by the methods {@link #onDeviceAdded(GeneralDeviceInformation)}
+ * and {@link #onDeviceRemoved(GeneralDeviceInformation)}.
* </p>
*
* @author Michael Ochel - Initial contribution
static final String DEVICE_DISCOVERY = "DeviceDiscovery";
/**
- * This method is called whenever the state of the {@link Device} has changed and passes the new device state as an
- * {@link DeviceStateUpdate} object.
+ * This method is called whenever the state of the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} has changed and passes the new
+ * device state as an {@link DeviceStateUpdate} object.
*
* @param deviceStateUpdate new device status
*/
* By implementation with the id {@link #SCENE_DISCOVERY} this listener can be used as a scene discovery to get
* informed, if a new {@link InternalScene}s is added or removed from the digitalSTROM-System.<br>
* For that the {@link SceneStatusListener} has to be registered on the
- * {@link SceneManager#registerSceneListener(SceneStatusListener)}. Then the {@link SceneStatusListener} gets
- * informed by the methods {@link #onSceneAdded(InternalScene)} and {@link #onSceneRemoved(InternalScene)}.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.manager.SceneManager#registerSceneListener(SceneStatusListener)}.
+ * Then the {@link SceneStatusListener} gets informed by the methods {@link #onSceneAdded(InternalScene)} and
+ * {@link #onSceneRemoved(InternalScene)}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
/**
* The {@link SystemStateChangeListener} can be implemented to get informed by digitalSTROM system state changes. It
- * has to be registered by supported classes, e.g. the {@link TemperatureControlManager} or self implemented classes.
+ * has to be registered by supported classes, e.g. the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.manager.impl.TemperatureControlManager}
+ * or self implemented classes.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
* The {@link DeviceStatusManager} is responsible for the synchronization between the internal model of the
* digitalSTROM-devices and the real existing digitalSTROM-devices. You can change the state of a device by sending a
* direct command to the devices or by calling a scene. Furthermore the {@link DeviceStatusManager} get informed over
- * the {@link SceneManager} by the {@link EventListener} if scenes are called by external sources. All
+ * the {@link SceneManager} by the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}
+ * if scenes are called by external sources. All
* configurations of the physically device will be synchronized to the internally managed model and updated as required.
- * The {@link DeviceStatusManager} also initializes {@link SensorJob}'s with the {@link SensorJobExecutor} and
- * {@link SceneReadingJobExecutor} to update required sensor and scene data.
+ * The {@link DeviceStatusManager} also initializes {@link SensorJob}'s with the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} to update required
+ * sensor and scene data.
*
* <p>
* Therefore the {@link DeviceStatusManager} uses the {@link StructureManager} for the internal management of the
public interface DeviceStatusManager extends EventHandler {
/**
- * Starts the working process for device synchronization. It also starts the {@link SensorJobExecutor} and the
- * {@link SceneReadingJobExecutor} and the {@link SceneManager}.
+ * Starts the working process for device synchronization. It also starts the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor}
+ * and the {@link SceneManager}.
*/
void start();
/**
- * Stops the working process for device synchronization. It also stops the {@link SensorJobExecutor} and the
- * {@link SceneReadingJobExecutor} and the {@link SceneManager}.
+ * Stops the working process for device synchronization. It also stops the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor} and the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} and the
+ * {@link SceneManager}.
*/
void stop();
void updateSensorData(SensorJob sensorJob, String priority);
/**
- * This method adds a {@link SensorJob} with the appropriate priority to the {@link SceneReadingJobExecutor}.
+ * This method adds a {@link SensorJob} with the appropriate priority to the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor}.
*
* @param device device which will update scene data
* @param deviceStateUpdate scene data to update
* , {@link #callDeviceScene(String, Short)} etc. can be used.
*
* <p>
- * If you call the {@link #start()} method an {@link EventListener} will be started to handle scene calls and undos from
- * the outside.
+ * If you call the {@link #start()} method an {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}
+ * will be started to handle scene calls and undos from the outside.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
void addInternalScene(InternalScene intScene);
/**
- * Adds the scene call with the given dSID and sceneId as an echo to ignore them by detecting the {@link EventItem}.
+ * Adds the scene call with the given dSID and sceneId as an echo to ignore them by detecting the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}.
*
* @param dSID of the {@link Device} that will be ignored
* @param sceneId of the scene that will be ignored
void addEcho(String dSID, short sceneId);
/**
- * Adds the scene call with the given internal scene id as an echo to ignore them by detecting the {@link EventItem}
+ * Adds the scene call with the given internal scene id as an echo to ignore them by detecting the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem}
* .
*
* @param internalSceneID to ignore
void generateScenes();
/**
- * Will be called from the {@link SceneDiscovery}, if a scene type is generated or is fail.<br>
+ * Will be called from the {@link org.openhab.binding.digitalstrom.internal.lib.structure.scene.SceneDiscovery},
+ * if a scene type is generated or is fail.<br>
* For that the scenesGenerated char array has four chars. Each char represents one scene type in the following
* direction:
* <ul>
boolean isDiscoveryRegistrated();
/**
- * Starts the {@link EventListener}.
+ * Starts the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*/
void start();
/**
- * Stops the {@link EventListener}.
+ * Stops the {@link org.openhab.binding.digitalstrom.internal.lib.event.EventListener}.
*/
void stop();
}
/**
- * Query to get all zone and group names. Can be executed with {@link DsAPI#query(String, String)} or
- * {@link DsAPI#query2(String, String)}.
+ * Query to get all zone and group names. Can be executed with
+ * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#query(String, String)} or
+ * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#query2(String, String)}.
*/
public static final String ZONE_GROUP_NAMES = "/apartment/zones/*(ZoneID,name)/groups/*(group,name)";
}
/**
- * Removes all {@link SensorJob} of a specific {@link Device} with the given {@link DSID}.
+ * Removes all {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
+ * of a specific {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device} with the
+ * given {@link DSID}.
*
* @param dSID of the device
*/
/**
* The {@link SceneReadingJobExecutor} is the implementation of the {@link AbstractSensorJobExecutor} to execute
- * digitalSTROM-Device scene configuration {@link SensorJob}'s e.g. {@link SceneConfigReadingJob} and
- * {@link SceneOutputValueReadingJob}.
+ * digitalSTROM-Device scene configuration {@link SensorJob}'s e.g.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.SceneConfigReadingJob} and
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.SceneOutputValueReadingJob}.
* <p>
* In addition priorities can be assigned to jobs therefore the {@link SceneReadingJobExecutor} offers the methods
* {@link #addHighPriorityJob(SensorJob)}, {@link #addMediumPriorityJob(SensorJob)} and
/**
* The {@link SensorJobExecutor} is the implementation of the {@link AbstractSensorJobExecutor} to execute
- * digitalSTROM-Device {@link SensorJob}'s e.g. {@link DeviceConsumptionSensorJob} and
- * {@link DeviceOutputValueSensorJob}.
+ * digitalSTROM-Device {@link SensorJob}'s e.g.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceConsumptionSensorJob} and
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceOutputValueSensorJob}.
* <p>
* In addition priorities can be assigned to jobs, but the following list shows the maximum evaluation of a
* {@link SensorJob} per priority.
* </p>
* <ul>
- * <li>low priority: read cycles before execution is set in {@link Config}</li>
- * <li>medium priority: read cycles before execution is set in {@link Config}</li>
+ * <li>low priority: read cycles before execution is set in
+ * {@link org.openhab.binding.digitalstrom.internal.lib.config.Config}</li>
+ * <li>medium priority: read cycles before execution is set in
+ * {@link org.openhab.binding.digitalstrom.internal.lib.config.Config}</li>
* <li>high priority: read cycles before execution 0</li>
* </ul>
*
/**
* The {@link SensorJob} represents an executable job to read out digitalSTROM-Sensors or device configurations like
* scene values.<br>
- * It can be added to an implementation of the {@link AbstractSensorJobExecutor} e.g. {@link SceneReadingJobExecutor} or
- * {@link SensorJobExecutor}.
+ * It can be added to an implementation of the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.AbstractSensorJobExecutor} e.g.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SceneReadingJobExecutor} or
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
public interface SensorJob {
/**
- * Returns the dSID of the {@link Device} for which this job is to be created.
+ * Returns the dSID of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
+ * for which this job is to be created.
*
* @return dSID from the device
*/
boolean setZoneTemperatureControlState(String sessionToken, Integer zoneID, String zoneName, String controlState);
/**
- * Sets the wished temperature (control mode = {@link ControlModes#PID_CONTROL}) or control valve value for a
- * operation mode, see
- * {@link OperationModes}.<br>
+ * Sets the wished temperature (control mode =
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL}) or control
+ * valve value for a
+ * operation mode, see {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.OperationModes}.<br>
* To set the values a {@link List} with an object array has to be set as controlVlaues parameter. The 1th field has
- * to be a {@link String} for the {@link OperationModes} name and the 2nd field has to be an {@link Integer} for the
- * new value. If the control mode is {@link ControlModes#PID_CONTROL} it is the nominal temperature, otherwise it is
+ * to be a {@link String} for the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.OperationModes}
+ * name and the 2nd field has to be an {@link Integer} for the
+ * new value. If the control mode is
+ * {@link org.openhab.binding.digitalstrom.internal.lib.climate.constants.ControlModes#PID_CONTROL} it is the
+ * nominal temperature, otherwise it is
* the control valve value.
*
* @param sessionToken can be null, if a
* </p>
* <p>
* If a {@link ConnectionManager} is given at the constructor, the session-token is not needed by requests and the
- * {@link ConnectionListener}, which is registered at the {@link ConnectionManager}, will be automatically informed
- * about
+ * {@link org.openhab.binding.digitalstrom.internal.lib.listener.ConnectionListener}, which is registered at the
+ * {@link ConnectionManager}, will be automatically informed about
* connection state changes through the {@link #execute(String, int, int)} method.
* </p>
*
*
* @param interfaceKey must not be null
* @return simpleRequestBuilder with chosen interface
- * @throws NullArgumentException if the interfaceKey is null
*/
public static SimpleRequestBuilder buildNewRequest(String interfaceKey) throws IllegalArgumentException {
if (builder == null) {
* @param requestClassKey must not be null
* @return simpleRequestBuilder with chosen requestClass
* @throws IllegalArgumentException if a requestClass is already chosen
- * @throws NullArgumentException if the requestClassKey is null
*/
public static SimpleRequestBuilder buildNewJsonRequest(String requestClassKey) throws IllegalArgumentException {
return buildNewRequest(InterfaceKeys.JSON).addRequestClass(requestClassKey);
* @param requestClassKey must not be null
* @return simpleRequestBuilder with chosen requestClass
* @throws IllegalArgumentException if a requestClass is already chosen
- * @throws NullArgumentException if the requestClassKey is null
*/
public SimpleRequestBuilder addRequestClass(String requestClassKey) throws IllegalArgumentException {
return builder.addRequestClassInt(requestClassKey);
* @param functionKey must not be null
* @return SimpleRequestBuilder with chosen function
* @throws IllegalArgumentException if a function is already chosen
- * @throws NullArgumentException if the functionKey is null
*/
public SimpleRequestBuilder addFunction(String functionKey) throws IllegalArgumentException {
return builder.addFunctionInt(functionKey);
* @param parameterValue can be null
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
- * @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addParameter(String parameterKey, String parameterValue)
throws IllegalArgumentException {
* @param zoneName
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
- * @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultZoneParameter(String sessionToken, Integer zoneID, String zoneName)
throws IllegalArgumentException {
* @param groupName
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
- * @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultGroupParameter(String sessionToken, Short groupID, String groupName)
throws IllegalArgumentException {
* @param groupName
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
- * @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultZoneGroupParameter(String sessionToken, Integer zoneID, String zoneName,
Short groupID, String groupName) throws IllegalArgumentException {
* @param name
* @return SimpleRequestBuilder with added parameter
* @throws IllegalArgumentException if no class and function added
- * @throws NullArgumentException if the parameterKey is null
*/
public SimpleRequestBuilder addDefaultDeviceParameter(String sessionToken, DSID dsid, String dSUID, String name)
throws IllegalArgumentException {
package org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.constants;
/**
- * The {@link ExeptionConstants} contains the {@link SimpleRequestBuilder} exception strings.
+ * The
+ * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.constants.ExeptionConstants}
+ * contains the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.simpledsrequestbuilder.SimpleRequestBuilder}
+ * exception strings.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
import com.google.gson.JsonObject;
/**
- * The {@link AbstractGeneralDeviceInformations} is an abstract implementation of {@link GeneralDeviceInformations} and
+ * The {@link AbstractGeneralDeviceInformations} is an abstract implementation of {@link GeneralDeviceInformation}s and
* can be implement by subclasses which contains the same device informations like dSID and/or mechanismen like the
* {@link DeviceStatusListener}.
*
/**
* The {@link Circuit} represents a circuit of the digitalStrom system. For that all information will be able to get and
* set through the same named getter- and setter-methods. To get informed about status and configuration changes a
- * {@link DeviceStatusListener} can be registered. For that and to get the general device informations like the dSID the
- * {@link Circuit} implements the {@link GeneralDeviceInformations} interface.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.listener.DeviceStatusListener} can be registered. For that and
+ * to get the general device informations like the dSID the {@link Circuit} implements the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.GeneralDeviceInformation}s interface.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
/**
* Returns the current functional color group of this device.
- * For more informations please have a look at {@link FunctionalColorGroupEnum}.
+ * For more informations please have a look at {@link ApplicationGroup}.
*
* @return current functional color group
*/
/**
* Returns true, if this {@link Device} is a heating device. That means, that the output mode of this {@link Device}
* is one of the following modes {@link OutputModeEnum#PWM} or {@link OutputModeEnum#SWITCH} and the
- * {@link FuncNameAndColorGroupEnum} is {@link FuncNameAndColorGroupEnum#HEATING}.
+ * {@link ApplicationGroup} is {@link ApplicationGroup#HEATING}.
*
* @return true, if it is a heating device
*/
boolean hasPowerSensors();
/**
- * Only needed for {@link DeviceConsumptionSensorJob}'s. To set the internal digitalSTROM sensor value please use
+ * Only needed for
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.impl.DeviceConsumptionSensorJob}'s.
+ * To set the internal digitalSTROM sensor value please use
* {@link #setDsSensorValue(SensorEnum, Integer)}.
*
* @param sensorType of the sensor
void setDeviceSensorDsValueBySensorJob(SensorEnum sensorType, Integer value);
/**
- * Enables the internal sensor echo box for {@link EventNames#DEVICE_SENSOR_VALUE} events.
+ * Enables the internal sensor echo box for
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} events.
*/
void enableSensorEchoBox();
/**
- * Disables the internal sensor echo box for {@link EventNames#DEVICE_SENSOR_VALUE} events.
+ * Disables the internal sensor echo box for
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} events.
*/
void disableSensorEchoBox();
boolean isSensorEchoBoxEnabled();
/**
- * Sets the {@link DeviceSensorValue} through an {@link EventItem} of the type
- * {@link EventNames#DEVICE_SENSOR_VALUE}.
+ * Sets the {@link DeviceSensorValue} through an
+ * {@link EventItem} of the type
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE}.
*
* @param event of the sensor update
*/
import org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.impl.DSID;
/**
- * The {@link GeneralDeviceInformations} interface contains all informations of digitalSTROM devices, which are
+ * The {@link GeneralDeviceInformation} interface contains all informations of digitalSTROM devices, which are
* identical for all device types. It also contains the methods to implement the mechanism of the
* {@link DeviceStatusListener}.
*
* <li>For SceneCall-type the value is between 0 and 127.</li>
* <li>For all SceneUndo-types the value is the new output value.</li>
* <li>For all SensorUpdate-types will read the sensor data directly, if the value is 0, otherwise a
- * {@link SensorJob} will be added to the {@link SensorJobExecutor}.</li>
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.sensorjob.SensorJob}
+ * will be added to the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.sensorjobexecutor.SensorJobExecutor}.</li>
* </ul>
*
* @return new state value
/**
* The {@link DeviceBinaryInput} contains all information of a device binary input, e.g. binary input type id (see
- * {@link DeviceBinarayInputEnum}, state and so on.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum},
+ * state and so on.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
private Short stateValue;
/**
- * Creates a new {@link DeviceBinarayInputEnum} through the {@link JsonObject} of the binary inputs at json response
- * from digitalSTROM JSON-API or property-tree. Will be automatically added to a {@link DeviceImpl}, if binary
+ * Creates a new
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum}
+ * through the {@link JsonObject} of the binary inputs at json response
+ * from digitalSTROM JSON-API or property-tree. Will be automatically added to a
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.impl.DeviceImpl}, if binary
* inputs exists.
*
* @param jsonObject must not be null
/**
* Returns the input type id of this {@link DeviceBinaryInput}. Available input types see
- * {@link DeviceBinarayInputEnum}.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.deviceparameters.constants.DeviceBinarayInputEnum}.
*
* @return the inputType
*/
/**
* The {@link DeviceSensorValue} contains all needed information of a device sensor, e.g. the sensor type, to detect
* which kind of sensor it is (see {@link SensorEnum}), the sensor index to read out sensor at the digitalSTROM device
- * by calling {@link DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)} and as well as of course the value
- * and
- * timestamp of the last sensor update.
+ * by calling
+ * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}
+ * and as well as of course the value and timestamp of the last sensor update.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
/**
* Creates a new {@link DeviceSensorValue} through the properties of a digitalSTROM
- * {@link EventNames#DEVICE_SENSOR_VALUE} event.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.event.constants.EventNames#DEVICE_SENSOR_VALUE} event.
*
* @param eventProperties must not be null
*/
/**
* Returns the sensor index to read the sensor value out though
- * {@link DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}.
+ * {@link org.openhab.binding.digitalstrom.internal.lib.serverconnection.DsAPI#getDeviceSensorValue(String, DSID, String, String, Short)}.
*
* @return the sensorIndex
*/
import com.google.gson.JsonObject;
/**
- * digitalSTROM JSON Parser class. Externalizes code from {@link DeviceImpl}
+ * digitalSTROM JSON Parser class. Externalizes code from
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.impl.DeviceImpl}
*
* @author Rouven Schürch - Initial contribution
*
/**
* The {@link DsChannelTypeProvider} implements the {@link ChannelTypeProvider}
- * generates all supported {@link Channel}'s for digitalSTROM.
+ * generates all supported {@link org.openhab.core.thing.Channel}'s for digitalSTROM.
*
* @author Michael Ochel - Initial contribution
* @author Matthias Siegele - Initial contribution
* channel type exists for the given {@link ApplicationGroup.Color} and
* {@link OutputModeEnum}.
*
- * @param functionalGroup of the {@link Device}
- * @param outputMode of the {@link Device}
+ * @param functionalGroup of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
+ * @param outputMode of the {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.Device}
* @return the output channel type id or null
*/
public static String getOutputChannelTypeID(ApplicationGroup.Color functionalGroup, OutputModeEnum outputMode,
}
/**
- * Returns the {@link ChannelGroupTypeUID} for the given {@link SensorEnum}.
+ * Returns the {@link ChannelTypeUID} for the given {@link SensorEnum}.
*
* @param sensorType (must not be null)
* @return the channel type uid
}
/**
- * Returns the {@link ChannelGroupTypeUID} for the given
+ * Returns the {@link ChannelTypeUID} for the given
* {@link DeviceBinarayInputEnum}.
*
* @param binaryInputType (must not be null)
/**
* The {@link DsDeviceThingTypeProvider} creates the {@link ThingType}'s for the subclasses of the
- * {@link GeneralDeviceInformations}. It also adds the {@link ThingTypeUID}'s to the related handlers. So only the
+ * {@link org.openhab.binding.digitalstrom.internal.lib.structure.devices.GeneralDeviceInformation}s.
+ * It also adds the {@link ThingTypeUID}'s to the related handlers. So only the
* {@link SupportedThingTypes} enum has to be adjusted, if new device types of digitalSTROM should be supported.
* Provided the new digitalSTROM devices uses the same mechanism like now.
*
import org.slf4j.LoggerFactory;
/**
- * The {@link EgateHandler} is responsible for handling commands, which are
+ * The {@link EGateHandler} is responsible for handling commands, which are
* sent to one of the channels.
*
* @author Frieso Aeschbacher - Initial contribution
private void startAutomaticRefresh() {
Runnable runnable = () -> {
try {
-
Socket localSocket = egateSocket;
if (localSocket == null) {
return;
private AudioInputStream pcmUlawInputStream;
public ConvertedInputStream(InputStream innerInputStream) throws UnsupportedAudioFileException, IOException {
-
pcmUlawInputStream = getULAWStream(new BufferedInputStream(innerInputStream));
}
*/
private AudioInputStream getULAWStream(InputStream originalInputStream)
throws UnsupportedAudioFileException, IOException {
-
try {
AudioInputStream audioInputStream = AudioSystem.getAudioInputStream(originalInputStream);
AudioFormat format = audioInputStream.getFormat();
import org.eclipse.jdt.annotation.Nullable;
/**
- * The {@link DoorbirdConfig} class contains fields mapping thing configuration parameters
+ * The {@link ControllerConfiguration} class contains fields mapping thing configuration parameters
* for the Doorbird A1081 Controller..
*
* @author Mark Hilbush - Initial contribution
import org.eclipse.jdt.annotation.Nullable;
/**
- * The {@link DoorbellConfig} class contains fields mapping thing configuration parameters
+ * The {@link DoorbellConfiguration} class contains fields mapping thing configuration parameters
* for doorbell thing types.
*
* @author Mark Hilbush - Initial contribution
.withRepresentationProperty(PROP_ADDRESS).withLabel("Heat Hub - " + service.getName())
.build();
}
-
}
}
return null;
/**
* Set Thing Handler refresh status.
*
- * @param deviceInitialized
+ * @param refreshed
*/
public void setThingHandlerInitialized(boolean refreshed) {
this.thingHandlerInitialized = refreshed;
/**
* Constructor.
- *
- * @param eventListener listener to send received errors or messages to
*/
public DSMRTelegramListener() {
parser = new P1TelegramParser(this);
/**
* Constructs a new {@link DSMRMeterDiscoveryService} attached to the give bridge handler.
- *
- * @param dsmrBridgeHandler The bridge handler this discovery service is attached to
*/
public DSMRMeterDiscoveryService() {
super();
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * Configuration for the {@link DWDPollenflugRegionHandler}
+ * Configuration for the {@link org.openhab.binding.dwdpollenflug.internal.handler.DWDPollenflugRegionHandler}
*
* @author Johannes Ott - Initial contribution
*/
import java.util.stream.Collectors;
/**
- * Cache of Warnings to update the {@link DwdUnwetterBindingConstants#CHANNEL_UPDATED} if a new warning is sent to a
- * channel.
+ * Cache of Warnings to update the
+ * {@link org.openhab.binding.dwdunwetter.internal.DwdUnwetterBindingConstants#CHANNEL_UPDATED}
+ * if a new warning is sent to a channel.
*
* @author Martin Koehler - Initial contribution
*/
/**
* the constructor
- *
- * @param config
*/
public AbstractWriteCommand(EaseeThingHandler handler, Channel channel, Command command,
RetryOnFailure retryOnFailure, ProcessFailureResponse processFailureResponse,
/**
* Constructor to set up interface
- *
- * @param config Bridge configuration
*/
public WebInterface(ScheduledExecutorService scheduler, EaseeBridgeHandler handler, HttpClient httpClient,
StatusHandler bridgeStatusHandler) {
}
if (iqRequest instanceof DeviceCommandIQ iq) {
-
try {
if (!iq.id.isEmpty()) {
CommandResponseHolder responseHolder = pendingCommands.remove(iq.id);
}
} catch (JsonSyntaxException | ElectroluxAirException e) {
logger.warn("Failed to refresh! {}", e.getMessage());
-
}
return false;
}
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link EleroTransmitterStickBinding} class defines common constants, which are
+ * The {@link EleroTransmitterStickBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Volker Bier - Initial contribution
"failed to logout: " + e.getMessage());
}
}
-
} catch (IOException e) {
logger.debug("energenie: failed to login to {} with ip {}", thing.getUID(), host, e);
updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
import org.openhab.binding.energidataservice.internal.api.dto.DatahubPricelistRecord;
/**
- * Parses results from {@link DatahubPricelistRecords} into map of hourly tariffs.
+ * Parses results from {@link org.openhab.binding.energidataservice.internal.api.dto.DatahubPricelistRecords}
+ * into map of hourly tariffs.
*
* @author Jacob Laursen - Initial contribution
*/
/**
* Determine {@link RetryStrategy} when expected spot price data is missing.
*
- * @param utcTime the time of daily data request in UTC time-zone
+ * @param localTime the time of daily data request
+ * @param zoneId time-zone
* @return retry strategy
*/
public static RetryStrategy whenExpectedSpotPriceDataMissing(LocalTime localTime, ZoneId zoneId) {
import org.openhab.core.thing.type.ChannelTypeUID;
/**
- * The {@link EnOceanBinding} class defines common constants, which are
+ * The {@link EnOceanBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Daniel Weber - Initial contribution
public static final String CHANNEL_EXHAUSTAIRFANAIRFLOWRATE = "exhaustAirFanAirFlowRate";
public static final String CHANNEL_SUPPLYFANSPEED = "supplyFanSpeed";
public static final String CHANNEL_EXHAUSTFANSPEED = "exhaustFanSpeed";
- public final static String CHANNEL_DAYNIGHTMODESTATE = "dayNightModeState";
+ public static final String CHANNEL_DAYNIGHTMODESTATE = "dayNightModeState";
public static final Map<String, EnOceanChannelDescription> CHANNELID2CHANNELDESCRIPTION = Map.ofEntries(
Map.entry(CHANNEL_GENERAL_SWITCHING,
* Ctor for an EnOceanChannelDescription
*
* @param channelTypeUID ChannelTypeUID of channel
- * @param acceptedItemType AcceptedItemType of channel like Switch, Dimmer or null if we accept everything
+ * @param itemType ItemType of channel like Switch, Dimmer or null if we accept everything
*/
public EnOceanChannelDescription(ChannelTypeUID channelTypeUID, String itemType) {
this(channelTypeUID, itemType, "", true, true);
* Ctor for an EnOceanChannelDescription with detailed information
*
* @param channelTypeUID ChannelTypeUID of channel
- * @param acceptedItemType ItemType of channel like Switch, Dimmer
+ * @param itemType ItemType of channel like Switch, Dimmer
* @param label of created channel
* @param isStateChannel otherwise created channel is a trigger channel
* @param autoCreate create channel during thing initialization, otherwise channel is created
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
-
if (CHANNEL_CO.equals(channelId)) {
return EEPHelper.calculateState(getUnscaledCOValue(), getScaledCOMin(), getScaledCOMax(),
getUnscaledCOMin(), getUnscaledCOMax(), Units.PARTS_PER_MILLION);
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
-
if (CHANNEL_VOC.equals(channelId)) {
double scaledVOC = getUnscaledVOCValue() * getScalingFactor();
return new QuantityType<>(scaledVOC, Units.PARTS_PER_BILLION);
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
-
if (CHANNEL_VOC.equals(channelId)) {
double scaledVOC = getUnscaledVOCValue() * getScalingFactor();
if (getBit(getDB0(), 2)) {
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, State> getCurrentStateFunc, Configuration config) {
-
if (CHANNEL_TVOC.equals(channelId)) {
return EEPHelper.calculateState(getDB2Value(), 0, 100, 0, 200, Units.PERCENT);
}
@Override
protected State convertToStateImpl(String channelId, String channelTypeId,
Function<String, @Nullable State> getCurrentStateFunc, Configuration config) {
-
switch (channelId) {
-
case CHANNEL_BATTERY_VOLTAGE:
return getSupplyVoltage();
/**
* This class tries to combine the classic EEP A5-38-08 CMD 0x02 dimming with the Eltako interpretation of this EEP.
* It is doing it by channel config parameter "eltakoDimmer". The differences are:
+ * <ul>
* <li>Dimming value 0-100%: standard 0-255, Eltako 0-100</li>
* <li>Store value: standard DB0.1, Eltako DB0.2</li>
+ * </ul>
*
* @author Daniel Weber - Initial contribution
*/
public static State calculateState(int unscaledValue, double scaledMin, double scaledMax, double unscaledMin,
double unscaledMax, Unit<?> unit) {
-
if (!validateUnscaledValue(unscaledValue, unscaledMin, unscaledMax)) {
return UnDefType.UNDEF;
}
import org.slf4j.LoggerFactory;
/**
- * The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by {@link EnOceanActuatorHandler} and
- * transferring received ESP3Packages to {@link EnOceanSensorHandler}.
+ * The {@link EnOceanBridgeHandler} is responsible for sending ESP3Packages build by
+ * {@link org.openhab.binding.enocean.internal.handler.EnOceanActuatorHandler} and
+ * transferring received ESP3Packages to
+ * {@link org.openhab.binding.enocean.internal.handler.EnOceanSensorHandler}.
*
* @author Daniel Weber - Initial contribution
*/
/**
* Retrieves the evohome configuration from the bridge
- *
- * @return The current evohome configuration
*/
protected void requestUpdate() {
Bridge bridge = getBridge();
if (customizations.length == 0) {
this.customizations = null;
} else {
-
this.customizations = Collections.unmodifiableMap(
Arrays.stream(customizations).collect(Collectors.toMap(ParserCustomization::getType,
customization -> customization, (a, b) -> b, HashMap::new)));
/**
* Button scanner class.
*
- * Inherit this class and override the {@link #onAdvertisementPacket(Bdaddr, String, int, boolean, boolean)} method.
+ * Inherit this class and override the
+ * {@link #onAdvertisementPacket(Bdaddr, String, int, boolean, boolean, boolean, boolean)} method.
* Then add this button scanner to a {@link FlicClient} using {@link FlicClient#addScanner(ButtonScanner)} to start it.
*/
public abstract class ButtonScanner {
* @return data corresponding to the query
* @throws FMIIOException on all I/O errors
* @throws FMIUnexpectedResponseException on all unexpected content errors
- * @throw FMIExceptionReportException on explicit error responses from the server
+ * @throws FMIExceptionReportException on explicit error responses from the server
*/
public FMIResponse query(Request request, int timeoutMillis)
throws FMIExceptionReportException, FMIUnexpectedResponseException, FMIIOException {
* @return locations representing stations
* @throws FMIIOException on all I/O errors
* @throws FMIUnexpectedResponseException on all unexpected content errors
- * @throw FMIExceptionReportException on explicit error responses from the server
+ * @throws FMIExceptionReportException on explicit error responses from the server
*/
public Set<Location> queryWeatherStations(int timeoutMillis)
throws FMIIOException, FMIUnexpectedResponseException, FMIExceptionReportException {
import org.slf4j.LoggerFactory;
/**
- * The {@link FMIDiscoveryService} creates things based on the configured location.
+ * The {@link FMIWeatherDiscoveryService} creates things based on the configured location.
*
* @author Sami Salonen - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link FoldingBinding} class defines common constants, which are
+ * The {@link FoldingBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Marius Bjoernstad - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link FoobotBinding} class defines common constants, which are
+ * The {@link FoobotBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Divya Chauhan - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link FreeboxBinding} class defines common constants, which are
+ * The {@link FreeboxBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Gaël L'hopital - Initial contribution
import org.openhab.core.types.Command;
/**
- * The {@link FreeboxBinding} class defines common constants, which are used across the binding.
+ * The {@link FreeboxOsBindingConstants} class defines common constants, which are used across the binding.
*
* @author Gaël L'hopital - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * The {@FreeboxOsIconProvider} delivers icons provided by FreeboxOS
+ * The {@link FreeboxOsIconProvider} delivers icons provided by FreeboxOS
*
* @author Gaël L'hopital - Initial contribution
*/
import com.google.gson.annotations.SerializedName;
/**
- * The {@link MeterRealtimeBody} is responsible for storing
+ * The {@link MeterRealtimeBodyDTO} is responsible for storing
* the "body" node of the JSON response
*
* @author Jimmy Tanagra - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link MeterRealtimeBodyData} is responsible for storing
+ * The {@link MeterRealtimeBodyDataDTO} is responsible for storing
* the "data" node of the JSON response
*
* The main SerializedName values use Smart Meter 63A names
import com.google.gson.annotations.SerializedName;
/**
- * The {@link MeterRealtimeDetails} is responsible for storing
+ * The {@link MeterRealtimeDetailsDTO} is responsible for storing
* the "body" node of the JSON response
*
* @author Jimmy Tanagra - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link MeterRealtimeResponse} is responsible for storing
+ * The {@link MeterRealtimeResponseDTO} is responsible for storing
* the response from the powerflowrealtime api
*
* @author Jimmy Tanagra - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link OhmpilotRealtimeBody} is responsible for storing
+ * The {@link OhmpilotRealtimeBodyDTO} is responsible for storing
* the "body" node of the JSON response
*
* @author Hannes Spenger - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link OhmpilotRealtimeBodyData} is responsible for storing
+ * The {@link OhmpilotRealtimeBodyDataDTO} is responsible for storing
* the "data" node of the JSON response
*
* @author Hannes Spenger - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link OhmpilotRealtimeDetails} is responsible for storing
+ * The {@link OhmpilotRealtimeDetailsDTO} is responsible for storing
* the "body" node of the JSON response
*
* @author Hannes Spenger - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link OhmpilotRealtimeResponse} is responsible for storing
+ * The {@link OhmpilotRealtimeResponseDTO} is responsible for storing
* the response from the GetOhmPilotRealtimeData api
*
* @author Hannes Spenger - Initial contribution
Thread.sleep(500 * attempts);
attempts++;
}
-
} catch (JsonSyntaxException | NumberFormatException e) {
logger.debug("Received Invalid JSON Data", e);
throw new FroniusCommunicationException("Invalid JSON data received", e);
*
* Typically used for polling state info.
*
- * @param REST
- * API requestString, e.g. "GET/netRemote.sys.power"
+ * @param requestString REST API request, e.g. "GET/netRemote.sys.power"
* @return request result
* @throws IOException if the request failed.
*/
*
* Typically used for changing parameters.
*
- * @param REST
- * API requestString, e.g. "SET/netRemote.sys.power"
- * @param params
- * , e.g. "value=1"
+ * @param requestString REST API request, e.g. "SET/netRemote.sys.power"
+ * @param params parameters, e.g. "value=1"
* @return request result
* @throws IOException if the request failed.
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link FtpUploadBinding} class defines common constants, which are
+ * The {@link FtpUploadBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Pauli Anttila - Initial contribution
package org.openhab.binding.ftpupload.internal.config;
/**
- * Configuration class for {@link FtpUploadBinding} device.
+ * Configuration class for FtpUpload device.
*
* @author Pauli Anttila - Initial contribution
*/
if (isErrorReply(deviceReply)) {
return false;
}
-
} catch (InterruptedException e) {
createGenericError("Poll of response queue was interrupted");
return false;
int eCode;
try {
eCode = Integer.parseInt(errorCode);
-
} catch (NumberFormatException e) {
eCode = 0;
logger.debug("Badly formatted error code '{}' received from device: {}", errorCode, e.getMessage());
beaconFound = true;
logger.trace("Multicast listener got datagram of length {} from multicast port: {}", msgPacket.getLength(),
msgPacket.toString());
-
} catch (SocketTimeoutException e) {
beaconFound = false;
}
import com.google.gson.annotations.SerializedName;
/**
- * The {@link GoEStatusResponse} class represents a json response from the
+ * The {@link GoEStatusResponseDTO} class represents a json response from the
* charger.
*
* @author Samuel Brucksch - Initial contribution
import org.openhab.core.thing.type.ChannelTypeUID;
/**
- * The {@link gpioBindingConstants} class defines common constants, which are
+ * The {@link GPIOBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Nils Bauer - Initial contribution
import org.osgi.service.component.annotations.Component;
/**
- * The {@link gpioHandlerFactory} is responsible for creating things and thing
+ * The {@link GPIOHandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Nils Bauer - Initial contribution
* temperature value shown on the device LCD display should match the value shown by this binding when the config
* parameter currentTemperatureOffset is set to 0.
*
- * @See https://github.com/tomikaa87/gree-remote#getting-the-current-temperature-reading-from-the-internal-sensor
+ * @see https://github.com/tomikaa87/gree-remote#getting-the-current-temperature-reading-from-the-internal-sensor
* for more details.
*/
public static final double INTERNAL_TEMP_SENSOR_OFFSET = -40.0;
}
/**
- * @param value set temperature in degrees Celsius or Fahrenheit
+ * @param temp set temperature in degrees Celsius or Fahrenheit
*/
public void setDeviceTempSet(DatagramSocket clientSocket, QuantityType<?> temp) throws GreeException {
// If commanding Fahrenheit set halfStep to 1 or 0 to tell the A/C which F integer
newState = new QuantityType<>(lastMeasurement.getTemperatureGuard(), SIUnits.CELSIUS);
break;
case CHANNEL_VALVE_OPEN:
-
OnOffType valveOpenType = getValveOpenType(appliance);
if (valveOpenType != null) {
newState = valveOpenType;
}
/**
- * @param id The id of the mower to query
+ * @param vin The VIN to query
* @return A detailed status of the mower with the specified id
* @throws GroupePSACommunicationException In case the query cannot be executed
* successfully
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link HarmonyHubBinding} class defines common constants, which are
+ * The {@link HarmonyHubBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Dan Cunningham - Initial contribution
import org.osgi.service.component.annotations.Reference;
/**
- * Dynamic provider of state options for {@link HueBridgeHandler} while leaving other state description fields as
- * original.
+ * Dynamic provider of state options for {@link org.openhab.binding.hue.internal.handler.HueBridgeHandler}
+ * while leaving other state description fields as original.
*
* @author Matt Myers - Initial contribution
*/
import org.openhab.core.types.State;
/**
- * The {@link HaywarThingHandler} is a subclass of the BaseThingHandler and a Super
+ * The {@link HaywardThingHandler} is a subclass of the BaseThingHandler and a Super
* Class to each Hayward Thing Handler
*
* @author Matt Myers - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link HDanywhereBinding} class defines common constants, which are used
+ * The {@link HDanywhereBindingConstants} class defines common constants, which are used
* across the whole binding.
*
* @author Karel Goderis - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link HDPowerViewBinding} class defines common constants, which are
+ * The {@link HDPowerViewBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Andy Lintner - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link HeliosBinding} class defines common constants, which are used
+ * The {@link HeliosBindingConstants} class defines common constants, which are used
* across the whole binding.
*
* @author Karel Goderis - Initial contribution
import org.openhab.core.thing.type.ChannelTypeUID;
/**
- * The {@link HeosBinding} class defines common constants, which are
+ * The {@link HeosBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Johannes Einig - Initial contribution
/**
* Asks for the actual state of the player. The result has
- * to be handled by the event controller. The system returns {@link HeosConstants.PLAY},
- * {@link HeosConstants.PAUSE} or {@link HeosConstants.STOP}.
+ * to be handled by the event controller. The system returns {@link HeosConstants#PLAY},
+ * {@link HeosConstants#PAUSE} or {@link HeosConstants#STOP}.
*
* @param id The player ID the state shall get for
* @return
/**
* Ask for the actual mute state of the player. The result has
- * to be handled by the event controller. The HEOS system returns {@link HeosConstants.ON}
- * or {@link HeosConstants.OFF}.
+ * to be handled by the event controller. The HEOS system returns {@link HeosConstants#ON}
+ * or {@link HeosConstants#OFF}.
*
* @param id The player id the mute state shall get for
* @return
/**
* Ask for the actual shuffle mode of the player. The result has
- * to be handled by the event controller. The HEOS system returns {@link HeosConstants.ON},
- * {@link HeosConstants.HEOS_REPEAT_ALL} or {@link HeosConstants.HEOS_REPEAT_ONE}
+ * to be handled by the event controller. The HEOS system returns {@link HeosConstants#ON},
+ * {@link HeosConstants#HEOS_REPEAT_ALL} or {@link HeosConstants#HEOS_REPEAT_ONE}
*
* @param id The player id the shuffle mode shall get for
* @return
import org.slf4j.LoggerFactory;
/**
- * The {@Link HeosStringPropertyChangeListener} provides the possibility
+ * The {@link HeosStringPropertyChangeListener} provides the possibility
* to add a listener to a String and get informed about the new value.
*
* @author Johannes Einig - Initial contribution
* @param dpConfig The configuration of the datapoint
* @param newValue The new value for the datapoint
* @param rxMode The rxMode with which the value should be sent to the device
- * ({@link HomematicBindingConstants#RX_BURST_MODE "BURST"} for burst mode,
- * {@link HomematicBindingConstants#RX_WAKEUP_MODE "WAKEUP"} for wakeup mode, or null for the default
- * mode)
+ * ({@link org.openhab.binding.homematic.internal.HomematicBindingConstants#RX_BURST_MODE "BURST"}
+ * for burst mode,
+ * {@link org.openhab.binding.homematic.internal.HomematicBindingConstants#RX_WAKEUP_MODE "WAKEUP"}
+ * for wakeup mode, or null for the default mode)
*/
void sendDatapoint(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue, String rxMode)
throws IOException, HomematicClientException;
import org.openhab.core.types.Type;
/**
- * Converts between a Homematic datapoint value and a {@link DecimalType}.
+ * Converts between a Homematic datapoint value and a {@link org.openhab.core.library.types.DecimalType}.
*
* @author Michael Reitler - Initial contribution
*/
* Use this method to lookup a ChannelGroupType which was generated by the
* homematic binding. Other than {@link #getChannelGroupType(ChannelGroupTypeUID, Locale)}
* of this provider, it will return also those {@link ChannelGroupType}s
- * which are excluded by {@link HomematicThingTypeExcluder}
+ * which are excluded by {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
*
* @param channelGroupTypeUID
* e.g. <i>homematic:HM-WDS40-TH-I-2_0</i>
* Use this method to lookup a ChannelType which was generated by the
* homematic binding. Other than {@link #getChannelType(ChannelTypeUID, Locale)}
* of this provider, it will return also those {@link ChannelType}s
- * which are excluded by {@link HomematicThingTypeExcluder}
+ * which are excluded by
+ * {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
*
* @param channelTypeUID
* e.g. <i>homematic:HM-WDS40-TH-I-2_0_RSSI_DEVICE</i>
/**
* Use this method to lookup a ConfigDescription which was generated by the
* homematic binding. Other than {@link #getConfigDescription(URI, Locale)}
- * of this provider, it will return also those {@link ConfigDescription}s
- * which are excluded by {@link HomematicThingTypeExcluder}
+ * of this provider, it will return also those
+ * {@link org.openhab.core.config.core.ConfigDescription}s
+ * which are excluded by
+ * {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
*
* @param URI config-description-uri
* e.g. <i>thing-type:homematic:HM-WDS40-TH-I-2</i>
/**
* Returns list of ThingTypes to be excluded. Clients which implement this
* are henceforth responsible to ...
+ * <ul>
* <li>provide any excluded ThingType on their own - e.g. in a custom
* {@link org.openhab.core.thing.binding.ThingTypeProvider} or by
* defining those {@link org.openhab.core.thing.type.ThingType}s in XML.</li>
* {@link org.openhab.core.thing.Channel}) which can be handled by
* the binding (see
* {@link org.openhab.binding.homematic.internal.handler.HomematicThingHandler})</li>
+ * </ul>
*
* @return {@link ThingTypeUID}s of ThingTypes that are supposed to be
* excluded from the binding's thing-type generation
import org.slf4j.LoggerFactory;
/**
- * The {@link CascadedValueTransformationImpl} implements {@link ValueTransformation for a cascaded set of
- * transformations}
+ * The {@link CascadedValueTransformationImpl} implements {@link ValueTransformation} for a cascaded set of
+ * transformations
*
* @author Jan N. Klug - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * A transformation for a value used in {@HttpChannel}.
+ * A transformation for a value used in {@link HttpChannel}.
*
* @author David Graeff - Initial contribution
* @author Jan N. Klug - adapted from MQTT binding to HTTP binding
*
* It uses the following connection mechanisms:
*
+ * <ul>
* <li>The primary communication uses HTTP 2 streams over a shared permanent HTTP 2 session.</li>
* <li>The 'registerApplicationKey()' method uses HTTP/1.1 over the OH common Jetty client.</li>
* <li>The 'isClip2Supported()' static method uses HTTP/1.1 over the OH common Jetty client via 'HttpUtil'.</li>
+ * </ul>
*
* @author Andrew Fiddian-Green - Initial Contribution
*/
/**
* The {@link HueBridgeMDNSDiscoveryParticipant} is responsible for discovering new and removed Hue Bridges. It uses the
- * central MDNSDiscoveryService.
+ * central {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}.
*
* @author Kai Kreuzer - Initial contribution
* @author Thomas Höfer - Added representation
import org.slf4j.LoggerFactory;
/**
- * The {@link HueBridgeServiceTracker} tracks for Hue lights, sensors and groups which are connected
+ * The {@link HueDeviceDiscoveryService} tracks for Hue lights, sensors and groups which are connected
* to a paired Hue Bridge. The default search time for Hue is 60 seconds.
*
* @author Kai Kreuzer - Initial contribution
/**
* This method is called whenever the list of available scenes is updated.
*
- * @param updatedScenes available scenes
+ * @param scenes available scenes
*/
void onScenesUpdated(List<Scene> scenes);
}
* If there is a user name available, it attempts to re-authenticate. Otherwise new authentication credentials will
* be requested from the bridge.
*
- * @param bridge the Hue Bridge the connection is not authorized
* @return returns {@code true} if re-authentication was successful, {@code false} otherwise
*/
public boolean onNotAuthenticated() {
* Handles the sensor change. Implementation should also update sensor-specific configuration that changed since the
* last update.
*
- * @param bridge the bridge
* @param sensor the sensor
* @param config the configuration in which to update the config states of the sensor
*/
* <li>{@value #ALERT_MODE_NONE}.
* <li>{@value #ALERT_MODE_SELECT}.
* <li>{@value #ALERT_MODE_LONG_SELECT}.
- * <ul>
+ * </ul>
* @return light state containing the {@link AlertMode} or <b><code>null </code></b> if the provided
* {@link StringType} represents unsupported mode.
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link HyperionBinding} class defines common constants, which are
+ * The {@link HyperionBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Daniel Walters - Initial contribution
/**
* Retrieves {@link Auxiliary[]} devices
*
- * @param serialNumber
- * @param sessionId
+ * @param serial
+ * @param sessionID
* @return {@link Auxiliary[]}
* @throws IOException
* @throws NotAuthorizedException
/**
* Sends an Auxiliary light command
*
- * @param serialNumber
- * @param sessionId
- * @param command
+ * @param serial
+ * @param sessionID
+ * @param auxID
* @param lightValue
+ * @param subtype
* @return
* @throws IOException
* @throws NotAuthorizedException
/**
* Sets the Spa Temperature Setpoint
*
- * @param serialNumber
- * @param sessionId
+ * @param serial
+ * @param sessionID
* @param spaSetpoint
* @return
* @throws IOException
/**
* Sets the Pool Temperature Setpoint
*
- * @param serialNumber
- * @param sessionId
+ * @param serial
+ * @param sessionID
* @param poolSetpoint
* @return
* @throws IOException
package org.openhab.binding.ihc.internal.config;
/**
- * Configuration class for {@link IhcBinding} binding.
+ * Configuration class for IhcBinding binding.
*
* @author Pauli Anttila - Initial contribution
*/
* Enable resources runtime value notifications.
*
* @param resourceIdList List of resource Identifiers.
- * @return True is connection successfully opened.
*/
public synchronized void enableRuntimeValueNotifications(Set<Integer> resourceIdList) throws IhcExecption {
resourceInteractionService.enableRuntimeValueNotifications(resourceIdList);
* Resource value's value field (e.g. floatingPointValue) could be old
* information.
*
- * @param resoureId Resource Identifier.
+ * @param resourceId Resource Identifier.
* @return Resource value.
*/
public WSResourceValue getResourceValueInformation(int resourceId) throws IhcExecption {
/**
* Sets the number of segmentations.
*
- * @param value
+ * @param segments
*/
public void setNumberOfSegments(int segments) {
this.segments = segments;
/**
* Sets the device type value for this WSRFDevice.
*
- * @param device type
+ * @param deviceType device type
*/
public void setDeviceType(int deviceType) {
this.deviceType = deviceType;
/**
* Sets the serial number value for this WSRFDevice.
*
- * @param Serial number
+ * @param serialNumber Serial number
*/
public void setSerialNumber(long serialNumber) {
this.serialNumber = serialNumber;
/**
* Sets the RealTimeClock value for this WSSystemInfo.
*
- * @param RealTimeClock
+ * @param realtimeclock
*/
public void setRealTimeClock(ZonedDateTime realtimeclock) {
this.realtimeclock = realtimeclock;
/**
* Sets the SerialNumber value for this WSSystemInfo.
*
- * @param SerialNumber
+ * @param serialNumber
*/
public void setSerialNumber(String serialNumber) {
this.serialNumber = serialNumber;
/**
* Sets the value of the firstname property.
- *
- * @return possible object is {@link String }
- *
*/
public void setFirstname(String value) {
this.firstname = value;
/**
* Gets the value of the phone property.
- *
- * @param value allowed object is {@link String }
- *
*/
public String getPhone() {
return phone;
* Enable resources runtime value notifications.
*
* @param resourceIdList List of resource Identifiers.
- * @return True is connection successfully opened.
*/
public void enableRuntimeValueNotifications(Set<Integer> resourceIdList) throws IhcExecption {
// @formatter:off
* @param timeoutInSeconds How many seconds to wait notifications.
* @return List of received runtime value notifications.
* @throws SocketTimeoutException
- * @throws IhcTimeoutExecption
+ * @throws IhcExecption
*/
public List<WSResourceValue> waitResourceValueNotifications(int timeoutInSeconds) throws IhcExecption {
// @formatter:off
/**
* Constructor
*
- * @param item name of the item that is listening
+ * @param binding
* @param channelUID channel associated with this item
- * @param eventPublisher the publisher to use for publishing on the openhab bus
+ * @param item name of the item that is listening
*/
public DeviceFeatureListener(InsteonBinding binding, ChannelUID channelUID, String item) {
this.binding = binding;
* @param cmd2
* @return standard message
* @throws FieldException
- * @throws IOException
+ * @throws InvalidMessageTypeException
*/
public Msg makeStandardMessage(byte flags, byte cmd1, byte cmd2)
throws FieldException, InvalidMessageTypeException {
* @param group (-1 if not a group message)
* @return standard message
* @throws FieldException
- * @throws IOException
+ * @throws InvalidMessageTypeException
*/
public Msg makeStandardMessage(byte flags, byte cmd1, byte cmd2, int group)
throws FieldException, InvalidMessageTypeException {
* @param cmd2
* @return extended message
* @throws FieldException
- * @throws IOException
+ * @throws InvalidMessageTypeException
*/
public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2)
throws FieldException, InvalidMessageTypeException {
* @param data array with userdata
* @return extended message
* @throws FieldException
- * @throws IOException
+ * @throws InvalidMessageTypeException
*/
public Msg makeExtendedMessage(byte flags, byte cmd1, byte cmd2, byte[] data)
throws FieldException, InvalidMessageTypeException {
* @param data array with user data
* @return extended message
* @throws FieldException
- * @throws IOException
+ * @throws InvalidMessageTypeException
*/
public Msg makeExtendedMessageCRC2(byte flags, byte cmd1, byte cmd2, byte[] data)
throws FieldException, InvalidMessageTypeException {
*
* @param m message to be sent
* @param f device feature that sent this message (so we can associate the response message with it)
- * @param d time (in milliseconds)to delay before enqueuing message
+ * @param delay time (in milliseconds) to delay before enqueuing message
*/
public void enqueueDelayedMessage(Msg m, DeviceFeature f, long delay) {
long now = System.currentTimeMillis();
* Extract button information from message
*
* @param msg the message to extract from
- * @param the device feature (needed for debug printing)
+ * @param f the device feature (needed for debug printing)
* @return the button number or -1 if no button found
*/
protected static int getButtonInfo(Msg msg, DeviceFeature f) {
* Will fetch a byte array starting at a certain field
*
* @param key the name of the first field
- * @param number of bytes to get
+ * @param numBytes of bytes to get
* @return the byte array
*/
public byte[] getBytes(String key, int numBytes) throws FieldException {
/**
* Sets the userData fields from a byte array
*
- * @param data
+ * @param arg
*/
public void setUserData(byte[] arg) {
byte[] data = Arrays.copyOf(arg, 14); // appends zeros if short
*
* @param type the type of message to create, as defined in the xml file
* @return reference to message created
- * @throws IOException if there is no such message type known
+ * @throws InvalidMessageTypeException if there is no such message type known
*/
public static Msg makeMessage(String type) throws InvalidMessageTypeException {
Msg m = MSG_MAP.get(type);
* Used to post a request to the device
*
* @param ipAddress of the device
- * @param content string
+ * @param contentString string
* @return JSON string as response
*/
@Nullable
import org.eclipse.jdt.annotation.Nullable;
/**
- * The {@link DataPointChangedEvent} is an event container for data point changes
+ * The {@link MessageReceivedEvent} is an event container for data point changes
*
* @author Hans-Jörg Merk - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link ism8BindingConstants} class defines common constants, which are
+ * The {@link Ism8BindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Hans-Reiner Hoffmann - Initial contribution
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link ism8Configuration} class contains fields mapping thing configuration parameters.
+ * The {@link Ism8Configuration} class contains fields mapping thing configuration parameters.
*
* @author Hans-Reiner Hoffmann - Initial contribution
*/
import org.osgi.service.component.annotations.Component;
/**
- * The {@link ism8HandlerFactory} is responsible for creating things and thing
+ * The {@link Ism8HandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Hans-Reiner Hoffmann - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link ism8Server} is responsible for listening to the Ism8 information
+ * The {@link Server} is responsible for listening to the Ism8 information
*
* @author Hans-Reiner Hoffmann - Initial contribution
*/
import com.google.gson.annotations.SerializedName;
/**
- * {@link JuiceNetDeviceChargingStatus } implements DTO for device charging status
+ * {@link JuiceNetApiDeviceChargingStatus } implements DTO for device charging status
*
* @author Jeff James - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link KebaBinding} class defines common constants, which are used across
+ * The {@link KebaBindingConstants} class defines common constants, which are used across
* the whole binding.
*
* @author Karel Goderis - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link km200Binding} class defines common constants, which are
+ * The {@link KM200BindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Markus Eckhardt - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link KodiBinding} class defines common constants, which are used across
+ * The {@link KodiBindingConstants} class defines common constants, which are used across
* the whole binding.
*
* @author Paul Frank - Initial contribution
public class KonnectedConfiguration extends Configuration {
/**
- * @param blink identifies whether the Konnected Alarm Panel LED will blink on transmission of Wifi Commands
- * @param discovery identifies whether the Konnected Alarm Panel will be discoverable via UPnP
+ * blink identifies whether the Konnected Alarm Panel LED will blink on transmission of Wifi Commands.
*/
public boolean blink;
+
+ /**
+ * discovery identifies whether the Konnected Alarm Panel will be discoverable via UPnP.
+ */
public boolean discovery;
}
*
* @param urlAddress the address to send the request
* @param payload the json payload you want to send as part of the request, may be null.
- * @param retry the number of retries before throwing the IOexpcetion back to the handler
+ * @param retryCount the number of retries before throwing the IOexpcetion back to the handler
*/
public synchronized String doGet(String urlAddress, String payload, int retryCount)
throws KonnectedHttpRetryExceeded {
*
* @param urlAddress the address to send the request
* @param payload the json payload you want to send as part of the request
- * @param retry the number of retries before throwing the IOexpcetion back to the handler
+ * @param retryCount the number of retries before throwing the IOexpcetion back to the handler
*/
public synchronized String doPut(String urlAddress, String payload, int retryCount)
throws KonnectedHttpRetryExceeded {
/**
* The {@link ZoneConfiguration} class contains the configuration parameters for the zone.
*
- * @author Haavar Valeur
+ * @author Haavar Valeur - Initial contribution
*/
@NonNullByDefault
public class ZoneConfiguration {
* This is the constructor of the Konnected Handler.
*
* @param thing the instance of the Konnected thing
- * @param webHookServlet the instance of the callback servlet that is running for communication with the Konnected
- * Module
- * @param hostAddress the webaddress of the openHAB server instance obtained by the runtime
- * @param port the port on which the openHAB instance is running that was obtained by the runtime.
+ * @param callbackUrl the webaddress of the openHAB server instance obtained by the runtime
*/
public KonnectedHandler(Thing thing, String callbackUrl) {
super(thing);
import java.util.List;
/**
- * The {@link SecondGenerationDxsEntriesContainer} class defines a Container, which is
+ * The {@link SecondGenerationDxsEntriesContainerDTO} class defines a Container, which is
* used in the second generation part of the binding.
*
* @author Örjan Backsell - Initial contribution Piko1020, Piko New Generation
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link LaMetricTimeBinding} class defines common constants, which are
+ * The {@link LaMetricTimeBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Gregory Moyer - Initial contribution
/**
* Start an lcn relay timer with the given duration [ms]
*
- * @param relaynumber 1-based number of the relay to use
+ * @param relayNumber 1-based number of the relay to use
* @param duration duration of the relay timer in milliseconds
*/
@RuleAction(label = "start a relay timer", description = "Start an LCN relay timer.")
/**
* Let the beeper connected to the LCN module beep.
*
- * @param volume sound volume in percent. Can be null. Then, the last volume is used.
+ * @param soundVolume sound volume in percent. Can be null. Then, the last volume is used.
* @param tonality N=normal, S=special, 1-7 tonalities 1-7. Can be null. Then, normal tonality is used.
* @param count number of beeps. Can be null. Then, number of beeps is one.
*/
}
/**
- * Updates the LCN module's serial number property.
+ * Updates the LCN module's firmware version property.
*
- * @param serialNumber the new serial number
+ * @param firmwareVersion the new firmware version
*/
public void updateFirmwareVersionProperty(String firmwareVersion) {
updateProperty(Thing.PROPERTY_FIRMWARE_VERSION, firmwareVersion);
* Gets the physical segment id ("local" segment replaced with 0).
* Can be used to send data into the LCN bus.
*
- * @param localSegegmentId the segment id of the local segment (managed by {@link Connection})
+ * @param localSegegmentId the segment id of the local segment (managed by
+ * {@link org.openhab.binding.lcn.internal.connection.Connection})
* @return the physical segment id
*/
public int getPhysicalSegmentId(int localSegegmentId) {
/**
* Generates an array of booleans from an input integer (actually a byte).
*
- * @param input the input byte (0..255)
+ * @param inputByte the input byte (0..255)
* @return the array of 8 booleans
* @throws IllegalArgumentException if input is out of range (not a byte)
*/
/**
* Generates a keep-alive.
* LCN-PCHK will close the connection if it does not receive any commands from
- * an open {@link Connection} for a specific period (10 minutes by default).
+ * an open {@link org.openhab.binding.lcn.internal.connection.Connection} for a specific period
+ * (10 minutes by default).
*
* @param counter the current ping's id (optional, but "best practice"). Should start with 1
* @return the PCK command as text
* Generates a control command for switching all outputs ON or OFF with a fixed ramp of 0.5s.
*
* @param percent 0..100
- * @returnthe PCK command (without address header) as text
+ * @return the PCK command (without address header) as text
*/
public static String controlAllOutputs(double percent) {
return String.format("AH%03d", Math.round(percent));
* @param number regulator number 0..1
* @param value the absolute value to set
* @return the PCK command (without address header) as text
- * @throws LcnException
*/
public static String setSetpointAbsolute(int number, int value) {
int internalValue = value;
* @param type the reference-point
* @param value the native LCN value to add/subtract (can be negative)
* @return the PCK command (without address header) as text
- * @throws LcnException if command is not supported
*/
public static String setVariableRelative(Variable variable, LcnDefs.RelVarRef type, int value) {
if (variable.getNumber() == 0) {
/**
* Generates a command to let the beeper connected to the LCN module beep.
*
- * @param volume the sound volume
+ * @param tonality N=normal, S=special, 1-7 tonalities 1-7.
+ * @param count count number of beeps.
* @return the PCK command (without address header) as text
* @throws LcnException if out of range
*/
* Checks if the target LCN module would automatically send status-updates if
* the given variable type was changed by command.
*
- * @param variable the variable type to check
- * @param is2013 the target module's-generation
+ * @param firmwareVersion
* @return true if a poll is required to get the new status-value
*/
@SuppressWarnings("PMD.SimplifyBooleanReturns")
/**
* Gets the SocketChannel of the Connection.
*
- * @returnthe socket channel
+ * @return the socket channel
*/
@Nullable
public Channel getSocketChannel() {
/**
* Converts a human readable value into LCN native value.
*
- * @param humanReadable value to convert
+ * @param quantityType value to convert
* @return the native LCN value
* @throws LcnException when the value could not be converted to the base unit
*/
/**
* Converts a human readable value into LCN native value.
*
- * @param humanReadable value to convert
+ * @param quantityType value to convert
* @return the native LCN value
* @throws LcnException when the value could not be converted to the base unit
*/
* message.
*
* @param pck the message to process
- * @return true, if the message could be processed successfully
*/
public void tryParse(String pck) {
getPckStatusMessagePatterns().stream() //
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link LgTvSerialBinding} class defines common constants, which are
+ * The {@link LgTvSerialBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Marius Bjoernstad - Initial contribution
/**
* Creates a subscription instance for this device if subscription is supported.
*
- * @param device device to which state changes to subscribe to
- * @param channelID channel ID
+ * @param channelId channel ID
* @param handler
* @return an {@code Optional} containing the ServiceSubscription, or an empty {@code Optional} if subscription is
* not supported.
/**
* Send single WOL (Wake On Lan) package on all interfaces
*
- * @macAddress MAC address to send WOL package to
+ * @param macAddress MAC address to send WOL package to
*/
public static void sendWOLPacket(String macAddress) {
byte[] bytes = getWOLPackage(macAddress);
import org.openhab.core.thing.type.ChannelTypeUID;
/**
- * The {@link LifxBinding} class defines common constants, which are used across
+ * The {@link LifxBindingConstants} class defines common constants, which are used across
* the whole binding.
*
* @author Dennis Nobel - Initial contribution
* <li>RSSI <= -100: returns 0
* <li>-100 < RSSI < -50: returns a value between 0 and 1 (linearly distributed)
* <li>RSSI >= -50: returns 1
- * <ul>
+ * </ul>
*
* @return a value between 0 and 1. 0 being worst strength and 1
* being best strength.
/**
* Called when the {@link LifxLightPropertiesUpdater} has updated light properties.
*
- * @param packet the updated properties
+ * @param properties the updated properties
*/
void handlePropertiesUpdate(Map<String, String> properties);
}
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link LIRCBinding} class defines common constants, which are
+ * The {@link LIRCBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Andrew Nagle - Initial contribution
/**
* Interface for listeners to receive messages from LIRC server
*
- * @author Andrew Nagle
+ * @author Andrew Nagle - Initial contribution
*/
public interface LIRCMessageListener {
/**
* Exceptions thrown from the serial interface.
*
- * @author Andrew Nagle - Initial contributor
+ * @author Andrew Nagle - Initial contribution
*/
public class LIRCResponseException extends Exception {
package org.openhab.binding.lirc.internal.config;
/**
- * Configuration class for {@link LIRCBridge} device.
+ * Configuration class for LIRCBridge device.
*
* @author Andrew Nagle - Initial contribution
*/
package org.openhab.binding.lirc.internal.config;
/**
- * Configuration class for {@link LIRCRemote} device.
+ * Configuration class for LIRCRemote device.
*
* @author Andrew Nagle - Initial contribution
*/
/**
* Connector for communication with the LIRC server
*
- * @author Andrew Nagle - Initial contributor
+ * @author Andrew Nagle - Initial contribution
*/
public class LIRCConnector {
/**
* Defines an interface to receive messages from the LIRC server
*
- * @author Andrew Nagle
+ * @author Andrew Nagle - Initial contribution
*/
public interface LIRCEventListener {
/**
* Procedure to receive messages from the LIRC server
*
- * @param reponse
+ * @param message
* Message received
*/
void messageReceived(LIRCResponse message);
/**
* Stream reader to parse LIRC output into messages
*
- * @author Andrew Nagle
+ * @author Andrew Nagle - Initial contribution
*/
public class LIRCStreamReader extends Thread {
import org.eclipse.jdt.annotation.Nullable;
/**
- * Configuration class for {@link LogReaderBinding} binding.
+ * Configuration class for LogReader binding.
*
* @author Pauli Anttila - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link LutronBinding} class defines common constants, which are
+ * The {@link LutronBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Allan Tong - Initial contribution
/**
* Returns a comma formatted list of shade zones
*
- * @returna non-null, non-empty comma delimited list of shade zones
+ * @return a non-null, non-empty comma delimited list of shade zones
*/
public String getShadeZones() {
final StringBuilder sb = new StringBuilder();
package org.openhab.binding.lutron.internal.hw;
/**
- * Configuration settings for a {@link org.openhab.binding.lutron.handler.HWDimmerHandler}.
+ * Configuration settings for a {@link org.openhab.binding.lutron.internal.hw.HwDimmerHandler}.
*
* @author Andrew Shilliday - Initial contribution
*/
package org.openhab.binding.lutron.internal.hw;
/**
- * Configuration settings for an {@link org.openhab.binding.lutron.handler.HWSerialBridgeHandler}.
+ * Configuration settings for an {@link org.openhab.binding.lutron.internal.hw.HwSerialBridgeHandler}.
*
* @author Andrew Shilliday - Initial contribution
*/
/**
* GroupCommand constructor
*
- * @param targetType
* @param operation
* @param integrationId
* @param action
/**
* SysvarCommand constructor
*
- * @param targetType
* @param operation
* @param integrationId
* @param action
/**
* TimeclockCommand constructor
*
- * @param targetType
* @param operation
* @param integrationId
* @param action
return null;
}
- /**
- * Add a device to the device table
- *
- * @param udn UDN for the device
- * @param deviceId A unique device id
- * @param ipAddress IP address of the receiver
- * @param handler The corresponding thing handler
- */
-
public void setNotifyServletStatus(boolean newStatus) {
logger.debug("NotifyServlet started");
servletInitialized = newStatus;
* <friendlyName>$friendlyName</friendlyName>\n <userID>$userID</userID>\n
* </u:X-pairingRequest>\n </s:Body> </s:Envelope>
*
- * @returns true: pairing successful
+ * @return true: pairing successful
* @throws MagentaTVException
*/
public boolean sendPairingRequest() throws MagentaTVException {
/**
* Constructor, save bindingConfig (services as default for thingConfig)
*
+ * @param manager
* @param thing
- * @param bindingConfig
+ * @param network
+ * @param httpClient
*/
public MagentaTVHandler(MagentaTVDeviceManager manager, Thing thing, MagentaTVNetwork network,
HttpClient httpClient) {
/**
* Update thing status
*
- * @param mode new thing status
- * @return ON = power on, OFF=power off
+ * @param newStatus new thing status
+ * @param errorMessage
*/
public void setOnlineStatus(ThingStatus newStatus, String errorMessage) {
ThingStatus status = this.getThing().getStatus();
* Given a URL and a set parameters, send a HTTP POST request to the URL
* location created by the URL and parameters.
*
+ * @param host
* @param url The URL to send a POST request to.
- * @param urlParameters List of parameters to use in the URL for the POST
+ * @param postData List of parameters to use in the URL for the POST
* request. Null if no parameters.
* @param soapAction Header attribute for SOAP ACTION: xxx
* @param connection Header attribut for CONNECTION: xxx
* @param remotePort destination port
* @param data data to send
* @return received response
- * @throws IOException
+ * @throws MagentaTVException
*/
public String sendData(String remoteIp, String remotePort, String data) throws MagentaTVException {
String errorMessage = "";
/**
* Init local network interface, determine local IP and MAC address
*
- * @param networkAddressService
- * @return
+ * @param localIP
+ * @param localPort
*/
public void initLocalNet(String localIP, String localPort) throws MagentaTVException {
try {
* STB_playContent> </e:property> </e:propertyset>
*
* @param request
- * @param resp
+ * @param response
*
* @throws ServletException, IOException
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link C_CubeCommand} to request configuration of a new MAX! device after inclusion.
+ * The {@link CubeCommand} to request configuration of a new MAX! device after inclusion.
*
* @author Marcel Verpaalen - Initial Contribution
*/
import org.eclipse.jdt.annotation.Nullable;
/**
- * The {@link F_CubeCommand} is used to query and update the NTP servers used by the Cube.
+ * The {@link FCommand} is used to query and update the NTP servers used by the Cube.
*
* @author Marcel Verpaalen - Initial Contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link N_CubeCommand} starts the inclusion mode for new MAX! devices.
+ * The {@link NCommand} starts the inclusion mode for new MAX! devices.
*
* @author Marcel Verpaalen - Initial Contribution
*/
import org.openhab.binding.max.internal.Utils;
/**
- * The {@link T_CubeCommand} is used to unlink MAX! devices from the Cube.
+ * The {@link TCommand} is used to unlink MAX! devices from the Cube.
*
* @author Marcel Verpaalen - Initial Contribution
*/
/**
* Creates a new device
*
- * @param DeviceConfiguration
+ * @param c
* @return Device
*/
public static Device create(DeviceConfiguration c) {
/**
* This method is called whenever a device config is updated.
*
- * @param bridgeThe MAX! Cube bridge the device was connected to
+ * @param bridge The MAX! Cube bridge the device was connected to
* @param device The device which config is changed
*/
void onDeviceConfigUpdate(Bridge bridge, Device device);
* Max! Cube, they will be removed from the queue as they would not be
* meaningful. This will improve the behavior when using sliders in the GUI.
*
- * @param SendCommand
+ * @param sendCommand
* the SendCommand containing the serial number of the device as
* String the channelUID used to send the command and the the
* command data
/**
* Delete a devices from the cube and updates the room information
*
- * @param Device Serial
+ * @param maxDeviceSerial Serial
*/
public void sendDeviceDelete(String maxDeviceSerial) {
Device device = getDevice(maxDeviceSerial);
import org.slf4j.Logger;
/**
- * The {@link: FMessage} contains information about the Cube NTP Configuration
+ * The {@link FMessage} contains information about the Cube NTP Configuration
* This is the response to a f: command
*
* @author Marcel Verpaalen - Initial contribution
private String ntpServer2 = "";
/**
- * The {@link: FMessage} contains information about the Cube NTP Configuration
+ * The {@link FMessage} contains information about the Cube NTP Configuration
*
* @param raw String with raw message
*/
import org.slf4j.LoggerFactory;
/**
- * The {@link: NMessage} contains information about a newly discovered Device
+ * The {@link NMessage} contains information about a newly discovered Device
* This is the response to a n: command
*
* @author Marcel Verpaalen - Initial contribution
private String serialnr = "";
/**
- * The {@link: NMessage} contains information about a newly discovered Device
+ * The {@link NMessage} contains information about a newly discovered Device
*
* @param raw String with raw message
*/
*
* This depends also on the roads of a concrete route but this is only a guess without any Route Navigation behind
*
- * @param range
+ * @param s
* @return mapping from air-line distance to "real road" distance
*/
public static State guessRangeRadius(QuantityType<?> s) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link meteostickBinding} class defines common constants, which are
+ * The {@link MeteostickBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Chris Jackson - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link MieleBinding} class defines common constants, which are
+ * The {@link MieleBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Karel Goderis - Initial contribution
/**
* The {@link MieleMDNSDiscoveryParticipant} is responsible for discovering Miele XGW3000 Gateways. It uses the central
- * {@link MDNSDiscoveryService}.
+ * {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}.
*
* @author Karel Goderis - Initial contribution
* @author Martin Lepsy - Added check for Miele gateway for cleaner discovery
/**
* This method is called whenever a "property" of the given appliance has changed.
*
- * @param dco the POJO containing the new state of the property
+ * @param dp the POJO containing the new state of the property
*/
void onAppliancePropertyChanged(DeviceProperty dp);
* service.
* @return The authorization URL to which the user is redirected for the log in.
* @throws NoOngoingAuthorizationException if there is no ongoing authorization.
- * @throws OAuthException if the authorization URL cannot be determined. In this case the ongoing authorization is
+ * @throws org.openhab.core.auth.client.oauth2.OAuthException if the authorization URL cannot be determined. In this
+ * case the ongoing authorization is
* cancelled.
*/
String getAuthorizationUrl(String redirectUri);
* @param redirectUrlWithParameters The URL the remote service redirected the user to. This is the URL our servlet
* was called with.
* @throws NoOngoingAuthorizationException if there is no ongoing authorization.
- * @throws OAuthException if the authorization failed. In this case the ongoing authorization is cancelled.
+ * @throws org.openhab.core.auth.client.oauth2.OAuthException if the authorization failed. In this case the ongoing
+ * authorization is cancelled.
*/
void completeAuthorization(String redirectUrlWithParameters);
*
* @param email E-mail address for which the access token is requested.
* @return The access token.
- * @throws OAuthException if the access token cannot be obtained.
+ * @throws org.openhab.core.auth.client.oauth2.OAuthException if the access token cannot be obtained.
*/
String getAccessToken(String email);
}
/**
* Updates the device action state channels.
*
- * @param action The {@link ActionsChannelState} information to update the action channel states with.
+ * @param actions The {@link ActionsChannelState} information to update the action channel states with.
*/
protected abstract void updateActionState(ActionsChannelState actions);
}
/**
* Invoked when a new process action is available for a device.
*
- * @param ActionsState The action state information.
+ * @param actionState The action state information.
*/
void onProcessActionUpdated(ActionsState actionState);
* Performs a PUT operation setting the active program.
*
* @param deviceId ID of the device to trigger the action for.
- * @param program The program to activate.
+ * @param programId The program to activate.
* @throws MieleWebserviceException if an error occurs during webservice requests or content parsing.
* @throws AuthorizationFailedException if the authorization against the webservice failed.
* @throws TooManyRequestsException if too many requests have been made against the webservice recently.
@NonNullByDefault
public enum ProcessAction {
/**
- * {@StateType} for unknown states.
+ * {@link StateType} for unknown states.
*/
UNKNOWN,
* Saves string to file in userdata folder
*
* @param filename
- * @param string with content
+ * @param data String with content
* @param logger
*/
public static void saveToFile(String filename, String data, Logger logger) {
/**
* Generate signature for the request.
*
- * @param method http request method. GET or POST
* @param requestUrl the full request url. e.g.: http://api.xiaomi.com/getUser?id=123321
+ * @param signedNonce secret key for encryption.
+ * @param nonce
* @param params request params. This should be a TreeMap because the
* parameters are required to be in lexicographic order.
- * @param signedNonce secret key for encryption.
* @return hash value for the values provided
* @throws MiIoCryptoException
*/
* between [] brackets. This to allow for unimplemented commands to be executed
*
* @param commandString command to be executed
- * @param cloud server to be used or empty string for direct sending to the device
+ * @param cloudServer server to be used or empty string for direct sending to the device
* @return message id
*/
protected int sendCommand(String commandString, String cloudServer) {
* Sends commands to the {@link MiIoAsyncCommunication} for transmission to the Mi devices or cloud
*
* @param command (method) to be queued for execution
- * @param parameters to be send with the command
- * @param cloud server to be used or empty string for direct sending to the device
- * @param sending subdevice or empty string for regular device
+ * @param params to be send with the command
+ * @param cloudServer server to be used or empty string for direct sending to the device
+ * @param sender subdevice or empty string for regular device
* @return message id
*/
protected int sendCommand(String command, String params, String cloudServer, String sender) {
/**
* Enum of the unitTypes used in the miio protocol
- * Used to find the right {@link javax.measure.unitType} given the string of the unitType
+ * Used to find the right {@link javax.measure.Unit} given the string of the unitType
*
* @author Marcel Verpaalen - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link MilightBinding} class defines common constants, which are
+ * The {@link MilightBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author David Graeff - Initial contribution
/**
* Send a discover message and resends the message until either a valid response
* is received or the resend counter reaches the maximum attempts.
- *
- * @param scheduler The scheduler is used for resending.
- * @throws SocketException
*/
public void startDiscoveryService() {
// Do nothing if there is already a discovery running
/**
* Creates a connection and other supportive objects.
- *
- * @param addr
*/
protected abstract void startConnectAndKeepAlive();
import java.net.DatagramSocket;
import java.net.InetAddress;
-import java.net.SocketException;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* A bulb always belongs to a zone in the milight universe and we need a way to queue commands for being send.
*
- * @param typeOffset Each bulb type including its zone has to be unique. To realise this, each type has an offset.
+ * @param thing
* @param sendQueue The send queue.
- * @param zone A zone, usually 0 means all bulbs of the same type. [0-4]
- * @throws SocketException
+ * @param typeOffset Each bulb type including its zone has to be unique. To realise this, each type has an offset.
*/
public AbstractLedHandler(Thing thing, QueuedSend sendQueue, int typeOffset) {
super(thing);
* with our own client session bytes included.
*
* The response will assign as session bytes that we can use for subsequent commands
- * see {@link MilightV6SessionManager#sid1} and see {@link MilightV6SessionManager#sid2}.
+ * see {@link MilightV6SessionManager#clientSID1} and see {@link MilightV6SessionManager#clientSID2}.
*
* We register ourself to the bridge now and finalise the handshake by sending a register command
- * see {@link MilightV6SessionManager#sendRegistration()} to the bridge.
+ * see {@link #sendRegistration(DatagramSocket)} to the bridge.
*
* From this point on we are required to send keep alive packets to the bridge every ~10sec
* to keep the session alive. Because each command we send is confirmed by the bridge, we know if
* A session manager for the V6 bridge needs a way to send data (a QueuedSend object), the destination bridge ID, a
* scheduler for timeout timers and optionally an observer for session state changes.
*
- * @param sendQueue A send queue. Never remove or change that object while the session manager is still working.
* @param bridgeId Destination bridge ID. If the bridge ID for whatever reason changes, you need to create a new
* session manager object
- * @param scheduler A framework scheduler to create timeout events.
* @param observer Get notifications of state changes
* @param destIP If you know the bridge IP address, provide it here.
* @param port The bridge port
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link MinecraftBinding} class defines common constants, which are
+ * The {@link MinecraftBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Mattias Markehed - Initial contribution
/**
* Set the player name.
*
- * @param player name
+ * @param name player name
*/
public void setName(String name) {
this.playerName = name;
/**
* Set the host used to connect to server.
*
- * @param port host port
+ * @param hostname host port
*/
public void setHostname(String hostname) {
this.hostname = hostname;
/**
* Set the sign text to listen for.
*
- * @param sign text.
+ * @param name sign text.
*/
public void setName(String name) {
this.signName = name;
/**
* The {@link MinecraftMDNSDiscoveryParticipant} is responsible for discovering Minecraft servers
- * {@link MDNSDiscoveryService}.
+ * {@link org.openhab.core.config.discovery.mdns.internal.MDNSDiscoveryService}.
*
* @author Mattias Markehed - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * The {@link InfoBlockCallback} class receives callbacks from modbus poller
+ * The {@link Parser} class receives callbacks from modbus poller
*
* @author Bernd Weymann - Initial contribution
*/
*
* @param variableName The variable name
* @param value The new value
- * @return The value if the transaction succeeded, <tt>null</tt> otherwise
* @throws HeliosException Thrown if the variable is read-only or the provided value is out of range
*/
public void writeValue(String variableName, String value) throws HeliosException, InterruptedException {
* Read a variable from the Helios device
*
* @param variableName The variable name
- * @return The value
*/
public void readValue(String variableName) {
Map<String, HeliosVariable> variableMap = this.variableMap;
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link Modbus.StiebelEltronBindingConstants} class defines common
+ * The {@link StiebelEltronBindingConstants} class defines common
* constants, which are used across the whole binding.
*
* @author Paul Frank - Initial contribution
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link Modbus.StiebelEltronConfiguration} class contains fields mapping
+ * The {@link StiebelEltronConfiguration} class contains fields mapping
* thing configuration parameters.
*
* @author Paul Frank - Initial contribution
import org.osgi.service.component.annotations.Component;
/**
- * The {@link Modbus.StiebelEltronHandlerFactory} is responsible for creating things and thing
+ * The {@link StiebelEltronHandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Paul Frank - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link Modbus.StiebelEltronHandler} is responsible for handling commands,
+ * The {@link StiebelEltronHandler} is responsible for handling commands,
* which are sent to one of the channels and for polling the modbus.
*
* @author Paul Frank - Initial contribution
* Instances of this handler should get a reference to the modbus manager
*
* @param thing the thing to handle
- * @param modbusManager the modbus manager
*/
public StiebelEltronHandler(Thing thing) {
super(thing);
* Instances of this handler
*
* @param thing the thing to handle
- * @param type the type of thing to handle
- * @param slaveAddress the address of thing
- * @param refreshSec the address of thing
*/
public StuderHandler(Thing thing) {
super(thing);
* The register array is first parsed, then each of the channels are updated
* to the new values
*
- * @param n register readed
+ * @param registerNumber register readed
* @param registers byte array read from the modbus slave
*/
protected void handlePolledData(int registerNumber, ModbusRegisterArray registers) {
/**
* Start model detection
*
- * @param uid the thing type to look for
* @throws EndpointNotInitializedException
*/
public void detectModel() {
* Instances of this handler should get a reference to the modbus manager
*
* @param thing the thing to handle
- * @param managerRef the modbus manager
*/
public AbstractSunSpecHandler(Thing thing) {
super(thing);
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link ModbusBinding} class defines some constants
+ * The {@link ModbusBindingConstants} class defines some constants
* public that might be used from other bundles as well.
*
* @author Sami Salonen - Initial contribution
* Running bridges have a ModbusThingHandlerDiscoveryService connected
* which will be responsible for the discovery
*
- * @param handler the Modbus bridge handler
+ * @param service discovery service
*/
@Reference(cardinality = ReferenceCardinality.MULTIPLE, policy = ReferencePolicy.DYNAMIC)
protected void addModbusEndpoint(ModbusThingHandlerDiscoveryService service) {
/**
* Remove an already registered thing handler discovery component
*
- * @param handler the handler that has been removed
+ * @param service discovery service
*/
protected void removeModbusEndpoint(ModbusThingHandlerDiscoveryService service) {
logger.trace("Removed handler: {}", service);
* @param request request to send
* @param pollPeriodMillis poll interval, in milliseconds
* @param initialDelayMillis initial delay before starting polling, in milliseconds
- * @param callback callback to call with data
- * @param callback callback to call in case of failure
+ * @param resultCallback callback to call with data
+ * @param failureCallback callback to call in case of failure
* @return poll task representing the regular poll
* @throws IllegalStateException when this communication has been closed already
*/
* background.
*
* @param request request to send
- * @param callback callback to call with data
- * @param callback callback to call in case of failure
+ * @param resultCallback callback to call with data
+ * @param failureCallback callback to call in case of failure
* @return future representing the polled task
* @throws IllegalStateException when this communication has been closed already
*/
* background.
*
* @param request request to send
- * @param callback callback to call with response
- * @param callback callback to call in case of failure
+ * @param resultCallback callback to call with response
+ * @param failureCallback callback to call in case of failure
* @return future representing the task
* @throws IllegalStateException when this communication has been closed already
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link ModbusBinding} class defines common constants, which are
+ * The {@link ModbusBindingConstantsInternal} class defines common constants, which are
* used across the whole binding.
*
* @author Sami Salonen - Initial contribution
*
* @param context
* @param types types to used to parse the transformation result
- * @param command
+ * @param state
* @return Transformed command, or null if no transformation was possible
*/
default @Nullable State transformState(BundleContext context, List<Class<? extends State>> types, State state) {
/**
* Get the status of a zone
*
- * @param zone the zone to query for current status
+ * @param zoneId the zone to query for current status
*
* @throws MonopriceAudioException - In case of any problem
*/
* Monoprice 31028 and OSD Audio PAM1270 amps do not report treble, bass and balance with the main status inquiry,
* so we must send three extra commands to retrieve those values
*
- * @param zone the zone to query for current treble, bass and balance status
+ * @param zoneId the zone to query for current treble, bass and balance status
*
* @throws MonopriceAudioException - In case of any problem
*/
import org.slf4j.LoggerFactory;
/**
- * The {@link @MPDActions} defines rule actions for the Music Player Daemon binding.
+ * The {@link MPDActions} defines rule actions for the Music Player Daemon binding.
*
* @author Stefan Röllin - Initial contribution
*/
/**
* Constructor
*
- * @param address the IP address of the music player daemon
- * @param port the TCP port to be used
- * @param password the password to connect to the music player daemon
+ * @param listener
*/
public MPDConnection(MPDEventListener listener) {
this.listener = listener;
* The channel is of kind Trigger.
*
* @param channelUID The channel uid
- * @param value The new value. Doesn't necessarily need to be different than the value before.
+ * @param eventPayload The new value. Doesn't necessarily need to be different than the value before.
*/
void triggerChannel(ChannelUID channelUID, String eventPayload);
}
* To automatically subscribe to all fields, a call to
* {@link #subscribeAndReceive(MqttBrokerConnection, ScheduledExecutorService, String, AttributeChanged, int)} is
* required.
- * Unsubscribe with a call to {@link #unsubscribe(AbstractMqttAttributeClass)}.
+ * Unsubscribe with a call to {@link #unsubscribe()}.
* </p>
*
* <p>
/**
* Unsubscribe from all topics of the managed object.
*
- * @param connection A broker connection to remove the subscriptions from.
- * @param objectWithFields A bean class
* @return Returns a future that completes as soon as all unsubscriptions have been performed.
*/
public CompletableFuture<@Nullable Void> unsubscribe() {
/**
* Modifies the map in way that it matches the entries of the given childIDs.
*
- * @param future A future that completes as soon as all children have their added-action performed.
* @param childIDs The list of IDs that should be in the map. Everything else currently in the map will be removed.
* @param addedAction A function where the newly added child is given as an argument to perform any actions on it.
* A future is expected as a return value that completes as soon as said action is performed.
* expected as a
* result.
* @param removedCallback A callback, that is called whenever a child got removed by the
- * {@link #apply(CompletableFuture, String[], Function)} method.
+ * {@link #apply(String[], Function, Function, Consumer)} method.
* @return Complete successfully if all "addedAction" complete successfully, otherwise complete exceptionally.
*/
public CompletableFuture<@Nullable Void> apply(String[] childIDs,
* Return the topic to put into the HandlerConfiguration for this component.
* <p>
* <code>objectid</code> in the thing configuration will be
- * <code>nodeID/objectID<code> from the HaID, if <code>nodeID</code> is not empty.
+ * <code>nodeID/objectID</code> from the HaID, if <code>nodeID</code> is not empty.
* <p>
*
* @return the short topic.
/**
* Homie 3.x Device. This is also the base class to subscribe to and parse a homie MQTT topic tree.
- * First use {@link #subscribe(AbstractMqttAttributeClass)} to subscribe to the device/nodes/properties tree.
- * If everything has been received and parsed, call {@link #startChannels(MqttBrokerConnection, HomieThingHandler)}
+ * First use {@link #subscribe(MqttBrokerConnection, ScheduledExecutorService, int)}
+ * to subscribe to the device/nodes/properties tree.
+ * If everything has been received and parsed, call
+ * {@link #startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)}
* to also subscribe to the property values. Usage:
*
* <pre>
* and subscribe to all node attributes. Parse node properties. This will not subscribe
* to properties though. If subscribing to all necessary topics worked {@link #isInitialized()} will return true.
*
- * Call {@link #startChannels(MqttBrokerConnection)} subsequently.
+ * Call {@link #startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)} subsequently.
*
* @param connection A broker connection
* @param scheduler A scheduler to realize the timeout
/**
* <p>
* The nodes of a device are determined by the device attribute "$nodes". If that attribute changes,
- * {@link #attributeChanged(CompletableFuture, String, Object, MqttBrokerConnection, ScheduledExecutorService)} is
+ * {@link #attributeChanged(String, Object, MqttBrokerConnection, ScheduledExecutorService, boolean)} is
* called. The {@link #nodes} map will be synchronized and this method will be called for every removed node.
* </p>
*
/**
* Called, whenever a Homie property was existing before, but is not anymore.
*
- * @param node The affected property class.
+ * @param property The affected property class.
*/
void propertyRemoved(Property property);
/**
* Called, whenever a Homie property was added or changed.
*
- * @param node The affected property class.
+ * @param property The affected property class.
*/
void propertyAddedOrChanged(Property property);
}
/**
* Parse node properties. This will not subscribe to properties though. Call
- * {@link Device#startChannels(MqttBrokerConnection)} as soon as the returned future has
- * completed.
+ * {@link Device#startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)}
+ * as soon as the returned future has completed.
*/
public CompletableFuture<@Nullable Void> subscribe(MqttBrokerConnection connection,
ScheduledExecutorService scheduler, int timeout) {
/**
* Unsubscribe from node attribute and also all property attributes and the property value
*
- * @param connection A broker connection
* @return Returns a future that completes as soon as all unsubscriptions have been performed.
*/
public CompletableFuture<@Nullable Void> stop() {
/**
* <p>
* The properties of a node are determined by the node attribute "$properties". If that attribute changes,
- * {@link #attributeChanged(CompletableFuture, String, Object, MqttBrokerConnection, ScheduledExecutorService)} is
+ * {@link #attributeChanged(String, Object, MqttBrokerConnection, ScheduledExecutorServic, boolean)} is
* called. The {@link #properties} map will be synchronized and this method will be called for every removed
* property.
* </p>
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.mqtt.generic.ChannelConfigBuilder;
import org.openhab.binding.mqtt.generic.ChannelState;
-import org.openhab.binding.mqtt.generic.mapping.AbstractMqttAttributeClass;
import org.openhab.binding.mqtt.generic.mapping.AbstractMqttAttributeClass.AttributeChanged;
import org.openhab.binding.mqtt.generic.mapping.ColorMode;
import org.openhab.binding.mqtt.generic.values.ColorValue;
/**
* Subscribe to property attributes. This will not subscribe
- * to the property value though. Call {@link Device#startChannels(MqttBrokerConnection)} to do that.
+ * to the property value though. Call
+ * {@link Device#startChannels(MqttBrokerConnection, ScheduledExecutorService, int, HomieThingHandler)}
+ * to do that.
*
* @return Returns a future that completes as soon as all attribute values have been received or requests have timed
* out.
/**
* @return Returns the channelState. You should have called
- * {@link Property#subscribe(AbstractMqttAttributeClass, int)}
+ * {@link Property#subscribe(MqttBrokerConnection, ScheduledExecutorService, int)}
* and waited for the future to complete before calling this Getter.
*/
public @Nullable ChannelState getChannelState() {
* @param connection A broker connection
* @param scheduler A scheduler to realize the timeout
* @param timeout A timeout in milliseconds. Can be 0 to disable the timeout and let the future return earlier.
- * @param channelStateUpdateListener An update listener
* @return A future that completes with true if the subscribing worked and false and/or exceptionally otherwise.
*/
public CompletableFuture<@Nullable Void> startChannel(MqttBrokerConnection connection,
}
/**
- * This method gets called by the {@link PinningSSLContextProvider} if a new public key
+ * This method gets called by the {@link PinTrustManager} if a new public key
* or certificate hash got pinned. The hash is stored in the thing configuration.
*/
@Override
@Override
public void pinnedConnectionDenied(Pin pin) {
- // We don't need to handle this here, because the {@link PinningSSLContextProvider}
+ // We don't need to handle this here, because the {@link PinTrustManager}
// will throw a CertificateException if the connection fails.
}
/**
* Reads the thing configuration related to public key or certificate pinning, creates an appropriate a
- * {@link PinningSSLContextProvider} and assigns it to the {@link MqttBrokerConnection} instance.
+ * {@link PinTrustManager} and assigns it to the {@link MqttBrokerConnection} instance.
* The instance need to be set before calling this method. If the SHA-256 algorithm is not supported
* by the platform, this method will do nothing.
*
* @throws IllegalArgumentException Throws this exception, if provided hash values cannot be
- * assigned to the {@link PinningSSLContextProvider}.
+ * assigned to the {@link PinTrustManager}.
*/
protected void assignSSLContextProvider(BrokerHandlerConfig config, MqttBrokerConnection connection,
PinnedCallback callback) throws IllegalArgumentException {
/**
* Creates a normal broker thing with an url that will be converted to a thing ID.
*
- * @param url The broker connection url
+ * @param host The broker connection (host name)
+ * @param port The port
* @return Returns a ThingUID
*/
public static ThingUID getThingUID(String host, int port) {
* Get all field names from a DTO with a specific value
* Used to get e.g. all services which are "ACTIVATED"
*
- * @param DTO Object
+ * @param dto Object
* @param compare String which needs to map with the value
* @return String with all field names matching this value separated with Spaces
*/
* 3) take a guess from fuel indicators
*
* @param unitJson
- * @param indicators
+ * @param vehicle
* @return
*/
public static int getRange(String unitJson, Vehicle vehicle) {
* -- smaller one is assigned to fuel range
* -- bigger one is assigned to hybrid range
*
- * @see VehicleStatusTest testGuessRange
+ * @see org.openhab.binding.mybmw.internal.dto.VehicleStatusTest testGuessRange
*
* @param unitJson
* @param vehicle
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link NeatoBinding} class defines common constants, which are
+ * The {@link NeatoBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Patrik Wimnell - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link BeehiveAuthenticcation} is the internal class for handling authentication.
+ * The {@link BeehiveAuthentication} is the internal class for handling authentication.
*
* @author Patrik Wimnell - Initial contribution
*/
* Callback to the bridge/thing to update the state of a channel in the bridge/thing.
*
* @param channelId the non-null, non-empty channel id
- * @param state the new non-null {@State}
+ * @param state the new non-null {@link State}
*/
void stateChanged(String channelId, State state);
* Create wrapper around a JSON string
*
* @param fromJson the JSON string
- * @return a NeoHubGetEngData wrapper around the JSON string
* @throws JsonSyntaxException
*
*/
*
* @param homeId The id of home (required)
* @param mode The mode. (required)
- * @throws NetatmoCommunicationException when call failed, e.g. server error or cannot deserialize
+ * @throws NetatmoException when call failed, e.g. server error or cannot deserialize
*/
public void setThermMode(String homeId, String mode) throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_SET_THERM_MODE, PARAM_HOME_ID, homeId, PARAM_MODE, mode);
* @param mode The mode. (required)
* @param endtime For manual or max setpoint_mode, defines when the setpoint expires.
* @param temp For manual setpoint_mode, defines the temperature setpoint (in °C)
- * @throws NetatmoCommunicationException when call failed, e.g. server error or cannot deserialize
+ * @throws NetatmoException when call failed, e.g. server error or cannot deserialize
*/
public void setThermpoint(String homeId, String roomId, SetpointMode mode, long endtime, double temp)
throws NetatmoException {
* Compute the associated scale appreciation of a given humidex index
* https://www.researchgate.net/figure/The-scale-of-Humidex-and-the-degree-of-comfort_tbl1_335293174
*
- * @param Humidex index value
+ * @param humidex index value
* @return scale between 0 and 4
*/
public static int humidexScale(double humidex) {
/**
* Returns the value - possibly from the cache, if it is still valid.
*
- * @return the value
+ * @param callback callback to return the value
*/
public void getValue(Consumer<V> callback) {
if (isExpired()) {
package org.openhab.binding.nibeheatpump.internal.config;
/**
- * Configuration class for {@link NibeHeatPumpBinding} device.
+ * Configuration class for NibeHeatPump device.
*
*
* @author Pauli Anttila - Initial contribution
import org.openhab.core.thing.Channel;
/**
- * generic command that retrieves status values for all channels defined in {@link VVM320Channels}
+ * generic command that retrieves status values for all channels defined in VVM320Channels
*
* @author Alexander Friese - initial contribution
*/
/**
* Constructor to set up interface
- *
- * @param config the Bridge configuration
*/
public UplinkWebInterface(ScheduledExecutorService scheduler, NibeUplinkHandler handler, HttpClient httpClient) {
this.uplinkHandler = handler;
@NonNullByDefault
public interface NibeUplinkHandler extends ThingHandler, ChannelProvider {
/**
- * Called from {@link NibeUplinkWebInterface#authenticate()} to update
- * the thing status because updateStatus is protected.
+ * Called from
+ * {@link org.openhab.binding.nibeuplink.internal.connector.UplinkWebInterface.WebRequestExecutor#authenticate()}
+ * to update the thing status because updateStatus is protected.
*
* @param status Bridge status
* @param statusDetail Bridge status detail
}
/**
- * This method should be called when an object implementing the {@NhcActionEvent} interface is initialized.
+ * This method should be called when an object implementing the {@link NhcActionEvent} interface is initialized.
* It keeps a record of the event handler in that object so it can be updated when the action receives an update
* from the Niko Home Control IP-interface.
*
}
/**
- * This method should be called when an object implementing the {@NhcActionEvent} interface is disposed.
+ * This method should be called when an object implementing the {@link NhcActionEvent} interface is disposed.
* It resets the reference, so no updates go to the handler anymore.
*
*/
/**
* This method is called when a notice event is received from the Niko Home Control controller.
*
- * @param alarmText
+ * @param noticeText
*/
void noticeEvent(String noticeText);
}
/**
- * This method should be called when an object implementing the {@NhcEnergyMeterEvent} interface is initialized.
+ * This method should be called when an object implementing the {@link NhcEnergyMeterEvent} interface is
+ * initialized.
* It keeps a record of the event handler in that object so it can be updated when the action receives an update
* from the Niko Home Control IP-interface.
*
}
/**
- * This method should be called when an object implementing the {@NhcEnergyMeterEvent} interface is disposed.
+ * This method should be called when an object implementing the {@link NhcEnergyMeterEvent} interface is disposed.
* It resets the reference, so no updates go to the handler anymore.
*
*/
}
/**
- * This method should be called when an object implementing the {@NhcThermostatEvent} interface is initialized.
+ * This method should be called when an object implementing the {@link NhcThermostatEvent} interface is initialized.
* It keeps a record of the event handler in that object so it can be updated when the action receives an update
* from the Niko Home Control IP-interface.
*
}
/**
- * This method should be called when an object implementing the {@NhcThermostatEvent} interface is disposed.
+ * This method should be called when an object implementing the {@link NhcThermostatEvent} interface is disposed.
* It resets the reference, so no updates go to the handler anymore.
*
*/
* {@link NhcThermostat2}.
*
* @param overrule temperature to overrule the setpoint in 0.1°C multiples
- * @param time time duration in min for overrule
+ * @param overruletime time duration in min for overrule
*/
public abstract void executeOverrule(int overrule, int overruletime);
/**
* Return all actions in the Niko Home Control Controller.
*
- * @return <code>Map<String, {@link NhcAction}></code>
+ * @return <code>Map<String, {@link NhcAction}></code>
*/
public Map<String, NhcAction> getActions() {
return actions;
/**
* Return all thermostats in the Niko Home Control Controller.
*
- * @return <code>Map<String, {@link NhcThermostat}></code>
+ * @return <code>Map<String, {@link NhcThermostat}></code>
*/
public Map<String, NhcThermostat> getThermostats() {
return thermostats;
/**
* Return all energyMeters meters in the Niko Home Control Controller.
*
- * @return <code>Map<String, {@link NhcEnergyMeter}></code>
+ * @return <code>Map<String, {@link NhcEnergyMeter}></code>
*/
public Map<String, NhcEnergyMeter> getEnergyMeters() {
return energyMeters;
* Sends thermostat setpoint to Niko Home Control.
*
* @param overrule temperature to overrule the setpoint in 0.1°C multiples
- * @param time time duration in min for overrule
+ * @param overruletime time duration in min for overrule
*/
@Override
public void executeOverrule(int overrule, int overruletime) {
* Niko Home Control II Connected Controller.
*
* @throws CertificateException when the SSL context for MQTT communication cannot be created
- * @throws UnknownHostException when the IP address is not provided
+ * @throws java.net.UnknownHostException when the IP address is not provided
*
*/
public NikoHomeControlCommunication2(NhcControllerEvent handler, String clientId,
*
* @param mode the {@link WorkMode} if we want to use polling or reporting
* @param interval the time between polling or reportings
- * @return {@code true} if we can communicate with the device
* @throws PortInUseException
* @throws TooManyListenersException
* @throws IOException
}
/**
- * Gets the first byte from the data bytes (usually holds the {@link Command}) as a form of some sub command
+ * Gets the first byte from the data bytes (usually holds the
+ * {@link org.openhab.binding.novafinedust.internal.sds011protocol.Command}) as a form of some sub command
*
* @return first byte from the data section of a reply
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link ntpBinding} class defines common constants, which are used across
+ * The {@link NtpBindingConstants} class defines common constants, which are used across
* the whole binding.
*
* @author Marcel Verpaalen - Initial contribution
* handlers.
*
* @author Markus Katter - Initial contribution
- * @contributer Jan Vybíral - Improved thing id generation
+ * @author Jan Vybíral - Improved thing id generation
*/
@Component(service = ThingHandlerFactory.class, configurationPid = "binding.nuki")
@NonNullByDefault
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link NukiBinding} class defines common constants, which are
+ * The {@link NukiBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Markus Katter - Initial contribution
- * @contributer Christian Hoefler - Door sensor integration
- * @contributer Jan Vybíral - Opener integration
+ * @author Christian Hoefler - Door sensor integration
+ * @author Jan Vybíral - Opener integration
*/
@NonNullByDefault
public class NukiBindingConstants {
* The {@link BridgeLockStateResponse} class wraps {@link BridgeApiLockStateDto} class.
*
* @author Markus Katter - Initial contribution
- * @contributer Christian Hoefler - Door sensor integration
+ * @author Christian Hoefler - Door sensor integration
*/
public class BridgeLockStateResponse extends NukiBaseResponse {
* The {@link NukiApiServlet} class is responsible for handling the callbacks from the Nuki Bridge.
*
* @author Markus Katter - Initial contribution
- * @contributer Christian Hoefler - Door sensor integration
- * @contributer Jan Vybíral - Added Opener support, improved callback handling
+ * @author Christian Hoefler - Door sensor integration
+ * @author Jan Vybíral - Added Opener support, improved callback handling
*/
@NonNullByDefault
public class NukiApiServlet extends HttpServlet {
* The {@link NukiHttpClient} class is responsible for getting data from the Nuki Bridge.
*
* @author Markus Katter - Initial contribution
- * @contributer Jan Vybíral - Hashed token authentication
+ * @author Jan Vybíral - Hashed token authentication
*/
@NonNullByDefault
public class NukiHttpClient {
* endpoint.
*
* @author Markus Katter - Initial contribution
- * @contributer Christian Hoefler - Door sensor integration
+ * @author Christian Hoefler - Door sensor integration
*/
public class BridgeApiLockStateDto extends BridgeApiDeviceStateDto {
private boolean success;
* Bridge to the openHAB Server.
*
* @author Markus Katter - Initial contribution
- * @contributer Christian Hoefler - Door sensor integration
+ * @author Christian Hoefler - Door sensor integration
*/
public class BridgeApiLockStateRequestDto extends BridgeApiDeviceStateDto {
* sent to one of the channels.
*
* @author Markus Katter - Initial contribution
- * @contributer Jan Vybíral - Improved callback handling
+ * @author Jan Vybíral - Improved callback handling
*/
@NonNullByDefault
public class NukiBridgeHandler extends BaseBridgeHandler {
* sent to one of the channels.
*
* @author Markus Katter - Initial contribution
- * @contributer Christian Hoefler - Door sensor integration
- * @contributer Jan Vybíral - Refactoring, added more channels
+ * @author Christian Hoefler - Door sensor integration
+ * @author Jan Vybíral - Refactoring, added more channels
*/
@NonNullByDefault
public class NukiSmartLockHandler extends AbstractNukiDeviceHandler<NukiSmartLockConfiguration> {
/**
* Tell the connector if the device is an Essentia G or not
*
- * @param true if the device is an Essentia G
+ * @param isEssentia true if the device is an Essentia G
*/
public void setEssentia(boolean isEssentia) {
this.isEssentia = isEssentia;
/**
* Tell the connector to listen for NuvoNet source messages
*
- * @param true if any sources are configured as openHAB NuvoNet sources
+ * @param isAnyOhNuvoNet true if any sources are configured as openHAB NuvoNet sources
*/
public void setAnyOhNuvoNet(boolean isAnyOhNuvoNet) {
this.isAnyOhNuvoNet = isAnyOhNuvoNet;
/**
* Handle an event received from the Nuvo device
*
- * @param event the event to process
+ * @param evt the event to process
*/
@Override
public void onNewMessageEvent(NuvoMessageEvent evt) {
import org.slf4j.LoggerFactory;
/**
- * The {@link WebClient} class contains the logic to get data from a URL.
+ * The {@link WaterAlertWebClient} class contains the logic to get data from a URL.
*
* @author Stewart Cossey - Initial contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link WebService} class contains the common interfaces for the different
+ * The {@link WaterWebService} class contains the common interfaces for the different
* services.
*
* @author Stewart Cossey - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link NZWaterAlertsController} is responsible for handling the connection
+ * The {@link NZWaterAlertsBinder} is responsible for handling the connection
* between the handler and API.
*
* @author Stewart Cossey - Initial contribution
import org.openhab.core.thing.ThingStatusDetail;
/**
- * The {@link NZWaterAlertsControllerListener} is responsible for handling the events from the WebClient and Handler.
+ * # * The {@link NZWaterAlertsBinderListener} is responsible for handling the events from the WebClient and Handler.
*
* @author Stewart Cossey - Initial contribution
*/
*/
package org.openhab.binding.oceanic.internal;
-import java.io.InvalidClassException;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.openhab.core.types.Type;
/**
- * The {@link OceanicBinding} class defines common constants, which are used
+ * The {@link OceanicBindingConstants} class defines common constants, which are used
* across the whole binding.
*
* @author Karel Goderis - Initial contribution
*
* @param valueSelectorText selector string e.g. RawData, Command, Temperature
* @return corresponding selector value.
- * @throws InvalidClassException Not valid class for value selector.
+ * @throws IllegalArgumentException Not valid class for value selector.
*/
public static OceanicChannelSelector getValueSelector(String valueSelectorText,
ValueSelectorType valueSelectorType) throws IllegalArgumentException {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link OJElectronicsBindingConstants} class defines common constants, which are
+ * The {@link BindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Christian Kittel - Initial contribution
import org.osgi.service.component.annotations.Reference;
/**
- * The {@link ThermostatHandlerFactory} is responsible for creating {@link OJElectronicsThermostatHandler}.
+ * The {@link ThermostatHandlerFactory} is responsible for creating {@link ThermostatHandler}.
*
* @author Christian Kittel - Initial contribution
*/
/**
* Creates a new factory
*
- * @param httpClientFactory Factory for HttpClient
+ * @param timeZoneProvider
*/
@Activate
public ThermostatHandlerFactory(@Reference TimeZoneProvider timeZoneProvider) {
/**
* Gets a correct initialized {@link Gson}
*
- * @return {@link GSon}
+ * @return {@link com.google.gson.GSon}
*/
public static Gson getGSon() {
return new GsonBuilder().setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).setPrettyPrinting()
import org.eclipse.jdt.annotation.Nullable;
/**
- * The configuration for {@link org.openhab.binding.ojelectronics.internal.OJElectronicsCloudHandler}
+ * The configuration for {@link org.openhab.binding.ojelectronics.internal.OJCloudHandler}
*
* @author Christian Kittel - Initial contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The configuration for {@link org.openhab.binding.ojelectronics.internal.OJElectronicsThermostatHandler}
+ * The configuration for {@link org.openhab.binding.ojelectronics.internal.ThermostatHandler}
*
* @author Christian Kittel - Initial contribution
*/
*
* @param config Configuration of the bridge
* @param httpClient HTTP client
- * @param updateService Service to update the thermostat in the cloud
*/
public RefreshService(OJElectronicsBridgeConfiguration config, HttpClient httpClient) {
this.config = config;
*
* @param sessionId Session-Id
* @param refreshDone This method is called if refreshing is done.
- * @param connectionLosed This method is called if no connection could established.
+ * @param connectionLost This method is called if no connection could established.
* @param unauthorized This method is called if the result is unauthorized.
*/
public void start(String sessionId,
/**
* Calculate the area filter the a supplied area
*
- * @param area Area to calculate filter for.
+ * @param areaProperties Area to calculate filter for.
* @return Calculated Bit Filter for the supplied area. Bit 0 is area 1, bit 2 is area 2 and so on.
*/
protected static int bitFilterForArea(AreaProperties areaProperties) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link OneBusAwayBinding} class defines common constants, which are
+ * The {@link OneBusAwayBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Shawn Wilsher - Initial contribution
/**
* The connection is erroneous and was closed by the {@link OwserverConnection}. After due wait time, it
* is tried to reopen it by a scheduled task of
- * {@link OwserverBridgeHandler#reportConnectionState(OwserverConnectionState)}.
+ * {@link org.openhab.binding.onewire.internal.handler.OwserverBridgeHandler#reportConnectionState(OwserverConnectionState)}.
*/
FAILED
}
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link OnkyoBinding} class defines common constants, which are
+ * The {@link OnkyoBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Paul Frank - Initial contribution
package org.openhab.binding.onkyo.internal.config;
/**
- * Configuration class for {@link OnkyoBinding} device.
+ * Configuration class for Onkyo device.
*
* @author Pauli Anttila - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link OpenSprinklerBinding} class defines common constants, which are
+ * The {@link OpenSprinklerBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Chris Graham - Initial contribution
/**
* Enters the "manual" mode of the device so that API requests are accepted.
*
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws UnauthorizedApiException
*/
void enterManualMode() throws CommunicationApiException, UnauthorizedApiException;
/**
* Disables the manual mode, if it is enabled.
*
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws UnauthorizedApiException
*/
void leaveManualMode() throws CommunicationApiException, UnauthorizedApiException;
*
* @param station Index of the station to open starting at 0.
* @param duration The duration in seconds for how long the station should be turned on.
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws GeneralApiException
*/
void openStation(int station, BigDecimal duration) throws CommunicationApiException, GeneralApiException;
* Closes a station on the OpenSprinkler device.
*
* @param station Index of the station to open starting at 0.
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws GeneralApiException
*/
void closeStation(int station) throws CommunicationApiException, GeneralApiException;
*
* @param station Index of the station to open starting at 0.
* @return True if the station is open, false if it is closed or cannot determine.
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws GeneralApiException
*/
boolean isStationOpen(int station) throws CommunicationApiException, GeneralApiException;
*
* @param station Index of the station to request data from
* @return StationProgram
- * @throws Exception
+ * @throws CommunicationApiException
*/
StationProgram retrieveProgram(int station) throws CommunicationApiException;
* Returns the state of rain detection on the OpenSprinkler device.
*
* @return True if rain is detected, false if not or cannot determine.
- * @throws Exception
*/
boolean isRainDetected();
* Returns the firmware version number.
*
* @return The firmware version of the OpenSprinkler device as an int.
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws UnauthorizedApiException
*/
int getFirmwareVersion() throws CommunicationApiException, UnauthorizedApiException;
/**
* Runs a Program that is setup and stored inside the OpenSprinkler
*
- * @param Program index number that you wish to run.
+ * @param command Program index number that you wish to run.
*
* @throws CommunicationApiException
* @throws UnauthorizedApiException
* Factory method used to determine what version of the API is in use at the
* OpenSprinkler API and return the proper class for control of the device.
*
- * @param hostname Hostname or IP address as a String of the OpenSprinkler device.
- * @param port The port number the OpenSprinkler API is listening on.
- * @param password Admin password for the OpenSprinkler device.
- * @param basicUsername Used when basic auth is required
- * @param basicPassword Used when basic auth is required
+ * @param config Interface settings
* @return OpenSprinkler HTTP API class for control of the device.
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws GeneralApiException
*/
public OpenSprinklerApi getHttpApi(OpenSprinklerHttpInterfaceConfig config)
throws CommunicationApiException, GeneralApiException {
/**
* {@inheritDoc}
*
- * @throws Exception
+ * @throws CommunicationApiException
+ * @throws UnauthorizedApiException
*/
@Override
public void enterManualMode() throws CommunicationApiException, UnauthorizedApiException {
*
* @param returnContent String value of the return content from the OpenSprinkler device when
* an action result is returned from the API.
- * @throws Exception Returns a custom exception based on the result key.
+ * @throws GeneralApiException Returns a custom exception based on the result key.
*/
protected void resultParser(String returnContent) throws GeneralApiException {
int returnCode;
*
* @param where the discovered device's address (WHERE)
* @param deviceType {@link OpenDeviceType} of the discovered device
- * @param message the OWN message received that identified the device
+ * @param baseMsg the OWN message received that identified the device
* (optional)
*/
public void newDiscoveryResult(@Nullable Where where, OpenDeviceType deviceType,
/**
* Search for devices connected to this bridge handler's gateway
- *
- * @param listener to receive device found notifications
*/
public synchronized void searchDevices() {
scanIsActive = true;
/**
* Handle an event received from the Oppo player
*
- * @param event the event to process
+ * @param evt the event to process
*/
@Override
public void onNewMessageEvent(OppoMessageEvent evt) {
/**
* Method to set heat point for pool (true) of spa (false)
*
- * @param Pool pool=true, spa=false
+ * @param pool pool=true, spa=false
* @param temp
*/
public void setPoint(boolean pool, int temp) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link PHCBinding} class defines common constants, which are used across
+ * The {@link PHCBindingConstants} class defines common constants, which are used across
* the whole binding.
*
* @author Jonas Hohaus - Initial contribution
/**
* Convert the byte b into a binary String
*
- * @param b
+ * @param bytes
* @return
*/
public static Object bytesToBinaryString(byte[] bytes) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link PioneerAvrBinding} class defines common constants, which are used across the whole binding.
+ * The {@link PioneerAvrBindingConstants} class defines common constants, which are used across the whole binding.
*
* @author Antoine Besnard - Initial contribution
* @author Leroy Foerster - Listening Mode, Playing Listening Mode
* parse the display status text send from the receiver
*
* @param responsePayload the responses payload, that is without the leading "FL"
- *
- * @return
*/
public DisplayInformation(String responsePayload) {
volumeDisplay = false;
*
* @param command
* @param parameter
- * @param zone
* @return
*/
public static ParameterizedCommand getIpControlCommand(ParameterizedCommandType command, String parameter) {
* Send an MCACC Memory selection command to the AVR based on the openHAB command
*
* @param command
- * @param zone
* @return
*/
boolean sendMCACCMemoryCommand(Command command) throws CommandTypeNotSupportedException;
/**
* Initialize times from the given timestamps
*
- * @param lastReadingDate time of last reading as ZonedDateTime
- * @param lastRefreshTime time of last refresh as ZonedDateTime
+ * @param reading last reading
*/
public MeterState(ReadingInstance reading) {
this.readingValue = reading.getValue();
* Fetch artwork for PS4 application. First looks for the file on disc, if the file is not on the disc it checks
* PlayStation store
*
- * @param titleid Title ID of application.
+ * @param titleId Title ID of application.
* @param size Size (width & height) of art work in pixels , max 1024.
* @param locale Locale used on PlayStation store to find art work.
* @return A JPEG image as a RawType if an art work file is found otherwise null.
* Fetch artwork for PS4 application. First looks for the file on disc, if the file is not on the disc it checks
* PlayStation store
*
- * @param titleid Title ID of application.
+ * @param titleId Title ID of application.
* @param size Size (width & height) of art work in pixels , max 1024.
* @param locale Locale used on PlayStation store to find art work.
* @param forceRefetch When true, tries to re-fetch art work from PlayStation store, sometimes the art work is
/**
* Set Siemens LOGO! blocks update threshold.
*
- * @param force Force update of Siemens LOGO! blocks
+ * @param threshold
*/
public void setThreshold(final Integer threshold) {
this.threshold = threshold;
/**
* Set Siemens LOGO! block name.
*
- * @param name Siemens LOGO! output block name
+ * @param type Siemens LOGO! output block type
*/
public void setBlockType(final String type) {
this.type = type.trim();
/**
* Set Siemens LOGO! blocks update threshold.
*
- * @param force Force update of Siemens LOGO! blocks
+ * @param threshold
*/
public void setThreshold(final Integer threshold) {
this.threshold = threshold;
import org.slf4j.LoggerFactory;
/**
- * The {@link PlexBindingConstants} class defines common constants, which are
- * used across the whole binding.
- *
+ * Handler for Plex Player.
+ *
* @author Brian Homeyer - Initial contribution
* @author Aron Beurskens - Binding development
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link PlugwiseBinding} class defines common constants, which are used across the whole binding.
+ * The {@link PlugwiseBindingConstants} class defines common constants, which are used across the whole binding.
*
* @author Wouter Born - Initial contribution
*/
* The {@link ActuatorFunctionalities} class is an object model class that
* mirrors the XML structure provided by the Plugwise Home Automation controller
* for the collection of actuator functionalities. (e.g. 'offset', 'relay', et
- * cetera). It extends the {@link CustomCollection} class.
+ * cetera). It extends the {@link PlugwiseHACollection} class.
*
* @author B. van Wetten - Initial contribution
*/
/**
* The {@link PlugwiseHABridgeThingConfig} encapsulates all the configuration options for an instance of the
- * {@link PlugwiseHABridgeHandler}.
+ * {@link org.openhab.binding.plugwiseha.internal.handler.PlugwiseHABridgeHandler}.
*
* @author Bas van Wetten - Initial contribution
* @author Leo Siepel - finish initial contribution
/**
* The {@link PlugwiseHAThingConfig} encapsulates the configuration options for
- * an instance of the {@link PlugwiseHAApplianceHandler} and the
- * {@link PlugwiseHAZoneHandler}
+ * an instance of the {@link org.openhab.binding.plugwiseha.internal.handler.PlugwiseHAApplianceHandler}
+ * and the {@link org.openhab.binding.plugwiseha.internal.handler.PlugwiseHAZoneHandler}
*
* @author Bas van Wetten - Initial contribution
* @author Leo Siepel - finish initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link PowermaxBinding} class defines common constants, which are
+ * The {@link PowermaxBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Laurent Garnier - Initial contribution
/**
* Set the start time of the time frame to receive a response
*
- * @param timeLastReceive the time in milliseconds
+ * @param waitingForResponse the time in milliseconds
*/
public synchronized void setWaitingForResponse(long waitingForResponse) {
this.waitingForResponse = waitingForResponse;
/**
* Returns connection status
*
- * @return: true if connected or false if not
+ * @return true if connected or false if not
**/
boolean isConnected();
/**
* Constructor
*
- * @param in the input stream
* @param connector the object that should handle the received message
* @param threadName the name of the thread
*/
* @param panelType the panel type to be used when in standard mode
* @param forceStandardMode true to force the standard mode rather than trying using the Powerlink mode
* @param autoSyncTime true for automatic sync time
- * @param serialPortManager
* @param threadName the prefix name of threads to be created
+ * @param timeZoneProvider
*/
public PowermaxCommManager(String ip, int port, PowermaxPanelType panelType, boolean forceStandardMode,
boolean autoSyncTime, String threadName, TimeZoneProvider timeZoneProvider) {
/**
* Connect to the Powermax alarm system
- *
- * @return true if connected or false if not
*/
public void open() throws Exception {
connector.open();
/**
* Process and store all the panel settings from the raw buffers
*
- * @param PowerlinkMode true if in Powerlink mode or false if in standard mode
+ * @param powerlinkMode true if in Powerlink mode or false if in standard mode
*
* @return true if no problem encountered to get all the settings; false if not
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link PulseaudioBinding} class defines common constants, which are
+ * The {@link PulseaudioBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Tobias Bräutigam - Initial contribution
* retrieves an {@link AbstractAudioDeviceConfig} by its identifier
* If several devices correspond to the deviceIdentifier, returns the first one (aphabetical order)
*
- * @param The device identifier to match against
+ * @param deviceIdentifier The device identifier to match against
* @return the corresponding {@link AbstractAudioDeviceConfig} to the given <code>name</code>
*/
public @Nullable AbstractAudioDeviceConfig getGenericAudioItem(DeviceIdentifier deviceIdentifier) {
/**
* Updates offline status off the Bridge when an error occurs.
*
- * @param status
* @param detail
* @param message
*/
import org.osgi.service.component.annotations.Component;
/**
- * The {@link qbusHandlerFactory} is responsible for creating things and thing
+ * The {@link QbusHandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Koen Schockaert - Initial Contribution
}
/**
- * This method sets a pointer to the qComm BISTABIEL of class {@link QbusCommuncation}.
+ * This method sets a pointer to the qComm BISTABIEL of class {@link QbusCommunication}.
* This is then used to be able to call back the sendCommand method in this class to send a command to the
* Qbus client.
*
}
/**
- * This method sets a pointer to the qComm Dimmer of class {@link QbusCommuncation}.
+ * This method sets a pointer to the qComm Dimmer of class {@link QbusCommunication}.
* This is then used to be able to call back the sendCommand method in this class to send a command to the
* Qbus client.
*
}
/**
- * This method sets a pointer to the qComm Shutter/Slats of class {@link QbusCommuncation}.
+ * This method sets a pointer to the qComm Shutter/Slats of class {@link QbusCommunication}.
* This is then used to be able to call back the sendCommand method in this class to send a command to the
* Qbus IP-interface when..
*
/**
* Update the value of the Shutter.
*
- * @param Shutter value
+ * @param state Shutter value
*/
public void updateState(@Nullable Integer state) {
this.state = state;
/**
* Update the value of the Slats.
*
- * @param Slat value
+ * @param Slats slat value
*/
public void updateSlats(@Nullable Integer Slats) {
this.slats = Slats;
}
/**
- * This method sets a pointer to the qComm SCENE of class {@link QbusCommuncation}.
+ * This method sets a pointer to the qComm SCENE of class {@link QbusCommunication}.
* This is then used to be able to call back the sendCommand method in this class to send a command to the
* Qbus client.
*
}
/**
- * This method sets a pointer to the qComm THERMOSTAT of class {@link QbusCommuncation}.
+ * This method sets a pointer to the qComm THERMOSTAT of class {@link QbusCommunication}.
* This is then used to be able to call back the sendCommand method in this class to send a command to the
* Qbus client.
*
package org.openhab.binding.qolsysiq.internal.client.dto.action;
/**
- * An {@link ActionType.ALARM} type of {@link Action} message sent to the panel
+ * An {@link ActionType#ALARM} type of {@link Action} message sent to the panel
*
* @author Dan Cunningham - Initial contribution
*/
package org.openhab.binding.qolsysiq.internal.client.dto.action;
/**
- * An {@link ArmingActionType.ARM_AWAY} type of {@link ArmingAction} message sent to the panel
+ * An {@link ArmingActionType#ARM_AWAY} type of {@link ArmingAction} message sent to the panel
*
* @author Dan Cunningham - Initial contribution
*/
package org.openhab.binding.qolsysiq.internal.client.dto.action;
/**
- * An {@link ActionType.ARMING} type of {@link ArmingAction} message sent to the panel
+ * An {@link ActionType#ARMING} type of {@link ArmingAction} message sent to the panel
*
* @author Dan Cunningham - Initial contribution
*/
package org.openhab.binding.qolsysiq.internal.client.dto.action;
/**
- * An {@link ActionType.INFO} type of {@link InfoAction} message sent to the panel
+ * An {@link ActionType#INFO} type of {@link InfoAction} message sent to the panel
*
* @author Dan Cunningham - Initial contribution
*/
import org.openhab.binding.qolsysiq.internal.client.dto.model.AlarmType;
/**
- * An {@link EventType.ALARM} type of {@link Event} message sent from the panel
+ * An {@link EventType#ALARM} type of {@link Event} message sent from the panel
*
* @author Dan Cunningham - Initial contribution
*/
import org.openhab.binding.qolsysiq.internal.client.dto.model.PartitionStatus;
/**
- * An {@link EventType.ARMING} type of {@link Event} message sent from the panel
+ * An {@link EventType#ARMING} type of {@link Event} message sent from the panel
*
* @author Dan Cunningham - Initial contribution
*/
package org.openhab.binding.qolsysiq.internal.client.dto.event;
/**
- * An {@link EventType.ERROR} type of {@link Event} message sent from the panel
+ * An {@link EventType#ERROR} type of {@link Event} message sent from the panel
*
* @author Dan Cunningham - Initial contribution
*/
package org.openhab.binding.qolsysiq.internal.client.dto.event;
/**
- * An {@link EventType.INFO} type of {@link Event} message sent by the panel
+ * An {@link EventType#INFO} type of {@link Event} message sent by the panel
*
* @author Dan Cunningham - Initial contribution
*/
package org.openhab.binding.qolsysiq.internal.client.dto.event;
/**
- * A {@link InfoEventType.SECURE_ARM} type of {@link InfoEvent} message sent by the panel
+ * A {@link InfoEventType#SECURE_ARM} type of {@link InfoEvent} message sent by the panel
*
* @author Dan Cunningham - Initial contribution
*/
import org.openhab.binding.qolsysiq.internal.client.dto.model.Partition;
/**
- * A {@link InfoEventType.SUMMARY} type of {@link InfoEvent} message sent by the panel
+ * A {@link InfoEventType#SUMMARY} type of {@link InfoEvent} message sent by the panel
*
* @author Dan Cunningham - Initial contribution
*/
import org.openhab.binding.qolsysiq.internal.client.dto.model.ZoneActiveState;
/**
- * A {@link ZoneEventType.ZONE_ACTIVE} type of {@link ZoneEvent} message sent by the panel
+ * A {@link ZoneEventType#ZONE_ACTIVE} type of {@link ZoneEvent} message sent by the panel
*
* @author Dan Cunningham - Initial contribution
*/
import org.openhab.binding.qolsysiq.internal.client.dto.model.Zone;
/**
- * A {@link ZoneEventType.ZONE_ADD} type of {@link ZoneEvent} message sent by the panel
+ * A {@link ZoneEventType#ZONE_ADD} type of {@link ZoneEvent} message sent by the panel
*
* @author Dan Cunningham - Initial contribution
*/
import org.openhab.binding.qolsysiq.internal.client.dto.model.Zone;
/**
- * A {@link ZoneEventType.ZONE_UPDATE} type of {@link ZoneEvent} message sent by the panel
+ * A {@link ZoneEventType#ZONE_UPDATE} type of {@link ZoneEvent} message sent by the panel
*
* @author Dan Cunningham - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link RadioThermostatBinding} class defines common constants, which are
+ * The {@link RadioThermostatBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Michael Lobstein - Initial contribution
* Send an asynchronous http call to the thermostat, the response will be send to the
* event listeners as a RadioThermostat event when it is finally received
*
- * @param resouce the url of the json resource on the thermostat
+ * @param resource the url of the json resource on the thermostat
*/
public void getAsyncThermostatData(String resource) {
httpClient.newRequest(buildRequestURL(resource)).method(GET).timeout(30, TimeUnit.SECONDS)
/**
* Sends a command to the thermostat
*
- * @param the JSON attribute key for the value to be updated
- * @param the value to be updated in the thermostat
- * @param the end point URI to use for the command
+ * @param cmdKey the JSON attribute key for the value to be updated
+ * @param cmdVal the value to be updated in the thermostat
+ * @param resource the end point URI to use for the command
* @return the JSON response string from the thermostat
*/
public String sendCommand(String cmdKey, @Nullable String cmdVal, String resource) {
/**
* Sends a command to the thermostat
*
- * @param the JSON attribute key for the value to be updated
- * @param the value to be updated in the thermostat
- * @param JSON string to send directly to the thermostat instead of a key/value pair
- * @param the end point URI to use for the command
+ * @param cmdKey the JSON attribute key for the value to be updated
+ * @param cmdVal the value to be updated in the thermostat
+ * @param cmdJson JSON string to send directly to the thermostat instead of a key/value pair
+ * @param resource the end point URI to use for the command
* @return the JSON response string from the thermostat
*/
public String sendCommand(@Nullable String cmdKey, @Nullable String cmdVal, @Nullable String cmdJson,
* Scans all messages that arrive on the socket and scans them for the
* search keywords. The search is not case sensitive.
*
- * @param socket
- * The socket where the answers arrive.
- * @param keywords
- * The keywords to be searched for.
- * @return
- * @throws IOException
+ * @param response
*/
protected void parseResponse(String response) {
/**
* Update a given channelId from the thermostat data
*
- * @param the channel id to be updated
+ * @param channelId the channel id to be updated
* @param data the RadioThermostat dto
* @return the value to be set in the state
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link RegoHeatPumpBinding} class defines common constants, which are
+ * The {@link RegoHeatPumpBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Boris Krivonog - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link RMEBinding} class defines common constants, which are used across
+ * The {@link RMEBindingConstants} class defines common constants, which are used across
* the whole binding.
*
* @author Karel Goderis - Initial contribution
}
/**
- * returns general mower information. See {@MowerInfo} for the detailed information.
+ * returns general mower information. See {@link MowerInfo} for the detailed information.
*
* @return - the general mower information including a general success status.
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link RussoundBinding} class defines common constants, which are
+ * The {@link RussoundBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Tim Roberts - Initial contribution
}
/**
- * Overrides the base method to remove any state linked to the {@lin ChannelUID} from the
+ * Overrides the base method to remove any state linked to the {@link ChannelUID} from the
* {@link StatefulHandlerCallback}
*/
@Override
}
/**
- * Implements the {@link SocketSessionListener#responseException(Exception)} to automatically take the thing offline
- * via {@link RioHandlerCallback#statusChanged(ThingStatus, ThingStatusDetail, String)}
+ * Implements the {@link SocketSessionListener#responseException(IOException)} to automatically take the thing
+ * offline via {@link RioHandlerCallback#statusChanged(ThingStatus, ThingStatusDetail, String)}
*
* @param e the exception
*/
}
/**
- * Overrides the base method to remove any state linked to the {@lin ChannelUID} from the
+ * Overrides the base method to remove any state linked to the {@link ChannelUID} from the
* {@link StatefulHandlerCallback}
*/
@Override
* Callback to the bridge/thing to update the state of a channel in the bridge/thing.
*
* @param channelId the non-null, non-empty channel id
- * @param state the new non-null {@State}
+ * @param state the new non-null {@link State}
*/
void stateChanged(String channelId, State state);
* Implements {@link SocketSessionListener#responseReceived(String)} to try to process the response from the
* russound system. This response may be for other protocol handler - so ignore if we don't recognize the response.
*
- * @param a possibly null, possibly empty response
+ * @param response a possibly null, possibly empty response
*/
@Override
public void responseReceived(@Nullable String response) {
* Implements {@link SocketSessionListener#responseReceived(String)} to try to process the response from the
* russound system. This response may be for other protocol handler - so ignore if we don't recognize the response.
*
- * @param a possibly null, possibly empty response
+ * @param response a possibly null, possibly empty response
*/
@Override
public void responseReceived(@Nullable String response) {
/**
* Initializes the bridge. Confirms the configuration is valid and that our parent bridge is a
* {@link RioSystemHandler}. Once validated, a {@link RioControllerProtocol} is set via
- * {@link #setProtocolHandler(RioControllerProtocol)} and the bridge comes online.
+ * {@link #setProtocolHandler(AbstractRioProtocol)} and the bridge comes online.
*/
@Override
public void initialize() {
}
/**
- * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the zone names
+ * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the zone names
*/
@Override
public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) {
}
/**
- * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the zone names
+ * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the zone names
*/
@Override
public void childHandlerDisposed(ThingHandler childHandler, Thing childThing) {
* "Preset " + id
*
* @param id a preset ID between 1 and 36
- * @param isValid true if the preset is valid, false otherwise
+ * @param valid true if the preset is valid, false otherwise
* @param name a possibly null, possibly empty preset name
* @throws IllegalArgumentException if id < 1 or > 32
*/
}
/**
- * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the sources/controllers names
+ * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the sources/controllers names
*/
@Override
public void childHandlerInitialized(ThingHandler childHandler, Thing childThing) {
}
/**
- * Overrides the base to call {@link #childChanged(ThingHandler)} to recreate the sources/controllers names
+ * Overrides the base to call {@link #childChanged(ThingHandler, boolean)} to recreate the sources/controllers names
*/
@Override
public void childHandlerDisposed(ThingHandler childHandler, Thing childThing) {
/**
* Initializes the bridge. Confirms the configuration is valid and that our parent bridge is a
* {@link RioControllerHandler}. Once validated, a {@link RioZoneProtocol} is set via
- * {@link #setProtocolHandler(RioZoneProtocol)} and the bridge comes online.
+ * {@link #setProtocolHandler(AbstractRioProtocol)} and the bridge comes online.
*/
@Override
public void initialize() {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SamsungTvBinding} class defines common constants, which are used
+ * The {@link SamsungTvBindingConstants} class defines common constants, which are used
* across the whole binding.
*
* @author Pauli Anttila - Initial contribution
/**
* Creates new instance with specified command code and payload.
*
- * @param command command code
+ * @param commandCode command code
* @param payload command payload
*/
public SatelCommandBase(byte commandCode, byte[] payload) {
package org.openhab.binding.semsportal.internal.dto;
/**
- * A token is returned in a successful {@Link LoginRequest} and is needed to authorize any subsequent requests.
+ * A token is returned in a successful {@link LoginRequest} and is needed to authorize any subsequent requests.
*
* @author Iwan Bron - Initial contribution
*/
import com.google.gson.annotations.SerializedName;
/**
- * POJO for mapping the portal data response to the {@link StatusRequest} and the {@Link StationListRequest}
+ * POJO for mapping the portal data response to the {@link StatusRequest} and the {@link StationListRequest}
*
* @author Iwan Bron - Initial contribution
*
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SeneyeBinding} class defines common constants, which are
+ * The {@link SeneyeBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Niko Tanghe - Initial contribution
import com.google.gson.annotations.SerializedName;
/**
- * The {@link SensorCommunity} class definition for Logging identification
+ * The SensorCommunity class definition for Logging identification
*
* @author Bernd Weymann - Initial contribution
*/
/**
* Format the commnd using the configured format
*
- * @param data the command to transform
+ * @param command the command to transform
* @return the formatted data. The orginal data is returned if there is no format string
* or if there is an error performing the format.
*/
/**
* Create a {@link DeviceChannel} for the channel type
*
- * @param bundleContext the bundle context
+ * @param valueTransformationProvider the transformation provider
* @param channelConfig the channel configuration
* @param channelTypeID the channel type id
* @return the DeviceChannel or null if the channel type is not supported.
import org.slf4j.LoggerFactory;
/**
- * A transformation for a value used in {@DeviceChannel}.
+ * A transformation for a value used in {@link org.openhab.binding.serial.internal.channel.DeviceChannel}.
*
* @author David Graeff - Initial contribution
* @author Jan N. Klug - adapted from MQTT binding to HTTP binding
import com.google.gson.JsonSyntaxException;
/**
- * The {@link CarNetException} implements an extension to the standard Exception class. This allows to keep also the
+ * The {@link ShellyApiException} implements an extension to the standard Exception class. This allows to keep also the
* result of the last API call (e.g. including the http status code in the message).
*
* @author Markus Michels - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * {@link Shelly2RpcServlet} implements the WebSocket callback for Gen2 devices
+ * {@link ShellyEventServlet} implements the WebSocket callback for Gen2 devices
*
* @author Markus Michels - Initial contribution
*/
* @param id Sensor id from the update
* @param sen Sensor description from the update
* @param s New sensor value
- * @param allUpdatesList of updates. This is required, because we need to update both values at the same time
+ * @param allUpdates List of updates. This is required, because we need to update both values at the same time
*/
protected void updatePower(ShellyDeviceProfile profile, Map<String, State> updates, int id, CoIotDescrSen sen,
CoIotSensor s, List<CoIotSensor> allUpdates) {
/**
* Find index of Input id, which is required to map to channel name
*
- * @parm sensorDesc D field from sensor update
+ * @param sensorDesc D field from sensor update
* @param sensorId The id from the sensor update
* @return Index of found entry (+1 will be the suffix for the channel name) or null if sensorId is not found
*/
* Process CoIoT status update message. If a status update is received, but the device description has not been
* received yet a GET is send to query device description.
*
- * @param devId device id included in the status packet
- * @param payload CoAP payload (Json format), example: {"G":[[0,112,0]]}
+ * @param sensorUpdates
+ * @param sen
* @param serial Serial for this request. If this the the same as last serial
* the update was already sent and processed so this one gets
* ignored.
+ * @param serial
+ * @param s
+ * @param updates
+ * @param col
*/
@Override
public boolean handleStatusUpdate(List<CoIotSensor> sensorUpdates, CoIotDescrSen sen, int serial, CoIotSensor s,
/**
* Initialize CoAP access, send discovery packet and start Status server
*
- * @parm thingName Thing name derived from Thing Type/hostname
- * @parm config ShellyThingConfiguration
- * @thows ShellyApiException
+ * @param thingName Thing name derived from Thing Type/hostname
+ * @param config ShellyThingConfiguration
+ * @throws ShellyApiException
*/
public synchronized void start(String thingName, ShellyThingConfiguration config) throws ShellyApiException {
try {
* Set event callback URLs. Depending on the device different event types are supported. In fact all of them will be
* redirected to the binding's servlet and act as a trigger to schedule a status update
*
- * @param ShellyApiException
* @throws ShellyApiException
*/
@Override
import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2RpcNotifyStatus;
/**
- * The {@link WebsocketInterface} is responsible for interfacing the Websocket.
+ * The {@link Shelly2RpctInterface} is responsible for interfacing the Websocket.
*
* @author Markus Michels - Initial contribution
*/
* Constructor
*
* @param thing The Thing object
+ * @param translationProvider
* @param bindingConfig The binding configuration (beside thing
* configuration)
+ * @param thingTable
* @param coapServer coap server instance
- * @param localIP local IP address from networkAddressService
- * @param httpPort from httpService
+ * @param httpClient from httpService
*/
public ShellyBaseHandler(final Thing thing, final ShellyTranslationProvider translationProvider,
final ShellyBindingConfiguration bindingConfig, ShellyThingTable thingTable,
/**
* Save alarm to the lastAlarm channel
*
- * @param alarm Alarm Message
+ * @param event Alarm Message
+ * @param force
*/
@Override
public void postEvent(String event, boolean force) {
/**
* Callback for device events
*
+ * @param address
* @param deviceName device receiving the event
+ * @param deviceIndex
+ * @param type the HTML input data
* @param parameters parameters from the event URL
- * @param data the HTML input data
* @return true if event was processed
*/
@Override
* If the authorization failed the binding can't access the device settings and determine the thing type. In this
* case the thing type shelly-unknown is set.
*
- * @param response exception details including the http respone
+ * @param result exception details including the http respone
* @return true if the authorization failed
*/
protected boolean isAuthorizationFailed(ShellyApiResult result) {
/**
* Map input states to channels
*
- * @param groupName Channel Group (relay / relay1...)
- *
* @param status Shelly device status
* @return true: one or more inputs were updated
*/
/**
* Update Thing's channels according to available status information from the API
*
- * @param thingHandler
+ * @param dynChannels
*/
@Override
public void updateChannelDefinitions(Map<String, Channel> dynChannels) {
/**
* Return device profile.
*
- * @param ForceRefresh true=force refresh before returning, false=return without
+ * @param forceRefresh true=force refresh before returning, false=return without
* refresh
* @return ShellyDeviceProfile instance
* @throws ShellyApiException
/**
* Update device status
*
- * @param th Thing Handler instance
- * @param profile ShellyDeviceProfile
+ * @param thingHandler Thing Handler instance
+ * @param status Status message
*/
public static boolean updateDeviceStatus(ShellyThingInterface thingHandler, ShellySettingsStatus status) {
ShellyDeviceProfile profile = thingHandler.getProfile();
/**
* Update Meter channel
*
- * @param th Thing Handler instance
- * @param profile ShellyDeviceProfile
+ * @param thingHandler Thing Handler instance
* @param status Last ShellySettingsStatus
*/
public static boolean updateMeters(ShellyThingInterface thingHandler, ShellySettingsStatus status) {
/**
* Update Sensor channel
*
- * @param th Thing Handler instance
- * @param profile ShellyDeviceProfile
+ * @param thingHandler Thing Handler instance
* @param status Last ShellySettingsStatus
*
* @throws ShellyApiException
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * {@link DeviceUpdateListener} can register on the {@link TradfriGatewayHandler} to be informed about details about
+ * {@link ShellyDeviceListener} can register on the
+ * {@link org.openhab.binding.tradfri.internal.handler.TradfriGatewayHandler} to be informed about details about
* devices.
*
* @author Markus Michels - Initial contribution
* Constructor
*
* @param thing The thing passed by the HandlerFactory
+ * @param translationProvider
* @param bindingConfig configuration of the binding
- * @param coapServer coap server instance
- * @param localIP local IP of the openHAB host
- * @param httpPort port of the openHAB HTTP API
+ * @param thingTable
+ * @param coapService coap server instance
+ * @param httpClient to connect to the openHAB HTTP API
*/
public ShellyProtectedHandler(final Thing thing, final ShellyTranslationProvider translationProvider,
final ShellyBindingConfiguration bindingConfig, ShellyThingTable thingTable,
* Constructor
*
* @param thing The thing passed by the HandlerFactory
+ * @param translationProvider
* @param bindingConfig configuration of the binding
+ * @param thingTable
* @param coapServer coap server instance
- * @param localIP local IP of the openHAB host
- * @param httpPort port of the openHAB HTTP API
+ * @param httpClient to connect to the openHAB HTTP API
*/
public ShellyRelayHandler(final Thing thing, final ShellyTranslationProvider translationProvider,
final ShellyBindingConfiguration bindingConfig, ShellyThingTable thingTable,
/**
* Update Relay/Roller channels
*
- * @param th Thing Handler instance
- * @param profile ShellyDeviceProfile
* @param status Last ShellySettingsStatus
*
* @throws ShellyApiException
/**
* Update LED channels
*
- * @param th Thing Handler instance
- * @param profile ShellyDeviceProfile
* @param status Last ShellySettingsStatus
*/
public boolean updateLed(ShellySettingsStatus status) {
import org.osgi.service.component.annotations.Reference;
/**
- * The {@link ShellyCHANNEL_DEFINITIONSDTO} defines channel information for dynamically created channels. Those will be
+ * The {@link #CHANNEL_DEFINITIONS} defines channel information for dynamically created channels. Those will be
* added on the first thing status update
*
* @author Markus Michels - Initial contribution
* messing up the log with those updates)
*
* @param channelId Channel id
- * @param value Value (State)
+ * @param newValue Value (State)
* @param forceUpdate true: ignore cached data, force update; false check cache of changed data
* @return true, if successful
*/
/**
* Used by OSGI to unsets the mediator from the handler factory.
*
- * @param mediator the mediator
+ * @param mitsubishiMediator the mediator
*/
public void unsetMediator(final SilvercrestWifiSocketMediator mitsubishiMediator) {
logger.debug("Mediator has been unsetted from discovery service.");
/**
* Used by OSGI to unset the mediator in the discovery service.
*
- * @param mediator the mediator
+ * @param mitsubishiMediator the mediator
*/
public void unsetMediator(final SilvercrestWifiSocketMediator mitsubishiMediator) {
logger.debug("Mediator has been unsetted from discovery service.");
/**
* Returns all the {@link Thing} registered.
*
- * @returns all the {@link Thing}.
+ * @return all the {@link Thing}.
*/
Set<Thing> getAllThingsRegistred();
/**
* Returns all the {@link Thing} registered.
*
- * @returns all the {@link Thing}.
+ * @return all the {@link Thing}.
*/
@Override
public Set<Thing> getAllThingsRegistred() {
/**
* Validates if one Mac address is not valid.
*
- * @param mac the mac, with or without :
+ * @param macAddress the mac, with or without :
* @return true if is not valid.
*/
public static boolean isMacNotValid(final String macAddress) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link sinopeBinding} class defines common constants, which are
+ * The {@link SinopeBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Pascal Larin - Initial contribution
/**
* The {@link SinopeConfigStatusMessage} defines
- * the keys to be used for {@link ConfigStatusMessage}s.
+ * the keys to be used for {@link org.openhab.core.config.core.status.ConfigStatusMessage}s.
*
* @author Pascal Larin - Initial Contribution
*
* The {@link AbstractDiscoveryService} provides methods which handle the {@link DiscoveryListener}s.
*
* Subclasses do not have to care about adding and removing those listeners.
- * They can use the protected methods {@link #thingDiscovered(DiscoveryResult)} and {@link #thingRemoved(String)} in
+ * They can use the protected methods
+ * {@link org.openhab.core.config.discovery.pAbstractDiscoveryService#thingDiscovered(DiscoveryResult)}
+ * and {@link org.openhab.core.config.discovery.AbstractDiscoveryService#thingRemoved(ThingUID)} in
* order to notify the registered {@link DiscoveryListener}s.
*
* @author Pascal Larin - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SleepIQBinding} class defines common constants, which are
+ * The {@link SleepIQBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Gregory Moyer - Initial contribution
import java.util.List;
/**
- * The {@link SleeperResponse} holds the information about the sleepers assigned to the bed sides.
+ * The {@link SleepersResponse} holds the information about the sleepers assigned to the bed sides.
*
* @author Gregory Moyer - Initial contribution
*/
/**
* Update the given foundation properties with features of the given bed foundation.
*
- * @param bed the source of data
+ * @param bedId the source of data
* @param features the foundation features to update (this may be <code>null</code>)
+ * @param properties
* @return the given map (or a new map if no map was given) with updated/set properties from the supplied bed
*/
public Map<String, String> updateFeatures(final String bedId, final @Nullable FoundationFeaturesResponse features,
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SMAEnergyMeterBinding} class defines common constants, which are
+ * The {@link SMAEnergyMeterBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Osman Basha - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SmlReaderBinding} class defines common constants, which are
+ * The {@link SmartMeterBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Matthias Steigenberger - Initial contribution
* Establishes the connection against the device and reads native encoded SML informations.
* Ensures that a connection is opened and notifies any attached listeners
*
- * @param serialParmeter
+ * @param initMessage
* @param period hint for the connector to emit items in this time intervals.
+ * @param executor
* @return native encoded SML informations from a device.
*/
Publisher<T> getMeterValues(byte @Nullable [] initMessage, Duration period, ExecutorService executor);
/**
* This represents a meter device.
* All read values of the device are cached here and can be obtained. The reading can be started with
- * {@link #readValues(ScheduledExecutorService, Duration)}
+ * {@link #readValues(long, ScheduledExecutorService, Duration)}
*
* @author Matthias Steigenberger - Initial contribution
*
/**
* Returns the specified OBIS value if available.
*
- * @param obis the OBIS code which value should be retrieved.
+ * @param obisId the OBIS code which value should be retrieved.
* @return the OBIS value as String if available - otherwise null.
*/
@Nullable
/**
* Returns the specified OBIS value if available.
*
- * @param obis the OBIS code which value should be retrieved.
+ * @param obisId the OBIS code which value should be retrieved.
* @return the OBIS value if available - otherwise null.
*/
@SuppressWarnings("unchecked")
/**
* Read values from this device a store them locally against their OBIS code.
*
- * If there is an error in reading, it will be retried {@value #NUMBER_OF_RETRIES} times. The retry will be delayed
- * by {@code period} seconds.
+ * If there is an error in reading, it will be retried
+ * {@value org.openhab.binding.smartmeter.connectors.ConnectorBase#NUMBER_OF_RETRIES} times.
+ * The retry will be delayed by {@code period} seconds.
* If its still failing, the connection will be closed and opened again.
*
* @return The {@link Disposable} which needs to be disposed whenever not used anymore.
* Static factory method to create a SmlDevice object with a serial connector member.
*
* @param serialPortManagerSupplier
- *
* @param deviceId the id of the device as defined in openHAB configuration.
- * @param pullRequestRequired identicates if SML values have to be actively requested.
* @param serialPort the port where the device is connected as defined in openHAB configuration.
- * @param serialParameter
* @param initMessage
+ * @param baudrate
+ * @param baudrateChangeDelay
*/
public static SmlMeterReader createInstance(Supplier<SerialPortManager> serialPortManagerSupplier, String deviceId,
String serialPort, byte @Nullable [] initMessage, int baudrate, int baudrateChangeDelay) {
*
* @param portName the port where the device is connected as defined in openHAB configuration.
* @param baudrate
- * @throws IOException
*/
public SmlSerialConnector(Supplier<SerialPortManager> serialPortManagerSupplier, String portName, int baudrate,
int baudrateChangeDelay) {
}
/**
- * @{inheritDoc}
+ * {@inheritDoc}
*/
@Override
public void closeConnection() {
/**
* Constructor
*
- * @param obis
+ * @param listEntry
*/
public SmlValueExtractor(SmlListEntry listEntry) {
smlListEntry = listEntry;
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SmartthingsBinding} class defines common constants, which are
+ * The {@link SmartthingsBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Bob Raker - Initial contribution
*
* @param path http path which tells Smartthings what to execute
* @param data data to send
- * @return Response from Smartthings
* @throws InterruptedException
* @throws TimeoutException
* @throws ExecutionException
*
* @param path http path which tells Smartthings what to execute
* @param data data to send
- * @return Response from Smartthings
* @throws InterruptedException
* @throws TimeoutException
* @throws ExecutionException
/**
* Constructor to set up interface
*
- * @param config Bridge configuration
+ * @param scheduler
+ * @param handler
+ * @param httpClient
*/
public WebInterface(ScheduledExecutorService scheduler, SolarEdgeHandler handler, HttpClient httpClient) {
this.config = handler.getConfiguration();
@NonNullByDefault
public interface SolarEdgeHandler extends ThingHandler, ChannelProvider {
/**
- * Called from {@link WebInterface#authenticate()} to update
- * the thing status because updateStatus is protected.
+ * Called from
+ * {@link org.openhab.binding.solaredge.internal.connector.WebInterface.WebRequestExecutor#authenticate()}
+ * to update the thing status because updateStatus is protected.
*
* @param status Bridge status
* @param statusDetail Bridge status detail
* @param targetMap result will be put into this map
* @param channel channel to assign the value
* @param value the value to convert
- * @param unit as string
+ * @param unitAsString unit as string
*/
protected final void putPowerType(Map<Channel, State> targetMap, @Nullable Channel channel, @Nullable Double value,
@Nullable String unitAsString) {
* @param targetMap result will be put into this map
* @param channel channel to assign the value
* @param value the value to convert
- * @param unit as string
+ * @param unitAsString as string
*/
protected final void putEnergyType(Map<Channel, State> targetMap, @Nullable Channel channel, @Nullable Double value,
@Nullable String unitAsString) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SolarLogBinding} class defines common constants, which are
+ * The {@link SolarLogBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Johann Richard - Initial contribution
*
* @param host hostname or ip address of the SolarMax device to be contacted
* @param portNumber portNumber the SolarMax is listening on (default is 12345)
- * @param commandList a list of commands to be sent to the SolarMax device
+ * @param deviceAddress
* @return
- * @throws UnknownHostException if the host is unknown
* @throws SolarMaxException if some other exception occurs
*/
public static SolarMaxData getAllValuesFromSolarMax(final String host, final int portNumber,
/**
* Collection of all devices known to the energy manager including the energy manager itself.
*
- * The {@link Device}s are generated from the {@link DeviceDTO}s inside of the {@link EnergyManagerDTO}
+ * The {@link Device}s are generated from the {@link org.openhab.binding.solarwatt.internal.domain.dto.DeviceDTO}s
+ * inside of the {@link org.openhab.binding.solarwatt.internal.domain.dto.EnergyManagerDTO}
*
* @author Sven Carstens - Initial contribution
*/
/**
* Aggregation of the interesting parts to write into a channel.
*
- * From this the {@link ChannelType}s are created.
+ * From this the {@link org.openhab.core.thing.type.ChannelType}s are created.
*
* @author Sven Carstens - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SonosBinding} class defines common constants, which are
+ * The {@link SonosBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Karel Goderis - Initial contribution
/**
* @param xml
* @return a list of alarms from the given xml string.
- * @throws IOException
- * @throws SAXException
*/
public static List<SonosAlarm> getAlarmsFromStringResult(String xml) {
AlarmHandler handler = new AlarmHandler();
/**
* @param xml
* @return a list of Entries from the given xml string.
- * @throws IOException
- * @throws SAXException
*/
public static List<SonosEntry> getEntriesFromString(String xml) {
EntryHandler handler = new EntryHandler();
}
/**
- * @param controller
* @param xml
* @return zone group from the given xml
- * @throws IOException
- * @throws SAXException
*/
public static List<SonosZoneGroup> getZoneGroupFromXML(String xml) {
ZoneGroupHandler handler = new ZoneGroupHandler();
/**
* Save the state (track, position etc) of the Sonos Zone player.
- *
- * @return true if no error occurred.
*/
protected void saveState() {
synchronized (stateLock) {
/**
* Restore the state (track, position etc) of the Sonos Zone player.
- *
- * @return true if no error occurred.
*/
protected void restoreState() {
synchronized (stateLock) {
/**
* Play music from the line-in of the given Player referenced by the given UDN or name
*
- * @param udn or name
+ * @param command udn or name
*/
public void playLineIn(Command command) {
if (command instanceof StringType) {
/**
* Play a given url to music in one of the music libraries.
*
- * @param url
+ * @param command
* in the format of //host/folder/filename.mp3
*/
public void playURI(Command command) {
/**
* Play a given notification sound
*
- * @param url in the format of //host/folder/filename.mp3
+ * @param notificationURL in the format of //host/folder/filename.mp3
*/
public void playNotificationSoundURI(Command notificationURL) {
if (notificationURL instanceof StringType) {
* This will attempt to match the station string with an entry in the
* favorites list, this supports both single entries and playlists
*
- * @param favorite to match
- * @return true if a match was found and played.
+ * @param command favorite to match
*/
public void playFavorite(Command command) {
if (command instanceof StringType) {
* Validate the content of a returned message
*
* @param responseMessage the buffer containing the returned message
- * @param the projector setting to get or set
+ * @param item the projector setting to get or set
*
* @throws CommunicationException if the message has unexpected content
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SoulissBinding} class defines common constants, which are
+ * The {@link SoulissBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Tonino Fazio - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link soulissHandlerFactory} is responsible for creating things and thingGeneric
- * handlers.
+ * The {@link org.openhab.binding.souliss.internal.SoulissHandlerFactory} is responsible for creating
+ * things and thingGeneric handlers.
*
* @author Tonino Fazio - Initial contribution
* @author Luca Calcaterra - Refactor for OH3
}
/**
- * @param the Topic Variant
+ * @return the Topic Variant
*/
public String getTopicVariant() {
return sTopicVariant;
}
/**
- * @param SoulissNode
- * the SoulissNodeID to get
+ * @return the SoulissNodeID
*/
public int getNode() {
return iNode;
* Play a context uri (track or other) on the current active device (if null is passed for deviceID) or the given
* device at the given offset and/or position in milliseconds.
*
- * @param actions Spotify Actions object.
* @param contextUri context uri (track or other)
* @param deviceId Id of the device to play on, or current device if given null
* @param offset Offset in the list, default 0.
/**
* Constructor.
*
- * @param authorizer The authorizer used to refresh the access token when expired
- * @param connector The Spotify connector handling the Web Api calls to Spotify
+ * @param oAuthClientService The authorizer used to refresh the access token when expired
+ * @param scheduler
+ * @param httpClient The Spotify connector handling the Web Api calls to Spotify
*/
public SpotifyApi(OAuthClientService oAuthClientService, ScheduledExecutorService scheduler,
HttpClient httpClient) {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SqueezeBoxBinding} class defines common constants, which are used
+ * The {@link SqueezeBoxBindingConstants} class defines common constants, which are used
* across the whole binding.
*
* @author Dan Cunningham - Initial contribution
/**
* Send a generic command to a given player
*
- * @param playerId
+ * @param mac
* @param command
*/
public void playerCommand(String mac, String command) {
import com.google.gson.stream.MalformedJsonException;
/**
- * The {@link GsonColonDateTypeAdapter} class is a custom TypeAdapter factory to ensure deserialization always returns a
- * list even if the Json document contains only a single curfew object and not an array.
+ * The {@link SurePetcareDeviceCurfewListTypeAdapterFactory} class is a custom TypeAdapter factory to ensure
+ * deserialization always returns a list even if the Json document contains only a single curfew object and
+ * not an array.
*
* See https://stackoverflow.com/questions/43412261/make-gson-accept-single-objects-where-it-expects-arrays
*
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link SynopAnalyzerBinding} class defines common constants used across the whole binding.
+ * The {@link SynopAnalyzerBindingConstants} class defines common constants used across the whole binding.
*
* @author Gaël L'hopital - Initial contribution
*/
import org.slf4j.LoggerFactory;
/**
- * Extended channels can be auto discovered and added to newly created groups in the {@link SysteminfoHandler}. The
+ * Extended channels can be auto discovered and added to newly created groups in the
+ * {@link org.openhab.binding.systeminfo.internal.handler.SysteminfoHandler}. The
* thing needs to be updated to add the groups. The `SysteminfoThingTypeProvider` OSGi service gives access to the
* `ThingTypeRegistry` and serves the updated `ThingType`.
*
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link TadoBinding} class defines common constants, which are
+ * The {@link TadoBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Dennis Frommknecht - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link TankerkoenigBinding} class defines common constants, which are
+ * The {@link TankerkoenigBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Dennis Dollinger - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link TapoControlHandler} is responsible for handling commands, which are
+ * The {@link ThingHandler} is responsible for handling commands, which are
* sent to one of the channels.
*
* @author Christian Wild - Initial contribution
/**
* INIT CLASS
- *
- * @param bridgeHandler
*/
public TapoDiscoveryService() {
super(SUPPORTED_THING_TYPES_UIDS, TAPO_DISCOVERY_TIMEOUT_S, false);
/**
* INIT CLASS
*
- * @param config TapoControlConfiguration class
+ * @param device
+ * @param bridgeThingHandler
*/
public TapoDeviceConnector(TapoDevice device, TapoBridgeHandler bridgeThingHandler) {
super(device, bridgeThingHandler);
/**
* send custom command to device
*
- * @param plBuilder Payloadbuilder with unencrypted payload
+ * @param queryMethod query method
*/
public void sendCustomQuery(String queryMethod) {
/* create payload */
/**
* handle error
*
- * @param te TapoErrorHandler
+ * @param tapoError TapoErrorHandler
*/
@Override
protected void handleError(TapoErrorHandler tapoError) {
/**
* INIT CLASS
*
- * @param config TapoControlConfiguration class
+ * @param device
+ * @param bridgeThingHandler
*/
public TapoDeviceHttpApi(TapoDevice device, TapoBridgeHandler bridgeThingHandler) {
this.bridge = bridgeThingHandler;
/**
* handle error
*
- * @param te TapoErrorHandler
+ * @param tapoError TapoErrorHandler
*/
protected void handleError(TapoErrorHandler tapoError) {
}
/**
* Set new ipAddress
*
- * @param new ipAdress
+ * @param ipAddress new ipAdress
*/
public void setDeviceURL(String ipAddress) {
this.ipAddress = ipAddress;
/**
* Set new token
*
- * @param deviceURL
* @param token
*/
protected void setToken(String token) {
/**
* Set Device Child data to device
*
- * @param energyData
+ * @param hostData
*/
public void setChildData(TapoChildData hostData) {
hostData.getChildDeviceList().forEach(child -> {
* If only one property must be changed, there is also a convenient method
* updateProperty(String name, String value).
*
- * @param TapoDeviceInfo
+ * @param deviceInfo
*/
protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {
/* device properties */
/**
* UPDATE PROPERTIES
*
- * @param TapoDeviceInfo
+ * @param deviceInfo TapoDeviceInfo
*/
@Override
protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {
/**
* UPDATE PROPERTIES
*
- * @param TapoDeviceInfo
+ * @param deviceInfo TapoDeviceInfo
*/
@Override
protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {
/**
* UPDATE PROPERTIES
*
- * @param TapoDeviceInfo
+ * @param deviceInfo TapoDeviceInfo
*/
@Override
protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {
/**
* UPDATE PROPERTIES
*
- * @param TapoDeviceInfo
+ * @param deviceInfo TapoDeviceInfo
*/
@Override
protected void devicePropertiesChanged(TapoDeviceInfo deviceInfo) {
*
* @param handshakeKey Key from Handshake-Request
* @param credentials TapoCredentials
- * @throws Exception
*/
public TapoCipher(String handshakeKey, TapoCredentials credentials) {
setKey(handshakeKey, credentials);
/**
* INIT CLASS
*
- * @param email E-Mail-adress of Tapo Cloud
- * @param passowrd Password of Tapo Cloud
+ * @param eMail E-Mail-adress of Tapo Cloud
+ * @param password Password of Tapo Cloud
*/
public TapoCredentials(String eMail, String password) {
this.mimeEncoder = new MimeEncode();
/**
* set credentials.
*
- * @param username username (eMail-adress) of Tapo Cloud
- * @param passowrd Password of Tapo Cloud
+ * @param eMail username (eMail-adress) of Tapo Cloud
+ * @param password Password of Tapo Cloud
*/
public void setCredectials(String eMail, String password) {
try {
/**
* Constructor
*
- * @param exception Exception
+ * @param ex Exception
*/
public TapoErrorHandler(Exception ex) {
raiseError(ex);
/**
* Constructor
*
- * @param exception Exception
+ * @param ex Exception
* @param infoMessage optional info-message
*/
public TapoErrorHandler(Exception ex, String infoMessage) {
/**
* Raises new error
*
- * @param exception Exception
+ * @param ex Exception
*/
public void raiseError(Exception ex) {
raiseError(ex, "");
/**
* Raises new error
*
- * @param exception Exception
+ * @param ex Exception
* @param infoMessage optional info-message
*/
public void raiseError(Exception ex, String infoMessage) {
/**
* Return OnOffType from bool
*
- * @param boolVal
+ * @param intVal
*/
public static OnOffType getOnOffType(Integer intVal) {
return intVal == 0 ? OnOffType.OFF : OnOffType.ON;
* Returns the next frame.
*
* @return the next frame or null if end of stream
- * @throws TimeoutException
* @throws IOException
* @throws InvalidFrameException
- * @throws Exception
*/
public synchronized @Nullable Frame readNextFrame() throws InvalidFrameException, IOException {
// seek the next header frame
import org.openhab.binding.teleinfo.internal.serial.TeleinfoTicMode;
/**
- * The {@link FrameUtil} class defines a utility class for {@link FrameCbetmLong}.
+ * The {@link FrameUtil} class defines a utility class for
+ * {@link org.openhab.binding.teleinfo.internal.data.FrameType#CBETM_LONG_BASE}.
*
* @author Nicolas SIBERIL - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link TellstickBinding} class defines common constants, which are
+ * The {@link TellstickBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author jarlebh - Initial contribution
package org.openhab.binding.tellstick.internal.conf;
/**
- * Configuration class for {@link TellstickBridge} bridge used to connect to the
+ * Configuration class for Tellstick bridge used to connect to the
* Telldus Live service.
*
* @author Jarle Hjortland - Initial contribution
package org.openhab.binding.tellstick.internal.conf;
/**
- * Configuration class for {@link TellstickBridge} bridge used to connect to the
+ * Configuration class for Tellstick bridge used to connect to the
* Telldus local API.
*
* @author Jan Gustafsson - Initial contribution
package org.openhab.binding.tellstick.internal.conf;
/**
- * Configuration class for {@link TellstickBridge} bridge used to connect to the
+ * Configuration class for Tellstick bridge used to connect to the
* Telldus Core service on the local machine.
*
* @author Jarle Hjortland - Initial contribution
/**
* This method is called whenever the state of the given device has changed.
- * The new state can be obtained by {@link FullLight#getState()}.
+ * The new state can be obtained by {@link TellstickNetDevice#getState()} /
+ * {@link TellstickLocalDeviceDTO#getState()}.
*
* @param bridge
* The Tellstick bridge the changed device is connected to.
/**
* Get a sensor from the bridgehandler.
*
- * @param serialNumber
+ * @param deviceUUId
* @return
*/
Device getSensor(String deviceUUId);
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link TiVoBinding} class defines common constants that are
+ * The {@link TiVoBindingConstants} class defines common constants that are
* used across the whole binding.
*
* @author Jayson Kubilis (DigitalBytes) - Initial contribution
/**
* {@link updateTivoStatus} populates the items with the status / channel information.
*
- * @param tivoStatusData the {@link TivoStatusData}
+ * @param oldStatusData the {@link TivoStatusData}
+ * @param newStatusData the {@link TivoStatusData}
*/
public void updateTivoStatus(TivoStatusData oldStatusData, TivoStatusData newStatusData) {
if (newStatusData.getConnectionStatus() != ConnectionStatus.INIT) {
import org.eclipse.jdt.annotation.Nullable;
/**
- * The Class {@link TivoConfigData} stores the dynamic configuration parameters used within the {@link TivoHandler } and
- * {@link TivoConfigStatusProvider}.
+ * The Class {@link TivoConfigData} stores the dynamic configuration parameters used within the {@link TiVoHandler} and
+ * {@link TivoStatusProvider}.
*
* @author Jayson Kubilis (DigitalBytes) - Initial contribution
* @author Andrew Black (AndyXMB) - minor updates, removal of unused DiscoveryService functionality.
}
/**
- * {@link isCmdOK} indicates if the last command executed correctly.
+ * {@link #isCmdOK()} indicates if the last command executed correctly.
*
* @return cmdOk boolean true = executed correctly, false = last command failed with error message
*/
* Instantiates a new TivoConfigStatusProvider.
*
* @param tivoConfigData {@link TivoConfigData} configuration data for the specific thing.
- * @param tivoStatusData {@link TivoStatusData} status data for the specific thing.
* @param tivoHandler {@link TivoHandler} parent handler object for the TivoConfigStatusProvider.
*
*/
}
/**
- * {@link statusRefresh} initiates a connection to the TiVo. When a new connection is made and the TiVo is online,
- * the current channel is always returned. The connection is then closed (allows the socket to be used by other
- * devices).
+ * {@link #statusRefresh()} initiates a connection to the TiVo. When a new connection is made and the TiVo is
+ * online, the current channel is always returned. The connection is then closed (allows the socket to be used
+ * by other devices).
*
- * @return {@link TivoStatusData} object
* @throws InterruptedException
*/
public void statusRefresh() throws InterruptedException {
import org.openhab.binding.touchwand.internal.dto.TouchWandUnitData;
/**
- * Interface for a listener on the {@link TouchWandWebSocket}.
- * When it is registered on the socket, it gets called back when {@link TouchWandWebSocket} receives data.
+ * Interface for a listener on the {@link TouchWandWebSockets}.
+ * When it is registered on the socket, it gets called back when {@link TouchWandWebSockets} receives data.
*
* @author Roie Geron - Initial contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * Configuration class for {@link TouchwandBridgeHandler}.
+ * Configuration class for {@link TouchWandBridgeHandler}.
*
* @author Roie Geron - Initial contribution
*/
/**
* The {@link TradfriColor} is used for conversion between color formats.
- * Use the static methods {@link TradfriColor#fromCie(int, int, int)} and {@link TradfriColor#fromHSBType(HSBType)} for
+ * Use the static constructors {@link #TradfriColor(int, int, int)} and {@link #TradfriColor(HSBType)} for
* construction.
*
* @author Holger Reichert - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link TweetActions} class defines rule actions for sending tweet
+ * The {@link TwitterActions} class defines rule actions for sending tweet
*
* @author Scott Hanson - Initial contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link UniFiPoeThingConfig} encapsulates all the configuration options for an instance of the
- * {@link UniFiPoePortThingHandler}.
+ * The {@link UniFiPoePortThingConfig} encapsulates all the configuration options for an instance of the
+ * {@link org.openhab.binding.unifi.internal.handler.UniFiPoePortThingHandler}.
*
* @author Hilbrand Bouwkamp - Initial contribution
*/
import com.google.gson.JsonObject;
/**
- * The {@link UnfiPortOverride} represents the data model of UniFi port override.
+ * The {@link UnfiPortOverrideJsonObject} represents the data model of UniFi port override.
* Using plain JsonObject to make sure any data in the object is not lost when writing the data back to the UniFi
* device.
*
*
* The {@link UniFiTrustManager} is a "trust all" implementation of {@link X509ExtendedTrustManager}.
*
- * @see {@link UniFiTrustManagerProvider}
+ * @see UniFiTrustManagerProvider
*
* @author Matthew Bowman - Initial contribution
*/
/**
* Send broadcast packets with service request string until a response
- * is received. Return the response as String (even though it should
- * contain an internet address).
+ * is received.
*
- * @return String received from server. Should be server IP address.
- * Returns empty string if failed to get valid reply.
+ * @param listener Listener to process the String received from server. Should be server IP address.
+ *
*/
public void sendBroadcast(Consumer<ServerInfo> listener) {
byte[] receiveBuffer = new byte[MAX_PACKET_SIZE];
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link UrtsiBinding} class defines common constants, which are
+ * The {@link UrtsiBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Oliver Libutzki - Initial contribution
* Retrieve VDR Version from SVDRP Client
*
* @return VDR Version
- * @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
- * @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
String getSVDRPVersion();
}
*
* Open VDR Socket Connection
*
- * @throws IOException if an IO Error occurs
+ * @throws SVDRPConnectionException if an IO Error occurs
*/
@Override
public void openConnection() throws SVDRPConnectionException, SVDRPParseResponseException {
/**
* Close VDR Socket Connection
*
- * @throws IOException if an IO Error occurs
+ * @throws SVDRPConnectionException if an IO Error occurs
*/
@Override
public void closeConnection() throws SVDRPConnectionException, SVDRPParseResponseException {
* Retrieve VDR Version from SVDRP Client
*
* @return VDR Version
- * @throws SVDRPException thrown if something's not OK with SVDRP call
*/
@Override
public String getSVDRPVersion() {
*
* @param message SVDRP Client Response
* @return Timer List Object
- * @throws SVDRPParseResponseException thrown if response data is not parseable
*/
public static SVDRPTimerList parse(String message) {
SVDRPTimerList timers = new SVDRPTimerList();
* <P>
* Methods in addition to the mentioned interface:
* <UL>
- * <LI>{@link #getNtfNodeID} to retrieve the node identifier which has been changed.</LI>
- * <LI>{@link #getNtfState} to retrieve the state of the node which has been changed.</LI>
- * <LI>{@link #getNtfCurrentPosition} to retrieve the actual position of this node.</LI>
- * <LI>{@link #getNtfTarget} to retrieve the target position of this node.</LI>
+ * <LI>{@link #getProduct} to retrieve product type.</LI>
+ * <LI>{@link #setCreatorCommand} to set the command id that identifies the API on which 'product' will be created.</LI>
* </UL>
* <P>
* NOTE: the class does NOT define a request as it only works as receiver.
* <P>
* Methods in addition to the mentioned interface:
* <UL>
- * <LI>{@link #setNodeAndMainParameter} to define the node and intended parameter value.</LI>
+ * <LI>{@link #setNodeIdAndParameters} to define the node and intended parameter value.</LI>
* </UL>
*
* @see RunProductCommand
* method may ignore the new product if it was created by certain originating commands, or if the new product has
* certain actuator states.
*
- * @param requestingCommand the command that requested the data from the hub and so triggered calling this method.
* @param newProduct the product containing new data.
*
* @return true if the product exists in the database.
/**
* Returns the display position of the actuator.
+ * <ul>
* <li>As a general rule it returns <b>currentPosition</b>, except as follows..
* <li>If the actuator is in a motion state it returns <b>targetPosition</b>
* <li>If the motion state is 'done' but the currentPosition is invalid it returns <b>targetPosition</b>
* <li>If the manual override flag is set it returns the <b>unknown</b> position value
- *
+ * </ul>
+ *
* @return The display position of the actuator
*/
public int getDisplayPosition() {
* Methods in handle this type of information:
* <UL>
* <LI>{@link #getVelocity()} to retrieve the value of the characteristic.</LI>
- * <LI>{@link #get(int)} to convert a value into the characteristic.</LI>
+ * <LI>{@link #get(short)} to convert a value into the characteristic.</LI>
* <LI>{@link #getByName(String)} to convert a name into the characteristic.</LI>
* <LI>{@link #dump} to retrieve a human-readable description of all values.</LI>
* </UL>
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link VenstarThermostatBinding} class defines common constants, which are
+ * The {@link VenstarThermostatBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author William Welliver - Initial contribution
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link VenstarRunTime} represents one Runtime from the RuntimeData returned from the REST API
+ * The {@link VenstarRuntime} represents one Runtime from the RuntimeData returned from the REST API
*
* @author Matthew Davies - Initial contribution
*/
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
- * The {@link VenstarRunTimeData} represents the list of runtimes returned from the REST API.
+ * The {@link VenstarRuntimeData} represents the list of runtimes returned from the REST API.
*
* @author Matthew Davies - Initial contribution
*/
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link VerisureBinding} class defines common constants, which are
+ * The {@link VerisureBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author l3rum - Initial contribution
BridgeHandler bridgeHandler = getBridgeHandler();
if (bridgeHandler instanceof VeSyncBridgeHandler vesyncBridgeHandler) {
-
final String configMac = config.macId;
// Try to use the mac directly
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link VitotronicBinding} class defines common constants, which are
+ * The {@link VitotronicBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Stefan Andres - Initial contribution
import org.slf4j.LoggerFactory;
/**
- * The {@link VitotronicHandler} is responsible for handling commands, which are
+ * The {@link VitotronicThingHandler} is responsible for handling commands, which are
* sent to one of the channels.
*
* @author Stefan Andres - Initial contribution
/**
* Change the volume of the Vizio TV
*
- * @param the command JSON for the desired volue
+ * @param commandJSON the command JSON for the desired volue
* @return A PutResponse response object
* @throws VizioException
*
/**
* Change the currently selected input of the Vizio TV
*
- * @param the command JSON for the selected input
+ * @param commandJSON the command JSON for the selected input
* @return A PutResponse response object
* @throws VizioException
*
/**
* Launch a given streaming app on the Vizio TV
*
- * @param the VizioAppConfig data for the app to launch
+ * @param appConfig the VizioAppConfig data for the app to launch
* @return A PutResponse response object
* @throws VizioException
*
/**
* Send a key press command to the Vizio TV
*
- * @param the command JSON for the key press
+ * @param commandJSON the command JSON for the key press
* @return A PutResponse response object
* @throws VizioException
*
/**
* Start the pairing process to obtain an auth token from the TV
*
- * @param the deviceName that is displayed in the TV settings after the device is registered
- * @param the deviceId a unique number that identifies this pairing request
+ * @param deviceName the deviceName that is displayed in the TV settings after the device is registered
+ * @param deviceId the deviceId a unique number that identifies this pairing request
* @return A PairingStart response object
* @throws VizioException
*
/**
* Finish the pairing process by submitting the code that was displayed on the TV to obtain the auth token
*
- * @param the same deviceId that was used by startPairing()
- * @param the pairingCode that was displayed on the TV
- * @param the pairingToken returned by startPairing()
+ * @param deviceId the same deviceId that was used by startPairing()
+ * @param pairingCode the pairingCode that was displayed on the TV
+ * @param pairingToken the pairingToken returned by startPairing()
* @return A PairingComplete response object
* @throws VizioException
*
private void updateDaypart(int daypartIndex, String dayOrNight, String channelId, State state) {
int day = daypartIndex / 2;
- String dON = dayOrNight.equals("D") ? CH_GROUP_FORECAST_DAYPART_DAY : CH_GROUP_FORECAST_DAYPART_NIGHT;
+ String dON = "D".equals(dayOrNight) ? CH_GROUP_FORECAST_DAYPART_DAY : CH_GROUP_FORECAST_DAYPART_NIGHT;
updateChannel(CH_GROUP_FORECAST_DAY + String.valueOf(day) + dON + "#" + channelId, state);
}
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link WeatherUndergroundBinding} class defines common constants, which are
+ * The {@link WeatherUndergroundBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Laurent Garnier - Initial contribution
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link WemoBinding} class defines common constants, which are
+ * The {@link WemoBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Hans-Jörg Merk - Initial contribution
import com.google.gson.JsonSyntaxException;
/**
- * The {@link WolfSmartsetCloudConnector} class is used for connecting to the Wolf Smartset cloud service
+ * The {@link WolfSmartsetApi} class is used for connecting to the Wolf Smartset cloud service
*
* @author Bo Biene - Initial contribution
*/
import org.openhab.core.thing.ChannelUID;
/**
- * Subscribes to a chat and calls {@link AbstractBrokerHandler#triggerChannel(ChannelUID, String)} if a value has been
- * received.
+ * Subscribes to a chat and calls
+ * {@link org.openhab.binding.xmppclient.internal.handler.XMPPClientHandler#triggerChannel(ChannelUID, String)} if a
+ * value has been received.
*
* @author Pavel Gololobov - Initial contribution
*/
import org.osgi.service.component.annotations.Reference;
/**
- * The {@link YamahamusiccastHandlerFactory} is responsible for creating things and thing
+ * The {@link YamahaMusiccastHandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Lennert Coopman - Initial contribution
* Start the playback of the content which is usually selected by the means of the Navigation control class or
* which has been stopped by stop().
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void play() throws IOException, ReceivedMessageParseException;
/**
* Stop the currently playing content. Use start() to start again.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void stop() throws IOException, ReceivedMessageParseException;
/**
* Pause the currently playing content. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void pause() throws IOException, ReceivedMessageParseException;
/**
* Skip forward. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void skipFF() throws IOException, ReceivedMessageParseException;
/**
* Skip reverse. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void skipREV() throws IOException, ReceivedMessageParseException;
/**
* Next track. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void nextTrack() throws IOException, ReceivedMessageParseException;
/**
* Previous track. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void previousTrack() throws IOException, ReceivedMessageParseException;
}
* Select a preset channel.
*
* @param presetChannel The preset position [1,40]
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void selectItemByPresetNumber(int presetChannel) throws IOException, ReceivedMessageParseException;
}
* Select a DAB band by name.
*
* @param band The band name (e.g. FM or DAB)
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
void selectBandByName(String band) throws IOException, ReceivedMessageParseException;
}
/**
* Navigate back
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void goBack() throws IOException, ReceivedMessageParseException {
/**
* Navigate up
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void goUp() throws IOException, ReceivedMessageParseException {
/**
* Navigate down
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void goDown() throws IOException, ReceivedMessageParseException {
/**
* Navigate left. Not for all zones or functions available.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void goLeft() throws IOException, ReceivedMessageParseException {
/**
* Navigate right. Not for all zones or functions available.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void goRight() throws IOException, ReceivedMessageParseException {
/**
* Select current item. Not for all zones or functions available.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void selectCurrentItem() throws IOException, ReceivedMessageParseException {
/**
* Navigate to root menu
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public boolean goToRoot() throws IOException, ReceivedMessageParseException {
* some time because it retries the request for up to MENU_MAX_WAITING_TIME or the menu state reports
* "Ready", whatever comes first.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void update() throws IOException, ReceivedMessageParseException {
* Start the playback of the content which is usually selected by the means of the Navigation control class or
* which has been stopped by stop().
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void play() throws IOException, ReceivedMessageParseException {
/**
* Stop the currently playing content. Use start() to start again.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void stop() throws IOException, ReceivedMessageParseException {
/**
* Pause the currently playing content. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void pause() throws IOException, ReceivedMessageParseException {
/**
* Skip forward. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void skipFF() throws IOException, ReceivedMessageParseException {
/**
* Skip reverse. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void skipREV() throws IOException, ReceivedMessageParseException {
/**
* Next track. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void nextTrack() throws IOException, ReceivedMessageParseException {
/**
* Previous track. This is not available for streaming content like on NET_RADIO.
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void previousTrack() throws IOException, ReceivedMessageParseException {
/**
* Updates the playback information
*
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void update() throws IOException, ReceivedMessageParseException {
/**
* Updates the preset information
- *
- * @throws Exception
+ *
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void update() throws IOException, ReceivedMessageParseException {
* Select a preset channel.
*
* @param presetChannel The preset position [1,40]
- * @throws Exception
+ * @throws IOException
+ * @throws ReceivedMessageParseException
*/
@Override
public void selectItemByPresetNumber(int presetChannel) throws IOException, ReceivedMessageParseException {
import org.openhab.core.thing.ThingTypeUID;
/**
- * The {@link ZWayBinding} class defines common constants, which are
+ * The {@link ZWayBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Patrick Hecker - Initial contribution
* If the primary service does not yet exist, it won't be added to it. It's the resposibility
* of the caller to add characteristics when the primary service is created.
*
- * @param type
* @param characteristic
*/
@NonNullByDefault
* Takes item state as value and retrieves the key for that value from mapping.
* E.g. used to map StringItem value to HomeKit Enum
*
- * @param characteristicType characteristicType to identify item
+ * @param item item
* @param mapping mapping
* @param defaultValue default value if nothing found in mapping
* @param <T> type of the result derived from
* <li>Every weekday given by bbb at given left side time, randomized by right side time. Right side time has to be
* smaller than 12 hours
* <li>
- * <ul>
* Timers
+ * <ul>
* <li>PT[hh]:[mm]:[ss] Timer, expiring after given time
* <li>PT[hh]:[mm]:[ss] Timer, expiring after given time
* <li>PT[hh]:[mm]:[ss]A[hh]:[mm]:[ss] Timer with random element
/**
* Create a new user
*
- * @param apikey The hue "username"
+ * @param appName
+ * @param deviceName
*/
public HueUserAuth(String appName, String deviceName) {
this.name = appName + "#" + deviceName;
/**
* This implementation of {@link AbstractServlet} will handle any requests from the NEEO Brain. The brain will ask for
* any search results (performed by {@link NeeoBrainSearchService}) and requests state values, set
- * state values (performed by {@Link NeeoBrainService})
+ * state values (performed by {@link NeeoBrainService})
*
* @author Tim Roberts - Initial Contribution
*/
*
* The service creates tables automatically, one for numbers, and one for strings.
*
- * @see AbstractDynamoDBItem.fromState for details how different items are persisted
+ * @see AbstractDynamoDBItem#fromStateNew for details how different items are persisted
*
* @author Sami Salonen - Initial contribution
* @author Kai Kreuzer - Migration to 3.x
/**
* Create new PageOfInterestSubscriber
*
- * @param subscriber subscriber to get the page of interest
+ * @param future subscriber to get the page of interest
* @param pageIndex page index that we want subscribe
* @param pageSize page size
*/
criteria.setItemName(item.getName());
try {
-
// Old tables do not exit --> resolves to new schema
assertEquals(ExpectedTableSchema.NEW, resolveMaybeLegacy(legacyService, executor));
@SuppressWarnings("null")
public void storeItemWithDifferentTypes() {
-
try {
// First writing two values with string item
{
* Write points to database
*
* @param influxPoints {@link List<InfluxPoint>} to write
- * @returns <code>true</code> if points have been written, <code>false</code> otherwise
+ * @return <code>true</code> if points have been written, <code>false</code> otherwise
*/
boolean write(List<InfluxPoint> influxPoints);
/**
* Transforms the input <code>source</code> by JSonPath expression.
*
- * @param function JsonPath expression
+ * @param jsonPathExpression JsonPath expression
* @param source String which contains JSON
* @throws TransformationException If the JsonPath expression is invalid, an {@link InvalidPathException} is thrown,
* which is encapsulated in a {@link TransformationException}.
import org.openhab.core.transform.TransformationException;
/**
- * @author Gaël L'hopital
+ * @author Gaël L'hopital - Initial contribution
*/
public class JSonPathTransformationServiceTest {
* <p>
* <b>Note:</b> the given Regular Expression must contain exactly one group!
*
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
@NonNullByDefault
@Component(property = { "openhab.transform=REGEX" })
package org.openhab.transform.regex.internal;
/**
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
public abstract class AbstractTransformationServiceTest {
import org.openhab.core.transform.TransformationException;
/**
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
public class RegExTransformationServiceTest extends AbstractTransformationServiceTest {
* The implementation of {@link TransformationService} which transforms the
* input by matching it between limits of ranges in a scale file
*
- * @author Gaël L'hopital
+ * @author Gaël L'hopital - Initial contribution
* @author Markus Rathgeb - drop usage of Guava
*/
@Component(service = { TransformationService.class, ConfigOptionProvider.class }, property = {
import org.slf4j.LoggerFactory;
/**
- * Profile to offer the {@link VATTransformationService} on an ItemChannelLink.
+ * Profile to offer the {@link VATTransformationProfile} on an ItemChannelLink.
*
* @author Jacob Laursen - Initial contribution
*/
* <p>
* The implementation of {@link TransformationService} which transforms the input by XPath Expressions.
*
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
@NonNullByDefault
@Component(property = { "openhab.transform=XPATH" })
package org.openhab.transform.xpath.internal;
/**
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
public abstract class AbstractTransformationServiceTest {
import org.openhab.core.transform.TransformationException;
/**
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
public class XPathTransformationServiceTest extends AbstractTransformationServiceTest {
* <p>
* The implementation of {@link TransformationService} which transforms the input by XSLT.
*
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
@NonNullByDefault
@Component(property = { "openhab.transform=XSLT" })
package org.openhab.transform.xslt.internal;
/**
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
public abstract class AbstractTransformationServiceTest {
import org.openhab.core.transform.TransformationException;
/**
- * @author Thomas.Eichstaedt-Engelen
+ * @author Thomas.Eichstaedt-Engelen - Initial contribution
*/
public class XsltTransformationServiceTest extends AbstractTransformationServiceTest {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
public Locale getLocale() {
int underscore = token.indexOf('_');
if (-1 == underscore) {
// Check we're dealing with <Label>
- if (!token.equals("en-scotland")) {
+ if (!"en-scotland".equals(token)) {
if (null == this.label) {
this.label = token;
} else {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
public Locale getLocale() {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
public Locale getLocale() {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
public Locale getLocale() {
/**
* Tests for the Astro Channels state
*
- * @See {@link AstroParametrizedTestCases}
+ * @see {@link AstroParametrizedTestCases}
* @author Petar Valchev - Initial contribution
* @author Svilen Valkanov - Reworked to plain unit tests
* @author Erdoan Hadzhiyusein - Adapted the class to work with the new DateTimeType
projects / openhab-addons.git / commitdiff