Kotlin idioms

src/main/kotlin/com/github/spotbugs/snom/Confidence.kt

@@ -13,7 +13,6 @@
  */
 package com.github.spotbugs.snom
 
-import java.util.Optional
 import org.gradle.api.tasks.Internal
 
 /**
@@ -22,21 +21,19 @@ import org.gradle.api.tasks.Internal
  *
  * ### Usage
  *
- * Set via the {@code spotbugs} extension to configure all tasks in your project:
+ * Set via the [SpotBugsExtension] to configure all tasks in your project:
  * ```kotlin
  * // require Gradle 8.2+
- * import com.github.spotbugs.snom.Confidence
  * spotbugs {
- *     reportLevel = Confidence.LOW
+ *     reportLevel = com.github.spotbugs.snom.Confidence.LOW
  * }
  * ```
  *
  * Or via [SpotBugsTask] to configure the specific task in your project:
  * ```kotlin
  * // require Gradle 8.2+
- * import com.github.spotbugs.snom.Confidence
  * spotbugsMain { // or name of another task
- *     reportLevel = Confidence.LOW
+ *     reportLevel = com.github.spotbugs.snom.Confidence.LOW
  * }
  * ```
  *
@@ -45,24 +42,25 @@ import org.gradle.api.tasks.Internal
 enum class Confidence {
     /** The report level to report all detected bugs in the report. */
     LOW {
-        override fun toCommandLineOption(): Optional<String> = Optional.of("-low")
+        override val commandLineOption: String = "-low"
     },
 
     /** The report level to report medium and high priority detected bugs in the report. */
     MEDIUM {
-        override fun toCommandLineOption(): Optional<String> = Optional.of("-medium")
+        override val commandLineOption: String = "-medium"
     },
 
-    /** The default level that provides the same feature with {@link #MEDIUM}. */
+    /** The default level that provides the same feature with [MEDIUM]. */
     DEFAULT {
-        override fun toCommandLineOption(): Optional<String> = Optional.empty()
+        override val commandLineOption: String? = null
     },
 
     /** The report level to report high priority detected bugs in the report. */
     HIGH {
-        override fun toCommandLineOption(): Optional<String> = Optional.of("-high")
-    }, ;
+        override val commandLineOption: String = "-high"
+    },
+    ;
 
-    @Internal("This is internally used property so no need to refer to judge out-of-date or not.")
-    abstract fun toCommandLineOption(): Optional<String>
+    @get:Internal("This is internally used property so no need to refer to judge out-of-date or not.")
+    internal abstract val commandLineOption: String?
 }

src/main/kotlin/com/github/spotbugs/snom/Effort.kt

@@ -22,18 +22,16 @@ package com.github.spotbugs.snom
  * Set via the `spotbugs` extension to configure all tasks in your project:
  * ```kotlin
  * // require Gradle 8.2+
- * import com.github.spotbugs.snom.Effort
  * spotbugs {
- *     effort = Effort.LESS
+ *     effort = com.github.spotbugs.snom.Effort.LESS
  * }
  * ```
  *
  * Or via [SpotBugsTask] to configure the specific task in your project:
  * ```kotlin
  * // require Gradle 8.2+
- * import com.github.spotbugs.snom.Effort
  * spotbugsMain { // or name of another task
- *     effort = Effort.MAX
+ *     effort = com.github.spotbugs.snom.Effort.MAX
  * }
  * ```
  *

src/main/kotlin/com/github/spotbugs/snom/SpotBugsBasePlugin.kt

