adress Sonar issues in Suggestion

Author: vladak

opengrok-indexer/src/main/java/org/opengrok/indexer/web/SearchHelper.java

@@ -542,7 +542,7 @@ public List<Suggestion> getSuggestions() {
         IndexReader ir = null;
         Term t;
         for (String proj : name) {
-            Suggestion s = new Suggestion(proj);
+            Suggestion suggestion = new Suggestion(proj);
             try {
                 if (!closeOnDestroy) {
                     SuperIndexSearcher searcher = RuntimeEnvironment.getInstance().getIndexSearcher(proj);
@@ -556,30 +556,28 @@ public List<Suggestion> getSuggestions() {
                         && !builder.getFreetext().isEmpty()) {
                     t = new Term(QueryBuilder.FULL, builder.getFreetext());
                     getSuggestion(t, ir, dummy);
-                    s.freetext = dummy.toArray(new String[0]);
+                    suggestion.setFreetext(dummy.toArray(new String[0]));
                     dummy.clear();
                 }
                 if (builder.getRefs() != null && !builder.getRefs().isEmpty()) {
                     t = new Term(QueryBuilder.REFS, builder.getRefs());
                     getSuggestion(t, ir, dummy);
-                    s.refs = dummy.toArray(new String[0]);
+                    suggestion.setRefs(dummy.toArray(new String[0]));
                     dummy.clear();
                 }
                 if (builder.getDefs() != null && !builder.getDefs().isEmpty()) {
                     t = new Term(QueryBuilder.DEFS, builder.getDefs());
                     getSuggestion(t, ir, dummy);
-                    s.defs = dummy.toArray(new String[0]);
+                    suggestion.setDefs(dummy.toArray(new String[0]));
                     dummy.clear();
                 }
                 //TODO suggest also for path and history?
-                if ((s.freetext != null && s.freetext.length > 0)
-                        || (s.defs != null && s.defs.length > 0)
-                        || (s.refs != null && s.refs.length > 0)) {
-                    res.add(s);
+                if (suggestion.isUsable()) {
+                    res.add(suggestion);
                 }
             } catch (IOException e) {
-                LOGGER.log(Level.WARNING, "Got exception while getting "
-                        + "spelling suggestions for project " + proj + ":", e);
+                LOGGER.log(Level.WARNING,
+                        String.format("Got exception while getting spelling suggestions for project %s:", proj), e);
             } finally {
                 if (ir != null && closeOnDestroy) {
                     try {

opengrok-indexer/src/main/java/org/opengrok/indexer/web/Suggestion.java

@@ -18,6 +18,7 @@
  */
 
 /*
+ * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2011, Jens Elkner.
  */
 package org.opengrok.indexer.web;
@@ -30,13 +31,13 @@
 public class Suggestion {
 
     /** index name. */
-    public String name;
+    private final String name;
     /** freetext search suggestions. */
-    public String[] freetext;
+    private String[] freetext;
     /** references search suggestions. */
-    public String[] refs;
+    private String[] refs;
     /** definitions search suggestions. */
-    public String[] defs;
+    private String[] defs;
 
     /**
      * Create a new suggestion.
@@ -45,4 +46,41 @@ public class Suggestion {
     public Suggestion(String name) {
         this.name = name;
     }
+
+    public String getName() {
+        return name;
+    }
+
+    public String[] getFreetext() {
+        return freetext;
+    }
+
+    public String[] getRefs() {
+        return refs;
+    }
+
+    public String[] getDefs() {
+        return defs;
+    }
+
+    public void setFreetext(String[] freetext) {
+        this.freetext = freetext;
+    }
+
+    public void setRefs(String[] refs) {
+        this.refs = refs;
+    }
+
+    public void setDefs(String[] defs) {
+        this.defs = defs;
+    }
+
+    /**
+     * @return true if at least one of the properties has some content, false otherwise
+     */
+    public boolean isUsable() {
+        return (freetext != null && freetext.length > 0)
+                || (defs != null && defs.length > 0)
+                || (refs != null && refs.length > 0);
+    }
 }

opengrok-web/src/main/webapp/search.jsp

@@ -169,23 +169,23 @@ include file="menu.jspf"
     } else if (searchHelper.hits.length == 0) {
         List<Suggestion> hints = searchHelper.getSuggestions();
         for (Suggestion hint : hints) {
-        %><p class="suggestions"><font color="#cc0000">Did you mean (for <%= hint.name %>)</font>:<%
-	  if (hint.freetext!=null) { 
-	    for (String word : hint.freetext) {
+        %><p class="suggestions"><font color="#cc0000">Did you mean (for <%= hint.getName() %>)</font>:<%
+	  if (hint.getFreetext() != null) {
+	    for (String word : hint.getFreetext()) {
             %> <a href="search?<%= QueryParameters.FULL_SEARCH_PARAM_EQ %>
 <%= Util.URIEncode(QueryParser.escape(word)) %>"><%=
                 Util.htmlize(word) %></a> &nbsp; <%
 	    }
 	  }
-	  if (hint.refs!=null)  {
-	    for (String word : hint.refs) {
+	  if (hint.getRefs() != null)  {
+	    for (String word : hint.getRefs()) {
             %> <a href="search?<%= QueryParameters.REFS_SEARCH_PARAM_EQ %>
 <%= Util.URIEncode(QueryParser.escape(word)) %>"><%=
                 Util.htmlize(word) %></a> &nbsp; <%
 	    }
 	  }
-	  if (hint.defs!=null) {
-	    for (String word : hint.defs) {
+	  if (hint.getDefs() != null) {
+	    for (String word : hint.getDefs()) {
             %> <a href="search?<%= QueryParameters.DEFS_SEARCH_PARAM_EQ %>
 <%= Util.URIEncode(QueryParser.escape(word)) %>"><%=
                 Util.htmlize(word) %></a> &nbsp; <%