DiffData cleanup (#3823)

* adjust javadoc

* local variable is not needed

* move DiffData and DiffType to org.opengrok.web

this allows to reduce field visibility in DiffData

* introduce non-default constructor

* refactor

* adjust javadoc

* fix comment

* fix comments

* fix more Sonar issues

* fix nits

* remove revision

* fix style

* add basic diff tests

Author: Vladimir Kotal

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

@@ -348,7 +348,7 @@ private static boolean needsHtmlize(CharSequence q, boolean pre) {
      *
      * @param urlPrefix prefix to add to each url
      * @param path path to crack
-     * @return HTML markup fro the breadcrumb or the path itself.
+     * @return HTML markup for the breadcrumb or the path itself.
      *
      * @see #breadcrumbPath(String, String, char)
      */
@@ -905,9 +905,8 @@ public static void writeHAD(Writer out, String ctxE, String entry, boolean isDir
     /**
      * Wrapper around UTF-8 URL encoding of a string.
      *
-     * @param q query to be encoded. If {@code null}, an empty string will be
-     * used instead.
-     * @return null if fail, otherwise the encoded string
+     * @param q query to be encoded. If {@code null}, an empty string will be used instead.
+     * @return null if failed, otherwise the encoded string
      * @see URLEncoder#encode(String, String)
      */
     public static String URIEncode(String q) {

opengrok-indexer/src/main/java/org/opengrok/indexer/web/DiffData.java renamed to opengrok-web/src/main/java/org/opengrok/web/DiffData.java

@@ -19,43 +19,91 @@
 
 /*
  * Copyright (c) 2009, 2011, Jens Elkner.
- * Copyright (c) 2009, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2009, 2021, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
-package org.opengrok.indexer.web;
+package org.opengrok.web;
 
 import org.opengrok.indexer.analysis.AbstractAnalyzer;
 import org.suigeneris.jrcs.diff.Revision;
 
 /**
- * A simple container to store the data required to generated a view of diffs
+ * A simple container to store the data required to generate a view of diffs
  * for a certain versioned file.
  *
  * @author  Jens Elkner
- * @version $Revision$
  */
 public class DiffData {
-
     /** the directory which contains the given file wrt. to the source root directory. */
-    public String path;
+    private final String path;
     /** the HTML escaped filename used. */
-    public String filename;
+    private final String filename;
     /** the genre of the requested diff. */
-    public AbstractAnalyzer.Genre genre;
+    AbstractAnalyzer.Genre genre;
     /** the original and new revision container. */
-    public Revision revision;
-    /** the URI encoded parameter values of the request. {@code param[0]}
-     * belongs to {@code r1}, {@code param[1]} to {@code r2}. */
-    public String[] param;
+    Revision revision;
+    /**
+     * the URI encoded parameter values of the request. {@code param[0]}
+     * belongs to {@code r1}, {@code param[1]} to {@code r2}.
+     */
+    String[] param;
     /** the revision names extracted from {@link #param}. */
-    public String[] rev;
-    /** the content of the original and new file line-by-line corresponding
-     * with {@link #rev}. */
-    public String[][] file;
+    String[] rev;
+    /** the content of the original and new file line-by-line corresponding with {@link #rev}. */
+    String[][] file;
     /** error message to show, if diffs are not available. */
-    public String errorMsg;
+    String errorMsg;
     /** If {@code true} a full diff is desired. */
-    public boolean full;
+    boolean full;
     /** How should the data be displayed (request parameter {@code format}. */
-    public DiffType type;
+    DiffType type;
+
+    public DiffData(String path, String filename) {
+        this.path = path;
+        this.filename = filename;
+
+        this.rev = new String[2];
+        this.file = new String[2][];
+        this.param = new String[2];
+    }
+
+    public String getPath() {
+        return path;
+    }
+
+    public String getFilename() {
+        return filename;
+    }
+
+    public AbstractAnalyzer.Genre getGenre() {
+        return genre;
+    }
+
+    public Revision getRevision() {
+        return revision;
+    }
+
+    public String getParam(int index) {
+        return param[index];
+    }
+
+    public String getRev(int index) {
+        return rev[index];
+    }
+
+    public String[] getFile(int index) {
+        return file[index];
+    }
+
+    public String getErrorMsg() {
+        return errorMsg;
+    }
+
+    public boolean isFull() {
+        return full;
+    }
+
+    public DiffType getType() {
+        return type;
+    }
 }

opengrok-indexer/src/main/java/org/opengrok/indexer/web/DiffType.java renamed to opengrok-web/src/main/java/org/opengrok/web/DiffType.java

@@ -21,13 +21,12 @@
  * Copyright (c) 2009, 2011, Jens Elkner.
  * Copyright (c) 2009, 2019, Oracle and/or its affiliates. All rights reserved.
  */
-package org.opengrok.indexer.web;
+package org.opengrok.web;
 
 /**
  * Known diff display types.
  *
  * @author  Jens Elkner
- * @version $Revision$
  */
 public enum DiffType {