Add additional checkstyle checks (#2896)

Author: ahornace

dev/checkstyle/style.xml

@@ -12,22 +12,33 @@
     <module name="FileLength"/>
     <module name="FileTabCharacter"/>
     <module name="TreeWalker">
+        <module name="JavadocStyle"/>
         <module name="AvoidStarImport">
             <property name="allowStaticMemberImports" value="true"/>
         </module>
         <module name="RedundantImport"/>
         <module name="UnusedImports"/>
+        <module name="LineLength">
+            <property name="max" value="150"/>
+        </module>
         <module name="MethodLength">
             <property name="max" value="200"/>
         </module>
         <module name="AnonInnerLength">
             <property name="max" value="60"/>
         </module>
         <module name="ParameterNumber"/>
+        <module name="EmptyBlock"/>
+        <module name="LeftCurly"/>
         <module name="NeedBraces"/>
+        <module name="RightCurly"/>
         <module name="GenericWhitespace"/>
         <module name="MethodParamPad"/>
         <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="TypecastParenPad"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
         <module name="SuppressionCommentFilter">
             <property name="offCommentFormat" value="&lt;editor-fold defaultstate=&quot;collapsed&quot; desc=&quot;Generated Code&quot;&gt;"/>
             <property name="onCommentFormat" value="&lt;/editor-fold&gt;"/>
@@ -39,6 +50,8 @@
         <module name="SimplifyBooleanExpression"/>
         <module name="SimplifyBooleanReturn"/>
 
+        <module name="HideUtilityClassConstructor"/>
+
         <module name="ArrayTypeStyle"/>
         <module name="UpperEll"/>
     </module>

dev/checkstyle/suppressions.xml

@@ -40,4 +40,17 @@ Portions Copyright (c) 2018-2019, Chris Fraire <[email protected]>.
         |Context\.java|HistoryContext\.java|Suggester\.java" />
 
     <suppress checks="MethodLength" files="Indexer\.java" />
+
+    <suppress checks="JavadocStyle" files="MellonHeaderDecoder\.java|CustomSloppyPhraseScorer\.java|
+        |PhrasePositions\.java" />
+
+    <suppress checks="LineLength" files="CustomSloppyPhraseScorer\.java" />
+
+    <suppress checks="EmptyBlock" files="JFlexNonXref\.java|JavaClassAnalyzer\.java|JFlexXref\.java|Util\.java|
+        |ClearCaseRepository\.java" />
+
+    <suppress checks="WhitespaceAround" files="CustomPhraseQuery\.java|PhrasePositions\.java|
+        |CustomSloppyPhraseScorer\.java" />
+
+    <suppress checks="WhitespaceAfter" files="CustomSloppyPhraseScorer\.java|CustomPhraseQuery\.java" />
 </suppressions>

opengrok-indexer/src/main/java/org/opengrok/indexer/Info.java

@@ -53,7 +53,7 @@ public final class Info {
     }
 
     /**
-     * get major version
+     * Get major version.
      *
      * @return major version
      */
@@ -62,7 +62,7 @@ public static String getVersion() {
     }
 
     /**
-     * get full version (product vMajor revMinor)
+     * Get full version (product vMajor revMinor).
      *
      * @return full version
      */
@@ -71,7 +71,7 @@ public static String getFullVersion() {
     }
 
     /**
-     * get minor version
+     * Get minor version.
      *
      * @return minor version
      */
@@ -81,7 +81,7 @@ public static String getRevision() {
 
 
     /**
-     * get short minor version
+     * Get short minor version.
      *
      * @return short minor version
      */

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

@@ -34,11 +34,11 @@
 import org.opengrok.indexer.configuration.Project;
 
 /**
- * Created on September 21, 2005
  *
  * @author Chandan
  */
 public abstract class AbstractAnalyzer extends Analyzer {
+
     public static final Reader DUMMY_READER = new StringReader("");
     protected AnalyzerFactory factory;
     // you analyzer HAS to override this to get proper symbols in results
@@ -117,23 +117,23 @@ public abstract void analyze(Document doc, StreamSource src, Writer xrefOut)
      */
     public enum Genre {
         /**
-         * xrefed - line numbered context
+         * xrefed - line numbered context.
          */
         PLAIN("p"),
         /**
-         * xrefed - summarizer context
+         * xrefed - summarizer context.
          */
         XREFABLE("x"),
         /**
-         * not xrefed - no context - used by diff/list
+         * not xrefed - no context - used by diff/list.
          */
         IMAGE("i"),
         /**
-         * not xrefed - no context
+         * not xrefed - no context.
          */
         DATA("d"),
         /**
-         * not xrefed - summarizer context from original file
+         * not xrefed - summarizer context from original file.
          */
         HTML("h");
         private final String typeName;

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

@@ -146,7 +146,7 @@ public final AbstractAnalyzer.Genre getGenre() {
     }
 
     /**
-     * The user friendly name of this analyzer
+     * The user friendly name of this analyzer.
      *
      * @return a genre
      */

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

@@ -128,14 +128,13 @@ public class AnalyzerGuru {
 
     /**
      * The maximum number of characters (multi-byte if a BOM is identified) to
-     * read from the input stream to be used for magic string matching
+     * read from the input stream to be used for magic string matching.
      */
     private static final int OPENING_MAX_CHARS = 100;
 
     /**
      * Set to 16K -- though debugging shows it would do with only 8K+3
-     * (standard buffer for Java BufferedInputStream plus 3 bytes for largest
-     * UTF BOM) 
+     * (standard buffer for Java BufferedInputStream plus 3 bytes for largest UTF BOM).
      */
     private static final int MARK_READ_LIMIT = 1024 * 16;
 
@@ -181,7 +180,7 @@ public class AnalyzerGuru {
     private static int customizationHashCode;
 
     /**
-     * Descending string length comparator for magics
+     * Descending string length comparator for magics.
      */
     private static final Comparator<String> descStrlenComparator =
         new Comparator<String>() {
@@ -230,14 +229,14 @@ public class AnalyzerGuru {
 
     /**
      * Maps from {@link FileAnalyzer#getFileTypeName()} to
-     * {@link FileAnalyzerFactory}
+     * {@link FileAnalyzerFactory}.
      */
     private static final Map<String, AnalyzerFactory> FILETYPE_FACTORIES =
             new HashMap<>();
 
     /**
      * Maps from {@link FileAnalyzer#getFileTypeName()} to
-     * {@link FileAnalyzer#getVersionNo()}
+     * {@link FileAnalyzer#getVersionNo()}.
      */
     private static final Map<String, Long> ANALYZER_VERSIONS = new HashMap<>();
 
@@ -340,7 +339,7 @@ public static long getVersionNo() {
         final int ver32 = 20190211_00; // Edit comment above too!
         long ver = ver32;
         if (customizationHashCode != 0) {
-            ver |= (long)customizationHashCode << 32;
+            ver |= (long) customizationHashCode << 32;
         }
         return ver;
     }
@@ -611,7 +610,7 @@ public static String getContentType(InputStream in, String file) throws IOExcept
     }
 
     /**
-     * Write a browse-able version of the file
+     * Write a browse-able version of the file.
      *
      * @param factory The analyzer factory for this file type
      * @param in The input stream containing the data
@@ -674,7 +673,7 @@ public static void writeDumpedXref(String contextPath,
     }
 
     /**
-     * Get the genre of a file
+     * Get the genre of a file.
      *
      * @param file The file to inspect
      * @return The genre suitable to decide how to display the file
@@ -684,7 +683,7 @@ public static AbstractAnalyzer.Genre getGenre(String file) {
     }
 
     /**
-     * Get the genre of a bulk of data
+     * Get the genre of a bulk of data.
      *
      * @param in A stream containing the data
      * @return The genre suitable to decide how to display the file
@@ -695,7 +694,7 @@ public static AbstractAnalyzer.Genre getGenre(InputStream in) throws IOException
     }
 
     /**
-     * Get the genre for a named class (this is most likely an analyzer)
+     * Get the genre for a named class (this is most likely an analyzer).
      *
      * @param factory the analyzer factory to get the genre for
      * @return The genre of this class (null if not found)
@@ -767,9 +766,9 @@ public static Class<?> getFactoryClass(String simpleName) {
         // Build analysis package name list first time only
         if (analysisPkgNames.isEmpty()) {
             Package[] p = Package.getPackages();
-            for(Package pp : p){
+            for (Package pp : p) {
                 String pname = pp.getName();
-                if (pname.indexOf(".analysis.") != -1) {
+                if (pname.contains(".analysis.")) {
                     analysisPkgNames.add(pname);
                 }
             }
@@ -781,11 +780,11 @@ public static Class<?> getFactoryClass(String simpleName) {
         // all language parsers: 
         //      <language>Analyzer, <language>AnalyzerFactory
 
-        if (simpleName.indexOf("Analyzer") == -1) {
+        if (!simpleName.contains("Analyzer")) {
             simpleName += "Analyzer";
         }
 
-        if (simpleName.indexOf("Factory") == -1) {
+        if (!simpleName.contains("Factory")) {
             simpleName += "Factory";
         }
 
@@ -906,7 +905,7 @@ public static AnalyzerFactory find(String file) {
     }
 
     /**
-     * Finds a suitable analyzer class for the data in this stream
+     * Finds a suitable analyzer class for the data in this stream.
      *
      * @param in The stream containing the data to analyze
      * @return the analyzer factory to use
@@ -919,7 +918,7 @@ public static AnalyzerFactory find(InputStream in) throws IOException {
 
     /**
      * Finds a suitable analyzer class for the data in this stream
-     * corresponding to a file of the specified name
+     * corresponding to a file of the specified name.
      *
      * @param in The stream containing the data to analyze
      * @param file The file name to get the analyzer for
@@ -1101,7 +1100,7 @@ private static String readOpening(InputStream in, byte[] sig)
             if (++nRead > OPENING_MAX_CHARS) {
                 break;
             }
-            char c = (char)r;
+            char c = (char) r;
             boolean isWhitespace = Character.isWhitespace(c);
             if (!sawNonWhitespace) {
                 if (isWhitespace) {

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

@@ -33,6 +33,10 @@
  * Represents a utility class to show the user details of {@link AnalyzerGuru}.
  */
 public class AnalyzerGuruHelp {
+
+    private AnalyzerGuruHelp() {
+    }
+
     /**
      * Gets a reportable hunk of text that details
      * {@link AnalyzerGuru#getPrefixesMap()},