public abstract class CheckstyleExtension extends CodeQualityExtension
CheckstylePlugin
Constructor | Description |
---|---|
CheckstyleExtension(Project project) |
Modifier and Type | Method | Description |
---|---|---|
TextResource |
getConfig() |
The Checkstyle configuration to use.
|
DirectoryProperty |
getConfigDirectory() |
Path to other Checkstyle configuration files.
|
java.io.File |
getConfigFile() |
The Checkstyle configuration file to use.
|
java.util.Map<java.lang.String,java.lang.Object> |
getConfigProperties() |
The properties available for use in the configuration file.
|
Property<java.lang.Boolean> |
getEnableExternalDtdLoad() |
Enable the ability to use custom DTD files in config and load them from some location on all checkstyle tasks in this project.
|
int |
getMaxErrors() |
The maximum number of errors that are tolerated before breaking the build
or setting the failure property.
|
int |
getMaxWarnings() |
The maximum number of warnings that are tolerated before breaking the build
or setting the failure property.
|
boolean |
isShowViolations() |
Whether rule violations are to be displayed on the console.
|
void |
setConfig(TextResource config) |
The Checkstyle configuration to use.
|
void |
setConfigFile(java.io.File configFile) |
The Checkstyle configuration file to use.
|
void |
setConfigProperties(java.util.Map<java.lang.String,java.lang.Object> configProperties) |
The properties available for use in the configuration file.
|
void |
setMaxErrors(int maxErrors) |
Set the maximum number of errors that are tolerated before breaking the build.
|
void |
setMaxWarnings(int maxWarnings) |
Set the maximum number of warnings that are tolerated before breaking the build.
|
void |
setShowViolations(boolean showViolations) |
Whether rule violations are to be displayed on the console.
|
getReportsDir, getSourceSets, getToolVersion, isIgnoreFailures, setIgnoreFailures, setReportsDir, setSourceSets, setToolVersion
public CheckstyleExtension(Project project)
public java.io.File getConfigFile()
public void setConfigFile(java.io.File configFile)
public TextResource getConfig()
configFile
property.public void setConfig(TextResource config)
configFile
property.public java.util.Map<java.lang.String,java.lang.Object> getConfigProperties()
public void setConfigProperties(java.util.Map<java.lang.String,java.lang.Object> configProperties)
public DirectoryProperty getConfigDirectory()
$rootProject.projectDir/config/checkstyle
This path will be exposed as the variable config_loc
in Checkstyle's configuration files.
public int getMaxErrors()
0
.
Example: maxErrors = 42
public void setMaxErrors(int maxErrors)
maxErrors
- number of errors allowedpublic int getMaxWarnings()
Integer.MAX_VALUE
.
Example: maxWarnings = 1000
public void setMaxWarnings(int maxWarnings)
maxWarnings
- number of warnings allowedpublic boolean isShowViolations()
true
.
Example: showViolations = falsepublic void setShowViolations(boolean showViolations)
true
.
Example: showViolations = false@Incubating @Optional @Input public Property<java.lang.Boolean> getEnableExternalDtdLoad()