[melcloud] Improve null handling (openhab#17295)

* Add null annotations Signed-off-by: Leo Siepel <[email protected]>
apella12 · Sep 9, 2024 · d2d2e63 · d2d2e63
1 parent 27e0887
commit d2d2e63
Show file tree

Hide file tree

Showing 25 changed files with 154 additions and 128 deletions.
diff --git a/...elcloud/src/main/java/org/openhab/binding/melcloud/internal/MelCloudBindingConstants.java b/...elcloud/src/main/java/org/openhab/binding/melcloud/internal/MelCloudBindingConstants.java
@@ -17,6 +17,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.openhab.core.thing.ThingTypeUID;
 
 /**
@@ -26,6 +27,7 @@
  * @author Luca Calcaterra - Initial contribution
  * @author Wietse van Buitenen - Added heatpump device
  */
+@NonNullByDefault
 public class MelCloudBindingConstants {
 
     private static final String BINDING_ID = "melcloud";

diff --git a/....melcloud/src/main/java/org/openhab/binding/melcloud/internal/MelCloudHandlerFactory.java b/....melcloud/src/main/java/org/openhab/binding/melcloud/internal/MelCloudHandlerFactory.java
@@ -14,6 +14,7 @@
 
 import static org.openhab.binding.melcloud.internal.MelCloudBindingConstants.*;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
 import org.eclipse.jdt.annotation.Nullable;
 import org.openhab.binding.melcloud.internal.handler.MelCloudAccountHandler;
 import org.openhab.binding.melcloud.internal.handler.MelCloudDeviceHandler;
@@ -33,6 +34,7 @@
  * @author Luca Calcaterra - Initial contribution
  * @author Wietse van Buitenen - Added heatpump device
  */
+@NonNullByDefault
 @Component(configurationPid = "binding.melcloud", service = ThingHandlerFactory.class)
 public class MelCloudHandlerFactory extends BaseThingHandlerFactory {
 

diff --git a/....melcloud/src/main/java/org/openhab/binding/melcloud/internal/api/MelCloudConnection.java b/....melcloud/src/main/java/org/openhab/binding/melcloud/internal/api/MelCloudConnection.java
@@ -19,13 +19,15 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
 import java.util.Properties;
 
-import org.openhab.binding.melcloud.internal.api.json.Device;
-import org.openhab.binding.melcloud.internal.api.json.DeviceStatus;
-import org.openhab.binding.melcloud.internal.api.json.HeatpumpDeviceStatus;
-import org.openhab.binding.melcloud.internal.api.json.ListDevicesResponse;
-import org.openhab.binding.melcloud.internal.api.json.LoginClientResponse;
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.binding.melcloud.internal.api.dto.Device;
+import org.openhab.binding.melcloud.internal.api.dto.DeviceStatus;
+import org.openhab.binding.melcloud.internal.api.dto.HeatpumpDeviceStatus;
+import org.openhab.binding.melcloud.internal.api.dto.ListDevicesResponse;
+import org.openhab.binding.melcloud.internal.api.dto.LoginClientResponse;
 import org.openhab.binding.melcloud.internal.exceptions.MelCloudCommException;
 import org.openhab.binding.melcloud.internal.exceptions.MelCloudLoginException;
 import org.openhab.core.io.net.http.HttpUtil;
@@ -45,6 +47,7 @@
  * @author Pauli Anttila - Refactoring
  * @author Wietse van Buitenen - Return all devices, added heatpump device
  */
+@NonNullByDefault
 public class MelCloudConnection {
 
     private static final String LOGIN_URL = "https://app.melcloud.com/Mitsubishi.Wifi.Client/Login/ClientLogin";
@@ -54,18 +57,18 @@ public class MelCloudConnection {
     private static final int TIMEOUT_MILLISECONDS = 10000;
 
     // Gson objects are safe to share across threads and are somewhat expensive to construct. Use a single instance.
-    private static final Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation()
+    private static final Gson GSON = new GsonBuilder().excludeFieldsWithoutExposeAnnotation()
             .setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE).create();
 
     private final Logger logger = LoggerFactory.getLogger(MelCloudConnection.class);
 
     private boolean isConnected = false;
-    private String sessionKey;
+    private String sessionKey = "";
 
     public void login(String username, String password, int languageId)
             throws MelCloudCommException, MelCloudLoginException {
         setConnected(false);
-        sessionKey = null;
+        sessionKey = "";
         JsonObject jsonReq = new JsonObject();
         jsonReq.addProperty("Email", username);
         jsonReq.addProperty("Password", password);
@@ -79,7 +82,7 @@ public void login(String username, String password, int languageId)
             String loginResponse = HttpUtil.executeUrl("POST", LOGIN_URL, null, data, "application/json",
                     TIMEOUT_MILLISECONDS);
             logger.debug("Login response: {}", loginResponse);
-            LoginClientResponse resp = gson.fromJson(loginResponse, LoginClientResponse.class);
+            LoginClientResponse resp = Objects.requireNonNull(GSON.fromJson(loginResponse, LoginClientResponse.class));
             if (resp.getErrorId() != null) {
                 String errorMsg = String.format("Login failed, error code: %s", resp.getErrorId());
                 if (resp.getErrorMessage() != null) {
@@ -101,7 +104,7 @@ public List<Device> fetchDeviceList() throws MelCloudCommException {
                     TIMEOUT_MILLISECONDS);
             logger.debug("Device list response: {}", response);
             List<Device> devices = new ArrayList<>();
-            ListDevicesResponse[] buildings = gson.fromJson(response, ListDevicesResponse[].class);
+            ListDevicesResponse[] buildings = GSON.fromJson(response, ListDevicesResponse[].class);
             Arrays.asList(buildings).forEach(building -> {
                 if (building.getStructure().getDevices() != null) {
                     devices.addAll(building.getStructure().getDevices());
@@ -137,7 +140,7 @@ public DeviceStatus fetchDeviceStatus(int deviceId, int buildingId) throws MelCl
         try {
             String response = HttpUtil.executeUrl("GET", url, getHeaderProperties(), null, null, TIMEOUT_MILLISECONDS);
             logger.debug("Device status response: {}", response);
-            return gson.fromJson(response, DeviceStatus.class);
+            return Objects.requireNonNull(GSON.fromJson(response, DeviceStatus.class));
         } catch (IOException | JsonSyntaxException e) {
             setConnected(false);
             throw new MelCloudCommException("Error occurred during device status fetch", e);
@@ -146,14 +149,14 @@ public DeviceStatus fetchDeviceStatus(int deviceId, int buildingId) throws MelCl
 
     public DeviceStatus sendDeviceStatus(DeviceStatus deviceStatus) throws MelCloudCommException {
         assertConnected();
-        String content = gson.toJson(deviceStatus, DeviceStatus.class);
+        String content = GSON.toJson(deviceStatus, DeviceStatus.class);
         logger.debug("Sending device status: {}", content);
         InputStream data = new ByteArrayInputStream(content.getBytes(StandardCharsets.UTF_8));
         try {
             String response = HttpUtil.executeUrl("POST", DEVICE_URL + "/SetAta", getHeaderProperties(), data,
                     "application/json", TIMEOUT_MILLISECONDS);
             logger.debug("Device status sending response: {}", response);
-            return gson.fromJson(response, DeviceStatus.class);
+            return Objects.requireNonNull(GSON.fromJson(response, DeviceStatus.class));
         } catch (IOException | JsonSyntaxException e) {
             setConnected(false);
             throw new MelCloudCommException("Error occurred during device command sending", e);
@@ -166,7 +169,7 @@ public HeatpumpDeviceStatus fetchHeatpumpDeviceStatus(int deviceId, int building
         try {
             String response = HttpUtil.executeUrl("GET", url, getHeaderProperties(), null, null, TIMEOUT_MILLISECONDS);
             logger.debug("Device heatpump status response: {}", response);
-            return gson.fromJson(response, HeatpumpDeviceStatus.class);
+            return Objects.requireNonNull(GSON.fromJson(response, HeatpumpDeviceStatus.class));
         } catch (IOException | JsonSyntaxException e) {
             setConnected(false);
             throw new MelCloudCommException("Error occurred during heatpump device status fetch", e);
@@ -176,14 +179,14 @@ public HeatpumpDeviceStatus fetchHeatpumpDeviceStatus(int deviceId, int building
     public HeatpumpDeviceStatus sendHeatpumpDeviceStatus(HeatpumpDeviceStatus heatpumpDeviceStatus)
             throws MelCloudCommException {
         assertConnected();
-        String content = gson.toJson(heatpumpDeviceStatus, HeatpumpDeviceStatus.class);
+        String content = GSON.toJson(heatpumpDeviceStatus, HeatpumpDeviceStatus.class);
         logger.debug("Sending heatpump device status: {}", content);
         InputStream data = new ByteArrayInputStream(content.getBytes(StandardCharsets.UTF_8));
         try {
             String response = HttpUtil.executeUrl("POST", DEVICE_URL + "/SetAtw", getHeaderProperties(), data,
                     "application/json", TIMEOUT_MILLISECONDS);
             logger.debug("Device heatpump status sending response: {}", response);
-            return gson.fromJson(response, HeatpumpDeviceStatus.class);
+            return Objects.requireNonNull(GSON.fromJson(response, HeatpumpDeviceStatus.class));
         } catch (IOException | JsonSyntaxException e) {
             setConnected(false);
             throw new MelCloudCommException("Error occurred during heatpump device command sending", e);

diff --git a/...ding/melcloud/internal/api/json/Area.java → ...nding/melcloud/internal/api/dto/Area.java b/...ding/melcloud/internal/api/json/Area.java → ...nding/melcloud/internal/api/dto/Area.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.util.List;
 

diff --git a/...ng/melcloud/internal/api/json/Device.java → ...ing/melcloud/internal/api/dto/Device.java b/...ng/melcloud/internal/api/json/Device.java → ...ing/melcloud/internal/api/dto/Device.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.security.Permissions;
 import java.util.List;

diff --git a/...lcloud/internal/api/json/DeviceProps.java → ...elcloud/internal/api/dto/DeviceProps.java b/...lcloud/internal/api/json/DeviceProps.java → ...elcloud/internal/api/dto/DeviceProps.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.util.List;
 

diff --git a/...cloud/internal/api/json/DeviceStatus.java → ...lcloud/internal/api/dto/DeviceStatus.java b/...cloud/internal/api/json/DeviceStatus.java → ...lcloud/internal/api/dto/DeviceStatus.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.util.List;
 

diff --git a/...ing/melcloud/internal/api/json/Floor.java → ...ding/melcloud/internal/api/dto/Floor.java b/...ing/melcloud/internal/api/json/Floor.java → ...ding/melcloud/internal/api/dto/Floor.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.util.List;
 

diff --git a/...ternal/api/json/HeatpumpDeviceStatus.java → ...nternal/api/dto/HeatpumpDeviceStatus.java b/...ternal/api/json/HeatpumpDeviceStatus.java → ...nternal/api/dto/HeatpumpDeviceStatus.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.util.List;
 

diff --git a/...nternal/api/json/ListDevicesResponse.java → ...internal/api/dto/ListDevicesResponse.java b/...nternal/api/json/ListDevicesResponse.java → ...internal/api/dto/ListDevicesResponse.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import com.google.gson.annotations.Expose;
 import com.google.gson.annotations.SerializedName;

diff --git a/...nternal/api/json/LoginClientResponse.java → ...internal/api/dto/LoginClientResponse.java b/...nternal/api/json/LoginClientResponse.java → ...internal/api/dto/LoginClientResponse.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.util.List;
 

diff --git a/...melcloud/internal/api/json/LoginData.java → .../melcloud/internal/api/dto/LoginData.java b/...melcloud/internal/api/json/LoginData.java → .../melcloud/internal/api/dto/LoginData.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import com.google.gson.annotations.Expose;
 

diff --git a/...ng/melcloud/internal/api/json/Preset.java → ...ing/melcloud/internal/api/dto/Preset.java b/...ng/melcloud/internal/api/json/Preset.java → ...ing/melcloud/internal/api/dto/Preset.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import com.google.gson.annotations.Expose;
 

diff --git a/...ternal/api/json/QuantizedCoordinates.java → ...nternal/api/dto/QuantizedCoordinates.java b/...ternal/api/json/QuantizedCoordinates.java → ...nternal/api/dto/QuantizedCoordinates.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import com.google.gson.annotations.Expose;
 

diff --git a/...melcloud/internal/api/json/Structure.java → .../melcloud/internal/api/dto/Structure.java b/...melcloud/internal/api/json/Structure.java → .../melcloud/internal/api/dto/Structure.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import java.util.List;
 

diff --git a/...internal/api/json/WeatherObservation.java → .../internal/api/dto/WeatherObservation.java b/...internal/api/json/WeatherObservation.java → .../internal/api/dto/WeatherObservation.java
@@ -10,7 +10,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0
  */
-package org.openhab.binding.melcloud.internal.api.json;
+package org.openhab.binding.melcloud.internal.api.dto;
 
 import com.google.gson.annotations.Expose;
 

diff --git a/...g.melcloud/src/main/java/org/openhab/binding/melcloud/internal/config/AcDeviceConfig.java b/...g.melcloud/src/main/java/org/openhab/binding/melcloud/internal/config/AcDeviceConfig.java
@@ -12,17 +12,21 @@
  */
 package org.openhab.binding.melcloud.internal.config;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
 /**
  * Config class for an A.C. device.
  *
  * @author Pauli Anttila - Initial Contribution
  *
  */
+@NonNullByDefault
 public class AcDeviceConfig {
 
-    public Integer deviceID;
-    public Integer buildingID;
-    public Integer pollingInterval;
+    public Integer deviceID = 0;
+    public @Nullable Integer buildingID;
+    public Integer pollingInterval = 360;
 
     @Override
     public String toString() {

diff --git a/...ng.melcloud/src/main/java/org/openhab/binding/melcloud/internal/config/AccountConfig.java b/...ng.melcloud/src/main/java/org/openhab/binding/melcloud/internal/config/AccountConfig.java
@@ -12,27 +12,27 @@
  */
 package org.openhab.binding.melcloud.internal.config;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
 /**
  * Config class for MELCloud account parameters.
  *
  * @author Pauli Anttila - Initial Contribution
  *
  */
+@NonNullByDefault
 public class AccountConfig {
 
-    public String username;
-    public String password;
-    public int language;
+    public String username = "";
+    public String password = "";
+    public int language = 0;
 
     @Override
     public String toString() {
         return "[username=" + username + ", password=" + getPasswordForPrinting() + ", languageId=" + language + "]";
     }
 
     private String getPasswordForPrinting() {
-        if (password != null) {
-            return password.isEmpty() ? "<empty>" : "*********";
-        }
-        return "<null>";
+        return password.isEmpty() ? "<empty>" : "*********";
     }
 }
diff --git a/...loud/src/main/java/org/openhab/binding/melcloud/internal/config/HeatpumpDeviceConfig.java b/...loud/src/main/java/org/openhab/binding/melcloud/internal/config/HeatpumpDeviceConfig.java
@@ -12,16 +12,20 @@
  */
 package org.openhab.binding.melcloud.internal.config;
 
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
 /**
  * Config class for a Heatpump device.
  *
  * @author Wietse van Buitenen - Initial Contribution
  *
  */
+@NonNullByDefault
 public class HeatpumpDeviceConfig {
-    public Integer deviceID;
-    public Integer buildingID;
-    public Integer pollingInterval;
+    public Integer deviceID = 0;
+    public @Nullable Integer buildingID;
+    public Integer pollingInterval = 360;
 
     @Override
     public String toString() {