@@ -140,14 +140,8 @@ class SpotBugsBasePlugin : Plugin<Project> {
     }
 
     fun verifyGradleVersion(version: GradleVersion) {
-        if (version < SUPPORTED_VERSION) {
-            val message =
-                String.format(
-                    "Gradle version %s is unsupported. Please use %s or later.",
-                    version,
-                    SUPPORTED_VERSION,
-                )
-            throw IllegalArgumentException(message)
+        check(version >= SUPPORTED_VERSION) {
+            "Gradle version $version is unsupported. Please use $SUPPORTED_VERSION or later."
         }
     }
 
@@ -167,6 +161,7 @@ class SpotBugsBasePlugin : Plugin<Project> {
          * Supported Gradle version described at [official manual site](http://spotbugs.readthedocs.io/en/latest/gradle.html).
          * The convention API provides replacement from 7.1 and later, so we use this value as minimal required version.
          */
+        @Suppress("MaxLineLength")
         private val SUPPORTED_VERSION = GradleVersion.version("7.1")
     }
 }

src/main/kotlin/com/github/spotbugs/snom/SpotBugsExtension.kt

@@ -19,8 +19,8 @@ import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Property
 
 /**
- * The extension to configure the SpotBugs Gradle plugin. Most of properties in this extension will be used as the default property of all {@link SpotBugsTask}.
- * All properties are optional.
+ * The extension to configure the SpotBugs Gradle plugin. Most of properties in this extension will be used as
+ * the default property of all [SpotBugsTask]. All properties are optional.
  *
  * ### Usage
  * After you apply the SpotBugs Gradle plugin to project, write extension like below:
@@ -89,7 +89,7 @@ interface SpotBugsExtension {
      * Property to set the filter file to limit which bug should be reported.
      *
      * Note that this property will NOT limit which bug should be detected. To limit the target classes to analyze,
-     * use [#onlyAnalyze] instead.
+     * use [onlyAnalyze] instead.
      * To limit the visitors (detectors) to run, use [visitors] and [omitVisitors] instead.
      *
      * See also [SpotBugs Manual about Filter file](https://spotbugs.readthedocs.io/en/stable/filter.html).
@@ -108,8 +108,8 @@ interface SpotBugsExtension {
     val excludeFilter: RegularFileProperty
 
     /**
-     * Property to set the baseline file. This file is a Spotbugs result file, and all bugs reported in this file will not be
-     * reported in the final output.
+     * Property to set the baseline file. This file is a Spotbugs result file, and all bugs reported in this file
+     * will not be reported in the final output.
      */
     val baselineFile: RegularFileProperty
 
@@ -119,7 +119,8 @@ interface SpotBugsExtension {
     val onlyAnalyze: ListProperty<String>
 
     /**
-     * Property to specify the name of project. Some reporting formats use this property. Default value is the name of your Gradle project.
+     * Property to specify the name of project. Some reporting formats use this property.
+     * Default value is the name of your Gradle project.
      */
     val projectName: Property<String>
 
@@ -136,7 +137,8 @@ interface SpotBugsExtension {
     val extraArgs: ListProperty<String>
 
     /**
-     * Property to specify the extra arguments for JVM process. Default value is empty so JVM process will get no extra argument.
+     * Property to specify the extra arguments for JVM process. Default value is empty so JVM process will get
+     * no extra argument.
      */
     val jvmArgs: ListProperty<String>
 

src/main/kotlin/com/github/spotbugs/snom/SpotBugsPlugin.kt

@@ -57,7 +57,7 @@ class SpotBugsPlugin : Plugin<Project> {
         /**
          * The configuration contains SpotBugs plugin jar files only
          *
-         * @see <a href="https://github.com/spotbugs/spotbugs-gradle-plugin/issues/910">GitHub issue</a>
+         * See [GitHub issue](https://github.com/spotbugs/spotbugs-gradle-plugin/issues/910)
          */
         const val PLUGINS_CONFIG_NAME = "spotbugsPlugins"
         const val SLF4J_CONFIG_NAME = "spotbugsSlf4j"

src/main/kotlin/com/github/spotbugs/snom/SpotBugsReport.kt

@@ -28,6 +28,7 @@ import org.gradle.api.resources.TextResource
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.Internal
 
+@Suppress("TooManyFunctions")
 abstract class SpotBugsReport @Inject constructor(
     objects: ObjectFactory,
     @get:Internal
@@ -44,7 +45,7 @@ abstract class SpotBugsReport @Inject constructor(
     abstract fun toCommandLineOption(): String
 
     @Internal
-    @Deprecated("use {@link #getOutputLocation()} instead.")
+    @Deprecated("use `getOutputLocation()` instead.")
     fun getDestination(): File {
         return destination.get().asFile
     }
@@ -63,26 +64,26 @@ abstract class SpotBugsReport @Inject constructor(
         return isRequired
     }
 
-    @get:Deprecated("use {@link #getRequired()} instead.")
+    @get:Deprecated("use `getRequired()` instead.")
     @get:Internal
-    @set:Deprecated("use {@code getRequired().set(value)} instead.")
+    @set:Deprecated("use `getRequired().set(value)` instead.")
     var isEnabled: Boolean
         get() = isRequired.get()
         set(b) {
             isRequired.set(b)
         }
 
-    @Deprecated("use {@code getRequired().set(provider)} instead.")
+    @Deprecated("use `getRequired().set(provider)` instead.")
     fun setEnabled(provider: Provider<Boolean>) {
         isRequired.set(provider)
     }
 
-    @Deprecated("use {@code getOutputLocation().set(file)} instead.")
+    @Deprecated("use `getOutputLocation().set(file)` instead.")
     override fun setDestination(file: File) {
         destination.set(file)
     }
 
-    @Deprecated("use {@code getOutputLocation().set(provider)} instead.")
+    @Deprecated("use `getOutputLocation().set(provider)` instead.")
     fun setDestination(provider: Provider<File?>) {
         destination.set(task.project.layout.file(provider))
     }
@@ -102,7 +103,7 @@ abstract class SpotBugsReport @Inject constructor(
 
     @Internal("This property provides only a human readable name.")
     override fun getDisplayName(): String {
-        return String.format("%s type report generated by the task %s", name, task.path)
+        return "$name type report generated by the task ${task.path}"
     }
 
     // TODO adding an @Input triggers 'cannot be serialized' exception
@@ -111,20 +112,10 @@ abstract class SpotBugsReport @Inject constructor(
     }
 
     override fun setStylesheet(textResource: TextResource?) {
-        throw UnsupportedOperationException(
-            String.format(
-                "stylesheet property is not available in the %s type report",
-                name,
-            ),
-        )
+        throw UnsupportedOperationException("stylesheet property is not available in the $name type report")
     }
 
     open fun setStylesheet(path: String?) {
-        throw UnsupportedOperationException(
-            String.format(
-                "stylesheet property is not available in the %s type report",
-                name,
-            ),
-        )
+        throw UnsupportedOperationException("stylesheet property is not available in the $name type report")
     }
 }