@CacheableTask public class Checkstyle extends SourceTask implements VerificationTask, Reporting<CheckstyleReports>
Task.NamersourceTASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor and Description |
|---|
Checkstyle() |
| Modifier and Type | Method and Description |
|---|---|
org.gradle.api.internal.project.IsolatedAntBuilder |
getAntBuilder() |
FileCollection |
getCheckstyleClasspath()
The class path containing the Checkstyle library to be used.
|
FileCollection |
getClasspath()
The class path containing the compiled classes for the source files to be analyzed.
|
TextResource |
getConfig()
The Checkstyle configuration to use.
|
File |
getConfigDir()
Path to other Checkstyle configuration files.
|
File |
getConfigFile()
The Checkstyle configuration file to use.
|
Map<String,Object> |
getConfigProperties()
The properties available for use in the configuration file.
|
boolean |
getIgnoreFailures()
Whether or not this task will ignore failures and continue running the build.
|
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.
|
ObjectFactory |
getObjectFactory()
Injects and returns an instance of
ObjectFactory. |
CheckstyleReports |
getReports()
The reports to be generated by this task.
|
FileTree |
getSource()
Returns the source for this task, after the include and exclude patterns have been applied.
|
boolean |
isIgnoreFailures()
Whether this task will ignore failures and continue running the build.
|
boolean |
isShowViolations()
Whether rule violations are to be displayed on the console.
|
CheckstyleReports |
reports(Action<? super CheckstyleReports> configureAction)
Configures the reports to be generated by this task.
|
CheckstyleReports |
reports(Closure closure)
Configures the reports to be generated by this task.
|
void |
run() |
void |
setCheckstyleClasspath(FileCollection checkstyleClasspath)
The class path containing the Checkstyle library to be used.
|
void |
setClasspath(FileCollection classpath)
The class path containing the compiled classes for the source files to be analyzed.
|
void |
setConfig(TextResource config)
The Checkstyle configuration to use.
|
void |
setConfigDir(Provider<File> configDir)
Path to other Checkstyle configuration files.
|
void |
setConfigFile(File configFile)
The Checkstyle configuration file to use.
|
void |
setConfigProperties(Map<String,Object> configProperties)
The properties available for use in the configuration file.
|
void |
setIgnoreFailures(boolean ignoreFailures)
Whether this task will ignore failures and continue running the build.
|
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.
|
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, sourceconventionMapping, conventionMapping, getConventionMappingnewInputDirectory, newInputFile, newOutputDirectory, newOutputFileaddValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toStringpublic void setConfigFile(File configFile)
@Incubating @Inject public ObjectFactory getObjectFactory()
ObjectFactory.@Inject public org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
public CheckstyleReports reports(@DelegatesTo(value=CheckstyleReports.class,strategy=1) Closure closure)
checkstyleTask {
reports {
html {
destination "build/codenarc.html"
}
}
}
reports in interface Reporting<CheckstyleReports>closure - The configurationpublic CheckstyleReports reports(Action<? super CheckstyleReports> configureAction)
checkstyleTask {
reports {
html {
destination "build/codenarc.html"
}
}
}
reports in interface Reporting<CheckstyleReports>configureAction - The configurationpublic void run()
@PathSensitive(value=RELATIVE) public FileTree getSource()
The sources for this task are relatively relocatable even though it produces output that includes absolute paths. This is a compromise made to ensure that results can be reused between different builds. The downside is that up-to-date results, or results loaded from cache can show different absolute paths than would be produced if the task was executed.
getSource in class SourceTask@Classpath public FileCollection getCheckstyleClasspath()
public void setCheckstyleClasspath(FileCollection checkstyleClasspath)
@Classpath public FileCollection getClasspath()
public void setClasspath(FileCollection classpath)
@Incubating public TextResource getConfig()
configFile property.@Incubating public void setConfig(TextResource config)
configFile property.@Input @Optional public Map<String,Object> getConfigProperties()
public void setConfigProperties(Map<String,Object> configProperties)
@Incubating @InputDirectory @PathSensitive(value=RELATIVE) @Optional public File getConfigDir()
This path will be exposed as the variable config_loc in Checkstyle's configuration files.
@Incubating public void setConfigDir(Provider<File> configDir)
This path will be exposed as the variable config_loc in Checkstyle's configuration files.
public final CheckstyleReports getReports()
getReports in interface Reporting<CheckstyleReports>public boolean getIgnoreFailures()
getIgnoreFailures in interface VerificationTaskpublic boolean isIgnoreFailures()
public void setIgnoreFailures(boolean ignoreFailures)
setIgnoreFailures in interface VerificationTaskignoreFailures - false to break the build on failure, true to ignore the failures. The default is false.@Input public int getMaxErrors()
public void setMaxErrors(int maxErrors)
maxErrors - number of errors allowed@Input public int getMaxWarnings()
public void setMaxWarnings(int maxWarnings)
maxWarnings - number of warnings allowed@Console public boolean isShowViolations()
public void setShowViolations(boolean showViolations)