io.spine.tools.gradle.compiler

Class ErrorProneChecksPlugin

java.lang.Object

io.spine.tools.gradle.SpinePlugin

io.spine.tools.gradle.compiler.ErrorProneChecksPlugin

All Implemented Interfaces:

io.spine.logging.Logging, org.gradle.api.Plugin<org.gradle.api.Project>

public final class ErrorProneChecksPlugin
extends io.spine.tools.gradle.SpinePlugin

A Gradle plugin which configures the project to run Spine-custom Error Prone checks during the compilation stage.

To work, this plugin requires the Error Prone plugin to be applied to the project.

The plugin adds a spine-errorprone-checks dependency to the project's annotationProcessor configuration. For the older Gradle versions (pre 4.6), where there is no such configuration, the plugin creates it.

Dependency has the same version as the project's spine-model-compiler plugin dependency.

Checks severity may be configured for all checks:

 

   modelCompiler {
      spineCheckSeverity = "OFF"
   }
 
 

or for the specific ones:

 

   spineErrorProneChecks {
      useValidatingBuilder = "ERROR"
   }
 
 

The latter overrides the former.

See Also:

ValidatingBuilder

Constructor Summary

Constructors

Constructor and Description
ErrorProneChecksPlugin()

Method Summary

Modifier and Type	Method and Description
void	apply(org.gradle.api.Project project) Applies the plugin to the given Project.
static java.lang.String	extensionName()

Methods inherited from class io.spine.tools.gradle.SpinePlugin

logMissingDescriptorSetFile, newTask, resolve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Constructor Detail

ErrorProneChecksPlugin

public ErrorProneChecksPlugin()

Method Detail

extensionName

public static java.lang.String extensionName()

apply

public void apply(org.gradle.api.Project project)

Applies the plugin to the given Project.

Parameters:

project - the project to apply the plugin to