Class RwconfigExtension

java.lang.Object
net.rabbitware.config.gradle.RwconfigExtension
public abstract class RwconfigExtension extends Object
The rwconfig { } block. Every setting matches one of the Maven plugin's, and can also be given as a Gradle property with the same name - so -Prwconfig.skip=true works as -Drwconfig.skip=true does there.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RwconfigExtension()
    Created by Gradle, which supplies the abstract properties.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<Boolean>
    getFailOnError()
    Whether a finding of error severity fails the build.
    abstract org.gradle.api.file.RegularFileProperty
    getFile()
    Where the rwconfig file is.
    abstract org.gradle.api.provider.Property<Boolean>
    getReportUnread()
    Whether to report properties that are declared but never read.
    abstract org.gradle.api.provider.Property<Boolean>
    getSkip()
    Skip the check entirely.
    abstract org.gradle.api.provider.ListProperty<String>
    getSkipRules()
    Rules to ignore, by id - for example unread-property.

    Methods inherited from class Object

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

  • Constructor Details

    • RwconfigExtension

      public RwconfigExtension()
      Created by Gradle, which supplies the abstract properties.

  • Method Details

    • getFile

      public abstract org.gradle.api.file.RegularFileProperty getFile()
      Where the rwconfig file is. When unset, the usual places are searched: src/main/resources/rwconfig, then rwconfig in the project directory. A project with neither is not checked.
      Returns:
      the property

    • getFailOnError

      public abstract org.gradle.api.provider.Property<Boolean> getFailOnError()
      Whether a finding of error severity fails the build. Defaults to true.
      Returns:
      the property

    • getReportUnread

      public abstract org.gradle.api.provider.Property<Boolean> getReportUnread()
      Whether to report properties that are declared but never read. Defaults to true.
      Returns:
      the property

    • getSkipRules

      public abstract org.gradle.api.provider.ListProperty<String> getSkipRules()
      Rules to ignore, by id - for example unread-property.
      Returns:
      the property

    • getSkip

      public abstract org.gradle.api.provider.Property<Boolean> getSkip()
      Skip the check entirely. Defaults to false.
      Returns:
      the property