Merge pull request #492 from jenkinsci/coding-style-1.3.0

Bump versions of coding style to 1.3.0, and parent pom to 1.3.1
jenkinsci · Aug 23, 2020 · e1b241e · e1b241e
2 parents 6a76b56 + 27a79ca
commit e1b241e
Show file tree

Hide file tree

Showing 37 changed files with 267 additions and 263 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Static Analysis Model and Parsers Library
 
 [![Join the chat at https://gitter.im/jenkinsci/warnings-plugin](https://badges.gitter.im/jenkinsci/warnings-plugin.svg)](https://gitter.im/jenkinsci/warnings-plugin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Jenkins Plugin](https://img.shields.io/github/release/jenkinsci/analysis-model.svg?label=changelog)](https://github.com/jenkinsci/analysis-model/releases/latest)
+[![ChangeLog](https://img.shields.io/github/release/jenkinsci/analysis-model.svg?label=changelog)](https://github.com/jenkinsci/analysis-model/releases/latest)
 [![Jenkins](https://ci.jenkins.io/job/Plugins/job/analysis-model/job/master/badge/icon?subject=Jenkins%20CI)](https://ci.jenkins.io/job/Plugins/job/analysis-model/job/master/)
 [![CI on all platforms](https://github.com/jenkinsci/analysis-model/workflows/GitHub%20CI/badge.svg?branch=master)](https://github.com/jenkinsci/analysis-model/actions)
 [![Codacy](https://api.codacy.com/project/badge/Grade/1b96405c72db49eeb0d67486f77f8f75)](https://app.codacy.com/app/uhafner/analysis-model?utm_source=github.com&utm_medium=referral&utm_content=jenkinsci/analysis-model&utm_campaign=Badge_Grade_Dashboard)

diff --git a/codacy/checkstyle.xml b/codacy/checkstyle.xml
@@ -3,6 +3,7 @@
     Checkstyle-Configuration: Ullrich Hafner
     Description: Ullrich Hafner's Checkstyle Rules.
 -->
+<!-- ${project.groupId}:${project.artifactId}:${project.version} -->
 <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
         "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
 <module name="Checker">
@@ -26,25 +27,21 @@
     <module name="PackageAnnotation"/>
     <module name="EqualsAvoidNull"/>
     <module name="GenericWhitespace"/>
+    <module name="JavadocStyle">
+      <property name="severity" value="warning"/>
+      <property name="checkEmptyJavadoc" value="true"/>
+    </module>
     <module name="JavadocType"/>
-    <module name="JavadocMethod">
+    <module name="JavadocMethod"/>
+    <module name="JavadocVariable">
       <property name="scope" value="protected"/>
+      <property name="tokens" value="VARIABLE_DEF"/>
     </module>
     <module name="MissingJavadocMethodCheck">
       <property name="allowMissingPropertyJavadoc" value="true"/>
     </module>
     <module name="MissingJavadocTypeCheck"/>
     <module name="MissingJavadocPackageCheck"/>
-    <module name="JavadocVariable">
-      <property name="scope" value="protected"/>
-      <property name="tokens" value="VARIABLE_DEF"/>
-    </module>
-    <module name="JavadocStyle">
-      <property name="severity" value="warning"/>
-    </module>
-    <module name="JavadocStyle">
-      <property name="checkEmptyJavadoc" value="true"/>
-    </module>
     <module name="ConstantName"/>
     <module name="LocalFinalVariableName"/>
     <module name="LocalVariableName"/>
@@ -122,7 +119,6 @@
     <module name="SuperClone"/>
     <module name="SuperFinalize"/>
     <module name="UnnecessaryParentheses"/>
-    <module name="FinalClass"/>
     <module name="HideUtilityClassConstructor"/>
     <module name="InterfaceIsType"/>
     <module name="MutableException"/>
@@ -143,7 +139,7 @@
     <module name="IllegalCatch"/>
     <module name="IllegalImport">
       <property name="illegalPkgs" value="net.jcip.annotations, javax.annotation"/>
-      <property name="illegalClasses" value="edu.umd.cs.findbugs.annotations.CheckForNull"/>
+      <property name="illegalClasses" value="edu.umd.cs.findbugs.annotations.Nullable"/>
       <property name="severity" value="error"/>
     </module>
   </module>

diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
   <parent>
     <groupId>edu.hm.hafner</groupId>
     <artifactId>codingstyle-pom</artifactId>
-    <version>1.1.1</version>
+    <version>1.3.1</version>
     <relativePath />
   </parent>
 
@@ -54,7 +54,7 @@
 
   <properties>
     <scmTag>HEAD</scmTag>
-    <revision>8.2.2</revision>
+    <revision>8.3.0</revision>
     <changelist>-SNAPSHOT</changelist>
     <source.encoding>UTF-8</source.encoding>
     <project.build.sourceEncoding>${source.encoding}</project.build.sourceEncoding>
@@ -65,7 +65,7 @@
     <incrementals.url>https://repo.jenkins-ci.org/incrementals/</incrementals.url>
 
     <!-- Project Dependencies Configuration -->
-    <codingstyle.library.version>1.1.0</codingstyle.library.version>
+    <codingstyle.library.version>1.3.0</codingstyle.library.version>
     <jmh.version>1.25</jmh.version>
     <commons.lang.version>3.11</commons.lang.version>
     <commons.io.version>2.7</commons.io.version>
@@ -286,6 +286,16 @@
                 <classQualifiedName>se.bjurr.violations.lib.reports.Parser</classQualifiedName>
                 <justification>Nobody should rely on these constants.</justification>
               </item>
+              <item>
+                <code>java.annotation.removed</code>
+                <annotation>@edu.umd.cs.findbugs.annotations.Nullable</annotation>
+                <justification>Annotation should be save to change.</justification>
+              </item>
+              <item>
+                <code>java.annotation.added</code>
+                <annotation>@edu.umd.cs.findbugs.annotations.CheckForNull</annotation>
+                <justification>Annotation should be save to change.</justification>
+              </item>
             </revapi.ignore>
           </analysisConfiguration>
         </configuration>
@@ -512,4 +522,4 @@
     </snapshotRepository>
   </distributionManagement>
 
-</project>
+</project>
diff --git a/src/main/java/edu/hm/hafner/analysis/Categories.java b/src/main/java/edu/hm/hafner/analysis/Categories.java
@@ -2,7 +2,7 @@
 
 import org.apache.commons.lang3.StringUtils;
 
-import edu.umd.cs.findbugs.annotations.Nullable;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 
 /**
  * Provides convenience methods to detect categories. 
@@ -27,7 +27,7 @@ public final class Categories {
      *
      * @return warning category, empty string if unknown
      */
-    public static String guessCategory(@Nullable final String message) {
+    public static String guessCategory(@CheckForNull final String message) {
         if (StringUtils.contains(message, "proprietary")) {
             return PROPRIETARY_API;
         }
@@ -48,7 +48,7 @@ public static String guessCategory(@Nullable final String message) {
      *
      * @return the actual category
      */
-    public static String guessCategoryIfEmpty(@Nullable final String category, @Nullable final String message) {
+    public static String guessCategoryIfEmpty(@CheckForNull final String category, @CheckForNull final String message) {
         String capitalized = StringUtils.capitalize(category);
         if (StringUtils.isEmpty(capitalized)) {
             capitalized = guessCategory(message);

diff --git a/src/main/java/edu/hm/hafner/analysis/DuplicationGroup.java b/src/main/java/edu/hm/hafner/analysis/DuplicationGroup.java
@@ -6,7 +6,7 @@
 
 import org.apache.commons.lang3.StringUtils;
 
-import edu.umd.cs.findbugs.annotations.Nullable;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 
 /**
  * Links all affected files of a duplicated code fragment. A code duplication could be reported by a code duplication
@@ -24,7 +24,7 @@ public final class DuplicationGroup implements Serializable {
      * @param codeFragment
      *         the copied code fragment
      */
-    public DuplicationGroup(@Nullable final String codeFragment) {
+    public DuplicationGroup(@CheckForNull final String codeFragment) {
         setCodeFragment(codeFragment);
     }
 
@@ -43,7 +43,7 @@ public DuplicationGroup() {
      *         the copied code fragment
      */
     @SuppressWarnings("InstanceVariableUsedBeforeInitialized")
-    public void setCodeFragment(@Nullable final String codeFragment) {
+    public void setCodeFragment(@CheckForNull final String codeFragment) {
         if (StringUtils.isBlank(this.codeFragment)) {
             this.codeFragment = StringUtils.defaultString(codeFragment);
         }

diff --git a/src/main/java/edu/hm/hafner/analysis/FileReaderFactory.java b/src/main/java/edu/hm/hafner/analysis/FileReaderFactory.java
@@ -17,7 +17,7 @@
 
 import com.google.errorprone.annotations.MustBeClosed;
 
-import edu.umd.cs.findbugs.annotations.Nullable;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 
 /**
  * Provides a {@link ReaderFactory} that returns readers for a given file.
@@ -27,7 +27,7 @@
 public class FileReaderFactory extends ReaderFactory {
     private final Path file;
     private final String fileName;
-    @Nullable
+    @CheckForNull
     private Charset charset;
     private final boolean isCharsetUndetected;
 
@@ -39,7 +39,7 @@ public class FileReaderFactory extends ReaderFactory {
      * @param charset
      *         the charset to use when reading the file (or {@code null} if the charset should be detected)
      */
-    public FileReaderFactory(final Path file, final @Nullable Charset charset) {
+    public FileReaderFactory(final Path file, final @CheckForNull Charset charset) {
         super(StandardCharsets.UTF_8);
 
         this.file = file;
@@ -76,7 +76,7 @@ public Reader create() {
         }
     }
 
-    @Nullable
+    @CheckForNull
     private Charset detectCharset(final InputStream inputStream) throws IOException {
         try (Reader reader = new InputStreamReader(inputStream, StandardCharsets.US_ASCII)) {
             XMLStreamReader xmlStreamReader = new SecureXmlParserFactory().createXmlStreamReader(reader);

diff --git a/src/main/java/edu/hm/hafner/analysis/Issue.java b/src/main/java/edu/hm/hafner/analysis/Issue.java
@@ -13,7 +13,7 @@
 import edu.hm.hafner.util.Ensure;
 import edu.hm.hafner.util.PathUtil;
 import edu.hm.hafner.util.TreeString;
-import edu.umd.cs.findbugs.annotations.Nullable;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
 /**
@@ -171,7 +171,7 @@ public static Predicate<Issue> byType(final String type) {
 
     private final UUID id;                  // fixed
 
-    @Nullable
+    @CheckForNull
     private final Serializable additionalProperties;  // fixed
 
     private String reference;       // mutable, not part of equals
@@ -248,13 +248,13 @@ public static Predicate<Issue> byType(final String type) {
     @SuppressWarnings("ParameterNumber")
     Issue(final String pathName, final TreeString fileName,
             final int lineStart, final int lineEnd, final int columnStart, final int columnEnd,
-            @Nullable final Iterable<? extends LineRange> lineRanges,
-            @Nullable final String category, @Nullable final String type,
-            final TreeString packageName, @Nullable final String moduleName,
-            @Nullable final Severity severity,
+            @CheckForNull final Iterable<? extends LineRange> lineRanges,
+            @CheckForNull final String category, @CheckForNull final String type,
+            final TreeString packageName, @CheckForNull final String moduleName,
+            @CheckForNull final Severity severity,
             final TreeString message, final String description,
-            @Nullable final String origin, @Nullable final String reference,
-            @Nullable final String fingerprint, @Nullable final Serializable additionalProperties) {
+            @CheckForNull final String origin, @CheckForNull final String reference,
+            @CheckForNull final String fingerprint, @CheckForNull final Serializable additionalProperties) {
         this(pathName, fileName, lineStart, lineEnd, columnStart, columnEnd, lineRanges, category, type, packageName,
                 moduleName,
                 severity, message, description, origin, reference, fingerprint, additionalProperties,
@@ -304,15 +304,15 @@ public static Predicate<Issue> byType(final String type) {
      *         the ID of this issue
      */
     @SuppressWarnings("ParameterNumber")
-    Issue(@Nullable final String pathName, final TreeString fileName, final int lineStart, final int lineEnd,
+    Issue(@CheckForNull final String pathName, final TreeString fileName, final int lineStart, final int lineEnd,
             final int columnStart,
-            final int columnEnd, @Nullable final Iterable<? extends LineRange> lineRanges,
-            @Nullable final String category,
-            @Nullable final String type, final TreeString packageName,
-            @Nullable final String moduleName, @Nullable final Severity severity,
+            final int columnEnd, @CheckForNull final Iterable<? extends LineRange> lineRanges,
+            @CheckForNull final String category,
+            @CheckForNull final String type, final TreeString packageName,
+            @CheckForNull final String moduleName, @CheckForNull final Severity severity,
             final TreeString message, final String description,
-            @Nullable final String origin, @Nullable final String reference,
-            @Nullable final String fingerprint, @Nullable final Serializable additionalProperties,
+            @CheckForNull final String origin, @CheckForNull final String reference,
+            @CheckForNull final String fingerprint, @CheckForNull final Serializable additionalProperties,
             final UUID id) {
 
         this.pathName = normalizeFileName(pathName);
@@ -390,7 +390,7 @@ protected Object readResolve() {
         return this;
     }
 
-    private String normalizeFileName(@Nullable final String platformFileName) {
+    private String normalizeFileName(@CheckForNull final String platformFileName) {
         if (platformFileName == null || UNDEFINED.equals(platformFileName) || StringUtils.isBlank(platformFileName)) {
             return UNDEFINED;
         }
@@ -417,7 +417,7 @@ private int defaultInteger(final int integer) {
      *
      * @return the valid string or a default string if the specified string is not valid
      */
-    private String defaultString(@Nullable final String string) {
+    private String defaultString(@CheckForNull final String string) {
         return StringUtils.defaultIfEmpty(string, UNDEFINED).intern();
     }
 
@@ -429,7 +429,7 @@ private String defaultString(@Nullable final String string) {
      *
      * @return the stripped string or the empty string if the specified string is {@code null}
      */
-    private String stripToEmpty(@Nullable final String string) {
+    private String stripToEmpty(@CheckForNull final String string) {
         return StringUtils.stripToEmpty(string).intern();
     }
 
@@ -704,7 +704,7 @@ public String getModuleName() {
      * @param moduleName
      *         the module name to set
      */
-    void setModuleName(@Nullable final String moduleName) {
+    void setModuleName(@CheckForNull final String moduleName) {
         this.moduleName = stripToEmpty(moduleName);
     }
 
@@ -754,7 +754,7 @@ public String getReference() {
      * @param reference
      *         the reference
      */
-    public void setReference(@Nullable final String reference) {
+    public void setReference(@CheckForNull final String reference) {
         this.reference = stripToEmpty(reference);
     }
 
@@ -781,7 +781,7 @@ public String getFingerprint() {
      *
      * @see #getFingerprint()
      */
-    void setFingerprint(@Nullable final String fingerprint) {
+    void setFingerprint(@CheckForNull final String fingerprint) {
         this.fingerprint = StringUtils.stripToEmpty(fingerprint);
     }
 
@@ -800,7 +800,7 @@ public boolean hasFingerprint() {
      *
      * @return the additional properties
      */
-    @Nullable
+    @CheckForNull
     public Serializable getAdditionalProperties() {
         return additionalProperties;
     }