Eliminate SonarQube warnings

wcm-io · Jan 19, 2024 · c07b8b9 · c07b8b9
1 parent f0126f4
commit c07b8b9
Show file tree

Hide file tree

Showing 18 changed files with 69 additions and 38 deletions.
diff --git a/src/main/java/io/wcm/handler/commons/dom/AbstractNonSelfClosingHtmlElement.java b/src/main/java/io/wcm/handler/commons/dom/AbstractNonSelfClosingHtmlElement.java
@@ -27,6 +27,7 @@
  * @param <T> Class derived from HtmlElement
  */
 @ConsumerType
+@SuppressWarnings("java:S110") // # parent inheritance
 public abstract class AbstractNonSelfClosingHtmlElement<T extends HtmlElement> extends HtmlElement<T> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Anchor.java b/src/main/java/io/wcm/handler/commons/dom/Anchor.java
@@ -25,6 +25,7 @@
  * Html anchor (a) element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Anchor extends AbstractNonSelfClosingHtmlElement<Anchor> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Area.java b/src/main/java/io/wcm/handler/commons/dom/Area.java
@@ -25,6 +25,7 @@
  * Html area element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Area extends HtmlElement<Area> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Audio.java b/src/main/java/io/wcm/handler/commons/dom/Audio.java
@@ -25,6 +25,7 @@
  * Html audio (audio) element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Audio extends AbstractNonSelfClosingHtmlElement<Audio> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Div.java b/src/main/java/io/wcm/handler/commons/dom/Div.java
@@ -25,6 +25,7 @@
  * Html div element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Div extends AbstractNonSelfClosingHtmlElement<Div> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/FigCaption.java b/src/main/java/io/wcm/handler/commons/dom/FigCaption.java
@@ -25,6 +25,7 @@
  * Html figure caption (figcaption) element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class FigCaption extends AbstractNonSelfClosingHtmlElement<FigCaption> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Figure.java b/src/main/java/io/wcm/handler/commons/dom/Figure.java
@@ -25,6 +25,7 @@
  * Html figure (figure) element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Figure extends AbstractNonSelfClosingHtmlElement<Figure> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/HtmlElement.java b/src/main/java/io/wcm/handler/commons/dom/HtmlElement.java
@@ -30,8 +30,8 @@
  * This element class is an extension of JDOM Element.
  * @param <T> Class derived from HtmlElement
  */
-@SuppressWarnings("unchecked")
 @ConsumerType
