Add ParameterName checkstyle check

Author: ahornace

dev/checkstyle/style.xml

@@ -35,6 +35,7 @@
         <module name="AnonInnerLength">
             <property name="max" value="60"/>
         </module>
+        <module name="ParameterName"/>
         <module name="ParameterNumber"/>
         <module name="EmptyBlock"/>
         <module name="LeftCurly"/>

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/Ctags.java

@@ -106,8 +106,8 @@ public void setTabSize(int tabSize) {
         this.tabSize = tabSize;
     }
 
-    public void setCTagsExtraOptionsFile(String CTagsExtraOptionsFile) {
-        this.CTagsExtraOptionsFile = CTagsExtraOptionsFile;
+    public void setCTagsExtraOptionsFile(String ctagsExtraOptionsFile) {
+        this.CTagsExtraOptionsFile = ctagsExtraOptionsFile;
     }
 
     public void setTimeout(long timeout) {

opengrok-indexer/src/main/java/org/opengrok/indexer/history/MercurialRepository.java

@@ -310,23 +310,21 @@ private HistoryRevResult getHistoryRev(BufferSink sink, String fullpath, String
      * of a file in historical revision.
      *
      * @param fullpath file path
-     * @param full_rev_to_find revision number (in the form of
+     * @param fullRevToFind revision number (in the form of
      * {rev}:{node|short})
      * @return original filename
      */
-    private String findOriginalName(String fullpath, String full_rev_to_find)
-            throws IOException {
+    private String findOriginalName(String fullpath, String fullRevToFind) throws IOException {
         Matcher matcher = LOG_COPIES_PATTERN.matcher("");
         String file = fullpath.substring(getDirectoryName().length() + 1);
         ArrayList<String> argv = new ArrayList<>();
         File directory = new File(getDirectoryName());
 
         // Extract {rev} from the full revision specification string.
-        String[] rev_array = full_rev_to_find.split(":");
-        String rev_to_find = rev_array[0];
-        if (rev_to_find.isEmpty()) {
-            LOGGER.log(Level.SEVERE,
-                    "Invalid revision string: {0}", full_rev_to_find);
+        String[] revArray = fullRevToFind.split(":");
+        String revToFind = revArray[0];
+        if (revToFind.isEmpty()) {
+            LOGGER.log(Level.SEVERE, "Invalid revision string: {0}", fullRevToFind);
             return null;
         }
 
@@ -369,7 +367,7 @@ private String findOriginalName(String fullpath, String full_rev_to_find)
                 String rev = matcher.group(1);
                 String content = matcher.group(2);
 
-                if (rev.equals(rev_to_find)) {
+                if (rev.equals(revToFind)) {
                     break;
                 }
 
@@ -396,7 +394,7 @@ private String findOriginalName(String fullpath, String full_rev_to_find)
         if (status != 0) {
             LOGGER.log(Level.WARNING,
                     "Failed to get original name in revision {2} for: \"{0}\" Exit code: {1}",
-                    new Object[]{fullpath, String.valueOf(status), full_rev_to_find});
+                    new Object[]{fullpath, String.valueOf(status), fullRevToFind});
             return null;
         }
 
@@ -494,8 +492,8 @@ public Annotation annotate(File file, String revision) throws IOException {
     }
 
     @Override
-    protected String getRevisionForAnnotate(String history_revision) {
-        String[] brev = history_revision.split(":");
+    protected String getRevisionForAnnotate(String historyRevision) {
+        String[] brev = historyRevision.split(":");
 
         return brev[0];
     }

opengrok-indexer/src/main/java/org/opengrok/indexer/history/RCSHistoryParser.java

@@ -45,7 +45,7 @@ class RCSHistoryParser {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(RCSHistoryParser.class);
 
-    private static File readCVSRoot(File root, File CVSdir, String name) throws IOException {
+    private static File readCVSRoot(File root, File cvsDir, String name) throws IOException {
         String cvsroot = readFirstLine(root);
 
         if (cvsroot == null) {
@@ -55,7 +55,7 @@ private static File readCVSRoot(File root, File CVSdir, String name) throws IOEx
             return null;
         }
 
-        File repository = new File(CVSdir, "Repository");
+        File repository = new File(cvsDir, "Repository");
         String repo = readFirstLine(repository);
         String dir = cvsroot + File.separatorChar + repo;
         String filename = name + ",v";

opengrok-indexer/src/main/java/org/opengrok/indexer/history/Repository.java

@@ -374,11 +374,11 @@ protected void buildTagList(File directory, CommandTimeoutType cmdType) {
     /**
      * Return revision for annotate view.
      *
-     * @param history_revision full revision
+     * @param historyRevision full revision
      * @return revision string suitable for matching into annotation
      */
-    protected String getRevisionForAnnotate(String history_revision) {
-        return history_revision;
+    protected String getRevisionForAnnotate(String historyRevision) {
+        return historyRevision;
     }
 
     protected void doCreateCache(HistoryCache cache, String sinceRevision, File directory) throws HistoryException {

opengrok-indexer/src/main/java/org/opengrok/indexer/util/Executor.java

@@ -113,11 +113,11 @@ public Executor(List<String> cmdList, File workingDirectory, int timeout) {
      * @param cmdList A list containing the command to execute
      * @param workingDirectory The directory the process should have as the
      *                         working directory
-     * @param UseTimeout terminate the process after default timeout or not
+     * @param useTimeout terminate the process after default timeout or not
      */
-    public Executor(List<String> cmdList, File workingDirectory, boolean UseTimeout) {
+    public Executor(List<String> cmdList, File workingDirectory, boolean useTimeout) {
         this(cmdList, workingDirectory);
-        if (!UseTimeout) {
+        if (!useTimeout) {
             this.timeout = 0;
         }
     }

opengrok-indexer/src/main/java/org/opengrok/indexer/util/StringUtils.java

@@ -84,21 +84,21 @@ public static boolean isPossiblyJavaClass(String s) {
 
     /**
      * Convert value in milliseconds to readable time.
-     * @param time_ms delta in milliseconds
+     * @param timeMs delta in milliseconds
      * @return human readable string
      */
-    public static String getReadableTime(long time_ms) {
+    public static String getReadableTime(long timeMs) {
         StringBuilder output = new StringBuilder();
-        long time_delta = time_ms;
-
-        int milliseconds = (int) (time_delta % 1000);
-        time_delta /= 1000;
-        int seconds = (int) (time_delta % 60);
-        time_delta /= 60;
-        int minutes = (int) (time_delta % 60);
-        time_delta /= 60;
-        int hours = (int) (time_delta % 24);
-        int days = (int) (time_delta / 24);
+        long timeDelta = timeMs;
+
+        int milliseconds = (int) (timeDelta % 1000);
+        timeDelta /= 1000;
+        int seconds = (int) (timeDelta % 60);
+        timeDelta /= 60;
+        int minutes = (int) (timeDelta % 60);
+        timeDelta /= 60;
+        int hours = (int) (timeDelta % 24);
+        int days = (int) (timeDelta / 24);
 
         if (days != 0) {
             output.append(days);

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

@@ -865,11 +865,10 @@ public static String fixPathIfWindows(String path) {
      * @param out writer for producing output
      * @param ctxE URI encoded prefix
      * @param entry file/directory name to write
-     * @param is_dir is directory
+     * @param isDir is directory
      * @throws IOException depends on the destination (<var>out</var>).
      */
-    public static void writeHAD(Writer out, String ctxE, String entry,
-            boolean is_dir) throws IOException {
+    public static void writeHAD(Writer out, String ctxE, String entry, boolean isDir) throws IOException {
 
         String downloadPrefixE = ctxE + Prefix.DOWNLOAD_P;
         String xrefPrefixE = ctxE + Prefix.XREF_P;
@@ -887,7 +886,7 @@ public static void writeHAD(Writer out, String ctxE, String entry,
             out.write("\" title=\"History\">H</a>");
         }
 
-        if (!is_dir) {
+        if (!isDir) {
             out.write(" <a href=\"");
             out.write(xrefPrefixE);
             out.write(entry);

plugins/src/main/java/opengrok/auth/plugin/util/RestfulClient.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
 package opengrok.auth.plugin.util;
@@ -45,17 +45,17 @@ private RestfulClient() {
 
     /**
      * Perform HTTP PUT request.
-     * @param URI URI
+     * @param uri URI
      * @param input JSON string contents
      * @return HTTP status or -1
      */
-    public static int postIt(String URI, String input) {
+    public static int postIt(String uri, String input) {
         try {
             Client client = ClientBuilder.newClient();
 
             LOGGER.log(Level.FINEST, "sending REST POST request to {0}: {1}",
-                    new Object[]{URI, input});
-            Response response = client.target(URI)
+                    new Object[]{uri, input});
+            Response response = client.target(uri)
                     .request(MediaType.APPLICATION_JSON)
                     .post(Entity.entity(input, MediaType.APPLICATION_JSON));
 

plugins/src/main/java/opengrok/auth/plugin/util/WebHook.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
  */
 package opengrok.auth.plugin.util;
 
@@ -36,13 +36,13 @@ public class WebHook implements Serializable {
     public WebHook() {
     }
 
-    WebHook(String URI, String content) {
-        this.URI = URI;
+    WebHook(String uri, String content) {
+        this.URI = uri;
         this.content = content;
     }
 
-    public void setURI(String URI) {
-        this.URI = URI;
+    public void setURI(String uri) {
+        this.URI = uri;
     }
     public String getURI() {
         return URI;