Cleanup Java code (#2263)

This cleanup includes: * Fix deprecations * Fix JavaDocs * Remove redundant toString calls * Remove redundant semicolons * Simplify boolean expressions * Use diamond operator * Use enhanced for loops * Use instanceof pattern matching * Use isEmpty instead of 0 comparisons * Use lambdas * Use static inner classes * Use StandardCharsets Also adds the SA_LOCAL_SELF_COMPARISON suppression similar as used in other repositories for spotbugs/spotbugs#1992. Signed-off-by: Wouter Born <github@maindrain.net>
openhab · Jan 17, 2024 · ef52364 · ef52364
1 parent f912de5
commit ef52364
Show file tree

Hide file tree

Showing 45 changed files with 169 additions and 264 deletions.
diff --git a/...b.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java b/...b.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/AbstractWidgetRenderer.java
@@ -13,7 +13,6 @@
 package org.openhab.ui.basic.internal.render;
 
 import java.io.IOException;
-import java.io.UnsupportedEncodingException;
 import java.net.MalformedURLException;
 import java.net.URISyntaxException;
 import java.net.URL;
@@ -35,6 +34,7 @@
 import org.openhab.core.model.sitemap.sitemap.Widget;
 import org.openhab.core.types.State;
 import org.openhab.core.ui.items.ItemUIRegistry;
+import org.openhab.core.util.ColorUtil;
 import org.openhab.ui.basic.internal.WebAppConfig;
 import org.openhab.ui.basic.render.RenderException;
 import org.openhab.ui.basic.render.WidgetRenderer;
@@ -106,7 +106,7 @@ public ItemUIRegistry getItemUIRegistry() {
     /**
      * Replace some common values in the widget template
      *
-     * @param snippet snippet HTML code
+     * @param originalSnippet snippet HTML code
      * @param w corresponding widget
      * @return HTML code
      */
@@ -117,7 +117,7 @@ protected String preprocessSnippet(String originalSnippet, Widget w) {
     /**
      * Replace some common values in the widget template
      *
-     * @param snippet snippet HTML code
+     * @param originalSnippet snippet HTML code
      * @param w corresponding widget
      * @param ignoreStateForIcon true if state has to be ignored when requesting the icon
      * @return HTML code
@@ -338,20 +338,15 @@ protected String escapeURL(@Nullable String string) {
             return "";
         }
 
-        try {
-            return URLEncoder.encode(string, "UTF-8");
-        } catch (UnsupportedEncodingException use) {
-            logger.warn("Cannot escape string '{}'. Returning unmodified string.", string);
-            return string;
-        }
+        return URLEncoder.encode(string, StandardCharsets.UTF_8);
     }
 
     /**
      * Process the color tags - labelcolor and valuecolor
      *
      * @param w
      *            The widget to process
-     * @param snippet
+     * @param originalSnippet
      *            The snippet to translate
      * @return The updated snippet
      */
@@ -423,9 +418,8 @@ protected String processColor(Widget w, String originalSnippet) {
     }
 
     protected @Nullable String getRGBHexCodeFromItemState(@Nullable State itemState) {
-        if (itemState instanceof HSBType) {
-            HSBType hsbState = (HSBType) itemState;
-            return "#" + Integer.toHexString(hsbState.getRGB()).substring(2);
+        if (itemState instanceof HSBType hsbState) {
+            return "#" + Integer.toHexString(ColorUtil.hsbTosRgb(hsbState)).substring(2);
         }
         return null;
     }

diff --git a/...enhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ButtongridRenderer.java b/...enhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ButtongridRenderer.java
@@ -185,11 +185,10 @@ private String buildButton(String item, @Nullable String lab, String cmd, @Nulla
             throws RenderException {
         String button = getSnippet("button");
 
-        String command = cmd;
         String label = lab == null ? cmd : lab;
 
         button = button.replace("%item%", item);
-        button = button.replace("%cmd%", escapeHtml(command));
+        button = button.replace("%cmd%", escapeHtml(cmd));
         String buttonClass = "buttongrid-button";
         String style = "";
         if (icon == null || !config.isIconsEnabled()) {

diff --git a/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ImageRenderer.java b/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ImageRenderer.java
@@ -59,7 +59,7 @@ public boolean canRender(Widget w) {
     @Override
     public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) throws RenderException {
         Image image = (Image) w;
-        String snippet = (image.getChildren().size() > 0) ? getSnippet("image_link") : getSnippet("image");
+        String snippet = (!image.getChildren().isEmpty()) ? getSnippet("image_link") : getSnippet("image");
 
         boolean showHeaderRow = image.getLabel() != null;
         snippet = snippet.replace("%header_visibility_class%",

diff --git a/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/InputRenderer.java b/...rg.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/InputRenderer.java
@@ -134,7 +134,7 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
         State state = itemUIRegistry.getState(w);
 
         String prefix = getPrefix(w);
-        boolean hasUnit = item instanceof NumberItem ? (((NumberItem) item).getDimension() != null) : false;
+        boolean hasUnit = item instanceof NumberItem && (((NumberItem) item).getDimension() != null);
         String postfix = hasUnit ? "" : getPostfix(w);
         String prefixSnippet = !prefix.isBlank()
                 ? "<span %valuestyle% class=\"mdl-form__input-prefix\">" + prefix + "</span>"
@@ -181,8 +181,7 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
 
         String unitSnippet = "";
         String unit = "";
-        if (item instanceof NumberItem) {
-            NumberItem numberItem = (NumberItem) item;
+        if (item instanceof NumberItem numberItem) {
             if (numberItem.getDimension() != null) {
                 unit = getUnit(w, numberItem);
                 if ("number".equals(inputHint)) {
@@ -211,7 +210,7 @@ private String parseNumber(String value) {
             if (COMMA_SEPARATOR_PATTERN.matcher(newValue).find()) {
                 newValue = newValue.replace("/\\./g", "").replace(",", ".");
             }
-            if (unitValue.length() > 0) {
+            if (!unitValue.isEmpty()) {
                 newValue = newValue + " " + unitValue;
             }
             return newValue;
@@ -230,8 +229,7 @@ private String getValue(Widget w, Item item) {
                 value = "-";
             }
         }
-        if (item instanceof NumberItem) {
-            NumberItem numberItem = (NumberItem) item;
+        if (item instanceof NumberItem numberItem) {
             if (numberItem.getDimension() != null) {
                 String[] stateArray = value.split(" ");
                 if (stateArray.length <= 1) {
@@ -245,7 +243,7 @@ private String getValue(Widget w, Item item) {
 
     private String cleanValue(String value, Widget w, Item item) {
         String prefix = getPrefix(w);
-        boolean hasUnit = item instanceof NumberItem ? (((NumberItem) item).getDimension() != null) : false;
+        boolean hasUnit = item instanceof NumberItem && (((NumberItem) item).getDimension() != null);
         String postfix = hasUnit ? "" : getPostfix(w);
         String newValue = value.startsWith(prefix) ? value.substring(prefix.length()) : value;
         newValue = value.endsWith(postfix) ? newValue.substring(0, newValue.lastIndexOf(postfix)) : newValue;

diff --git a/....openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/MapviewRenderer.java b/....openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/MapviewRenderer.java
@@ -69,8 +69,7 @@ public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) th
         snippet = processColor(w, snippet);
 
         State state = itemUIRegistry.getState(mapview);
-        if (state instanceof PointType) {
-            PointType pointState = (PointType) state;
+        if (state instanceof PointType pointState) {
             double latitude = pointState.getLatitude().doubleValue();
             double longitude = pointState.getLongitude().doubleValue();
             snippet = snippet.replace("%url%", MAP_URL);

diff --git a/...org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/PageRenderer.java b/...org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/PageRenderer.java
@@ -136,12 +136,12 @@ public StringBuilder processPage(String id, String sitemap, String label, EList<
         return preChildren.append(postChildren);
     }
 
-    private void processChildren(StringBuilder sb_pre, StringBuilder sb_post, EList<Widget> children, String sitemap)
+    private void processChildren(StringBuilder sbPre, StringBuilder sbPost, EList<Widget> children, String sitemap)
             throws RenderException {
         // put a single frame around all children widgets, if there are no explicit frames
         if (!children.isEmpty()) {
-            EObject firstChild = children.get(0);
-            EObject parent = itemUIRegistry.getParent((Widget) firstChild);
+            Widget firstChild = children.get(0);
+            EObject parent = itemUIRegistry.getParent(firstChild);
             if (!(firstChild instanceof Frame || parent instanceof Frame || parent instanceof Sitemap)) {
                 String frameSnippet = getSnippet("frame");
                 frameSnippet = frameSnippet.replace("%widget_id%", "");
@@ -150,8 +150,8 @@ private void processChildren(StringBuilder sb_pre, StringBuilder sb_post, EList<
 
                 String[] parts = frameSnippet.split("%children%");
                 if (parts.length > 1) {
-                    sb_pre.append(parts[0]);
-                    sb_post.insert(0, parts[1]);
+                    sbPre.append(parts[0]);
+                    sbPost.insert(0, parts[1]);
                 }
                 if (parts.length > 2) {
                     logger.error("Snippet 'frame' contains multiple %children% sections, but only one is allowed!");
@@ -185,10 +185,10 @@ private void processChildren(StringBuilder sb_pre, StringBuilder sb_post, EList<
                             widgetType);
                 }
                 processChildren(newPre, newPost, nextChildren, sitemap);
-                sb_pre.append(newPre);
-                sb_pre.append(newPost);
+                sbPre.append(newPre);
+                sbPre.append(newPost);
             } else {
-                sb_pre.append(widgetSB);
+                sbPre.append(widgetSB);
             }
         }
     }

diff --git a/...org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/TextRenderer.java b/...org.openhab.ui.basic/src/main/java/org/openhab/ui/basic/internal/render/TextRenderer.java
@@ -52,7 +52,7 @@ public boolean canRender(Widget w) {
     @Override
     public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) throws RenderException {
         Text text = (Text) w;
-        String snippet = (text.getChildren().size() > 0) ? getSnippet("text_link") : getSnippet("text");
+        String snippet = (!text.getChildren().isEmpty()) ? getSnippet("text_link") : getSnippet("text");
 
         snippet = preprocessSnippet(snippet, w);
         snippet = snippet.replace("%id%", itemUIRegistry.getWidgetId(w));

diff --git a/...openhab.ui.cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/ManagerSettings.java b/...openhab.ui.cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/ManagerSettings.java
@@ -112,8 +112,8 @@ private void refreshMounts() {
                 String[] parts = value.split(":");
                 String source = parts[0];
                 if (!source.contains("..") || (allowLookup && lookupMount.matcher(source).find())) {
-                    boolean writeable = parts.length > 1 ? parts[1].contains("w") : false;
-                    boolean showSubDirs = parts.length > 1 ? parts[1].contains("s") : false;
+                    boolean writeable = parts.length > 1 && parts[1].contains("w");
+                    boolean showSubDirs = parts.length > 1 && parts[1].contains("s");
                     if (source.startsWith(File.separator)) {
                         source = source.substring(1);
                     }

diff --git a/...cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/StateBeanMessageBodyWriter.java b/...cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/StateBeanMessageBodyWriter.java
@@ -70,14 +70,12 @@ public void writeTo(Object stateBean, Class<?> type, Type genericType, Annotatio
      */
     public String serialize(Object bean) {
         String msg = "{\"d\":{";
-        if (bean instanceof StateBean) {
-            StateBean stateBean = (StateBean) bean;
+        if (bean instanceof StateBean stateBean) {
             msg += "\"" + stateBean.name + "\":\"" + stateBean.state + "\"";
         } else if (bean instanceof List<?>) {
             List<String> states = new ArrayList<>();
             for (Object bo : (List<?>) bean) {
-                if (bo instanceof StateBean) {
-                    StateBean stateBean = (StateBean) bo;
+                if (bo instanceof StateBean stateBean) {
                     states.add("\"" + stateBean.name + "\":\"" + stateBean.state + "\"");
                 }
             }

diff --git a/...cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/ChartResource.java b/...cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/ChartResource.java
@@ -252,8 +252,7 @@ public Object getRrdSeries(QueryablePersistenceService persistenceService, Item
         try {
             List<String> itemNames = new ArrayList<>();
 
-            if (item instanceof GroupItem) {
-                GroupItem groupItem = (GroupItem) item;
+            if (item instanceof GroupItem groupItem) {
                 for (Item member : groupItem.getMembers()) {
                     itemNames.add(member.getName());
                 }

diff --git a/...su/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/DataProviderResource.java b/...su/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/DataProviderResource.java
@@ -154,7 +154,7 @@ public List<String> getDesigns() {
         // all designs
         File designDir = ManagerSettings.getInstance().getDesignFolder();
         File[] designs = designDir.listFiles();
-        List<String> res = new ArrayList<String>();
+        List<String> res = new ArrayList<>();
         if (designs != null) {
             Arrays.sort(designs);
             for (File design : designs) {

diff --git a/...etvisu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/EventBroadcaster.java b/...etvisu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/EventBroadcaster.java
@@ -30,7 +30,6 @@ public interface EventBroadcaster {
      * Broadcasts an event described by the given parameters to all currently
      * listening clients.
      *
-     * @param item the item that should be broadcasted
      * @param eventObject bean that can be converted to a JSON object.
      */
     void broadcastEvent(final Object eventObject);

diff --git a/...isu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/MultipartRequestMap.java b/...isu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/MultipartRequestMap.java
@@ -89,7 +89,7 @@ private void processFilePart(Part part, String fileName) throws IOException {
         tempFile.deleteOnExit();
 
         try (BufferedInputStream input = new BufferedInputStream(part.getInputStream(), 8192);
-                BufferedOutputStream output = new BufferedOutputStream(new FileOutputStream(tempFile), 8192);) {
+                BufferedOutputStream output = new BufferedOutputStream(new FileOutputStream(tempFile), 8192)) {
             byte[] buffer = new byte[8192];
             for (int length = 0; ((length = input.read(buffer)) > 0);) {
                 output.write(buffer, 0, length);

diff --git a/....cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/ReadResource.java b/....cometvisu/src/main/java/org/openhab/ui/cometvisu/internal/backend/rest/ReadResource.java
@@ -127,9 +127,6 @@ protected void removeItemFactory(ItemFactory itemFactory) {
      * Subscribes the connecting client to the stream of events filtered by the
      * given eventFilter.
      *
-     * @param eventFilter
-     * @return {@link EventOutput} object associated with the incoming
-     *         connection.
      * @throws IOException
      * @throws InterruptedException
      */
@@ -238,7 +235,6 @@ public void unregisterItem(Item item) {
      * Broadcasts an event described by the given parameters to all currently
      * listening clients.
      *
-     * @param item the item which has changed
      * @param eventObject bean that can be converted to a JSON object.
      */
     @Override
@@ -248,9 +244,7 @@ public void broadcastEvent(final Object eventObject) {
             return;
         }
 
-        executorService.execute(() -> {
-            broadcaster.send(SseUtil.buildEvent(sse.newEventBuilder(), eventObject));
-        });
+        executorService.execute(() -> broadcaster.send(SseUtil.buildEvent(sse.newEventBuilder(), eventObject)));
     }
 
     @Override