+@SuppressWarnings("java:S110") // # parent inheritance
 public class HtmlElement<T extends HtmlElement> extends AbstractHtmlElementFactory<T> {
   private static final long serialVersionUID = 1L;
 
@@ -76,6 +76,7 @@ protected final boolean getEmptyAttributeValueAsBoolean(String attributeName) {
    * @param value Attribute value as boolean
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   protected final T setEmptyAttributeValueAsBoolean(String attributeName, boolean value) {
     if (value) {
       setAttribute(attributeName, attributeName.toLowerCase());
@@ -99,6 +100,7 @@ public final String getId() {
    * @param value Value of attribute
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   public final T setId(String value) {
     setAttribute(ATTRIBUTE_ID, value);
     return (T)this;
@@ -118,6 +120,7 @@ public final String getCssClass() {
    * @param value Value of attribute
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   public final T setCssClass(String value) {
     setAttribute(ATTRIBUTE_CLASS, value);
     return (T)this;
@@ -128,6 +131,7 @@ public final T setCssClass(String value) {
    * @param value Value of attribute
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   public final T addCssClass(String value) {
     if (StringUtils.isNotEmpty(value)) {
       return setCssClass(StringUtils.isNotEmpty(getCssClass()) ? getCssClass() + " " + value : value);
@@ -181,6 +185,7 @@ public final String getStyle(String styleAttribute) {
    * @param value Value of attribute with style key/value pairs
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   public final T setStyleString(String value) {
     setAttribute(ATTRIBUTE_STYLE, value);
     return (T)this;
@@ -192,6 +197,7 @@ public final T setStyleString(String value) {
    * @param styleValue Style attribute value
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   public final T setStyle(String styleAttribute, String styleValue) {
 
     // Add style to style map
@@ -223,6 +229,7 @@ public final String getTitle() {
    * @param value Value of attribute
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   public final T setTitle(String value) {
     setAttribute(ATTRIBUTE_TITLE, value);
     return (T)this;
@@ -243,6 +250,7 @@ public final String getData(String attributeName) {
    * @param value Value of attribute
    * @return Self reference
    */
+  @SuppressWarnings("unchecked")
   public final T setData(String attributeName, String value) {
     setAttribute(ATTRIBUTE_DATA_PREFIX + attributeName, value);
     return (T)this;

diff --git a/src/main/java/io/wcm/handler/commons/dom/Image.java b/src/main/java/io/wcm/handler/commons/dom/Image.java
@@ -25,6 +25,7 @@
  * Html image (img) element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Image extends HtmlElement<Image> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Map.java b/src/main/java/io/wcm/handler/commons/dom/Map.java
@@ -25,6 +25,7 @@
  * Html map element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Map extends AbstractNonSelfClosingHtmlElement<Map> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/NoScript.java b/src/main/java/io/wcm/handler/commons/dom/NoScript.java
@@ -25,6 +25,7 @@
  * Html noscript element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class NoScript extends AbstractNonSelfClosingHtmlElement<NoScript> {
 
   private static final long serialVersionUID = 1L;

diff --git a/src/main/java/io/wcm/handler/commons/dom/Picture.java b/src/main/java/io/wcm/handler/commons/dom/Picture.java
@@ -25,6 +25,7 @@
  * Html picture element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Picture extends AbstractNonSelfClosingHtmlElement<Picture> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Script.java b/src/main/java/io/wcm/handler/commons/dom/Script.java
@@ -41,6 +41,7 @@
  * </pre>
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Script extends AbstractNonSelfClosingHtmlElement<Script> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Source.java b/src/main/java/io/wcm/handler/commons/dom/Source.java
@@ -25,6 +25,7 @@
  * Html source (source) element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public class Source extends HtmlElement<Source> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Span.java b/src/main/java/io/wcm/handler/commons/dom/Span.java
@@ -25,6 +25,7 @@
  * Html span element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Span extends AbstractNonSelfClosingHtmlElement<Span> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/dom/Video.java b/src/main/java/io/wcm/handler/commons/dom/Video.java
@@ -25,6 +25,7 @@
  * Html video (video) element.
  */
 @ProviderType
+@SuppressWarnings("java:S110") // # parent inheritance
 public final class Video extends AbstractNonSelfClosingHtmlElement<Video> {
   private static final long serialVersionUID = 1L;
 

diff --git a/src/main/java/io/wcm/handler/commons/servlets/impl/HtxPageExtensionMapper.java b/src/main/java/io/wcm/handler/commons/servlets/impl/HtxPageExtensionMapper.java
@@ -111,7 +111,8 @@ protected void doGet(@NotNull SlingHttpServletRequest request, @NotNull SlingHtt
       requestDispatcher.include(request, response);
     }
     else {
-      log.error("Unable to dispatch proxy request for {} referrer={}", request.getRequestURI(), request.getHeader("Referrer"));
+      String referrer = request.getHeader("Referrer");
+      log.error("Unable to dispatch proxy request for {} referrer={}", request.getRequestURI(), referrer);
       throw new ServletException("No Content");
     }
 

diff --git a/src/test/java/io/wcm/handler/commons/dom/HtmlElementTest.java b/src/test/java/io/wcm/handler/commons/dom/HtmlElementTest.java
@@ -19,6 +19,7 @@
  */
 package io.wcm.handler.commons.dom;
 
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -58,22 +59,24 @@ void testAttributeValueAsInteger() {
 
   @Test
   void testAddContent() {
-    underTest.addContent(Set.of(new Image(), new Div()));
-    underTest.addContent((Collection)null);
+    assertDoesNotThrow(() -> {
+      underTest.addContent(Set.of(new Image(), new Div()));
+      underTest.addContent((Collection)null);
 
-    underTest.addContent(new Image());
-    underTest.addContent((Content)null);
+      underTest.addContent(new Image());
+      underTest.addContent((Content)null);
 
-    underTest.addContent("text");
-    underTest.addContent((String)null);
+      underTest.addContent("text");
+      underTest.addContent((String)null);
 
-    underTest.addContent(0, Set.of(new Image(), new Div()));
-    underTest.addContent(0, (Collection)null);
+      underTest.addContent(0, Set.of(new Image(), new Div()));
+      underTest.addContent(0, (Collection)null);
 
-    underTest.addContent(0, new Image());
-    underTest.addContent(0, (Content)null);
+      underTest.addContent(0, new Image());
+      underTest.addContent(0, (Content)null);
 
-    underTest.add(new Image());
+      underTest.add(new Image());
+    });
   }
 
   @Test
@@ -87,11 +90,13 @@ void testText() {
 
   @Test
   void testSetAttribute() {
-    underTest.setAttribute("attr1", "value1");
-    underTest.setAttribute("attr1", null);
+    assertDoesNotThrow(() -> {
+      underTest.setAttribute("attr1", "value1");
+      underTest.setAttribute("attr1", null);
 
-    underTest.setAttribute("attr1", "value1", NS_TEST);
-    underTest.setAttribute("attr1", null, NS_TEST);
+      underTest.setAttribute("attr1", "value1", NS_TEST);
+      underTest.setAttribute("attr1", null, NS_TEST);
+    });
   }
 
   @Test
@@ -152,27 +157,29 @@ void testToString() {
 
   @Test
   void testFactory() {
-    underTest.create("sub1");
-    underTest.createComment("text");
-    underTest.createDiv();
-    underTest.createSpan();
-    underTest.createSpan("text");
-    underTest.createAnchor();
-    underTest.createAnchor("href");
-    underTest.createAnchor("href", "target");
-    underTest.createImage();
-    underTest.createImage("src");
-    underTest.createImage("src", "alt");
-    underTest.createImage("src", 20, 30);
-    underTest.createImage("src", "alt", 20, 30);
-    underTest.createScript();
-    underTest.createScript("text");
-    underTest.createNoScript();
-    underTest.createFigure();
-    underTest.createFigCaption();
-    underTest.createVideo();
-    underTest.createAudio();
-    underTest.createSource();
+    assertDoesNotThrow(() -> {
+      underTest.create("sub1");
+      underTest.createComment("text");
+      underTest.createDiv();
+      underTest.createSpan();
+      underTest.createSpan("text");
+      underTest.createAnchor();
+      underTest.createAnchor("href");
+      underTest.createAnchor("href", "target");
+      underTest.createImage();
+      underTest.createImage("src");
+      underTest.createImage("src", "alt");
+      underTest.createImage("src", 20, 30);
+      underTest.createImage("src", "alt", 20, 30);
+      underTest.createScript();
+      underTest.createScript("text");
+      underTest.createNoScript();
+      underTest.createFigure();
+      underTest.createFigCaption();
+      underTest.createVideo();
+      underTest.createAudio();
+      underTest.createSource();
+    });
   }
 
 }