Package org.gradle.api.plugins.quality
Class Checkstyle
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.api.plugins.quality.AbstractCodeQualityTask
org.gradle.api.plugins.quality.Checkstyle
- All Implemented Interfaces:
- Comparable<Task>,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Reporting<CheckstyleReports>,- Task,- PatternFilterable,- VerificationTask,- Configurable<Task>
@CacheableTask
public abstract class Checkstyle
extends AbstractCodeQualityTask
implements Reporting<CheckstyleReports>
Runs Checkstyle against some source files.
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionThe class path containing the Checkstyle library to be used.The class path containing the compiled classes for the source files to be analyzed.The Checkstyle configuration to use.Path to other Checkstyle configuration files.The Checkstyle configuration file to use.The properties available for use in the configuration file.Enable the use of external DTD files in configuration files.intThe maximum number of errors that are tolerated before breaking the build or setting the failure property.intThe maximum number of warnings that are tolerated before breaking the build or setting the failure property.final CheckstyleReportsThe reports to be generated by this task.Returns the source for this task, after the include and exclude patterns have been applied.booleanWhether the build should break when the verifications performed by this task fail.booleanWhether rule violations are to be displayed on the console.Configures the reports to be generated by this task.reports(Action<? super CheckstyleReports> configureAction) Configures the reports to be generated by this task.voidrun()voidsetCheckstyleClasspath(FileCollection checkstyleClasspath) The class path containing the Checkstyle library to be used.voidsetClasspath(FileCollection classpath) The class path containing the compiled classes for the source files to be analyzed.voidsetConfig(TextResource config) The Checkstyle configuration to use.voidsetConfigFile(File configFile) The Checkstyle configuration file to use.voidsetConfigProperties(Map<String, Object> configProperties) The properties available for use in the configuration file.voidsetMaxErrors(int maxErrors) Set the maximum number of errors that are tolerated before breaking the build.voidsetMaxWarnings(int maxWarnings) Set the maximum number of warnings that are tolerated before breaking the build.voidsetShowViolations(boolean showViolations) Whether rule violations are to be displayed on the console.Methods inherited from class org.gradle.api.plugins.quality.AbstractCodeQualityTaskconfigureForkOptions, getIgnoreFailures, getIgnoreFailuresProperty, getJavaLauncher, getMaxHeapSize, getMinHeapSize, getObjectFactory, getToolchainService, getWorkerExecutor, setIgnoreFailuresMethods inherited from class org.gradle.api.tasks.SourceTaskexclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, sourceMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
Checkstylepublic Checkstyle()
 
- 
- 
Method Details- 
getConfigFileThe Checkstyle configuration file to use.
- 
setConfigFileThe Checkstyle configuration file to use.
- 
reportspublic CheckstyleReports reports(@DelegatesTo(value=CheckstyleReports.class,strategy=1) Closure closure) Configures the reports to be generated by this task. The contained reports can be configured by name and closures. Example:checkstyleTask { reports { html { destination "build/checkstyle.html" } } }- Specified by:
- reportsin interface- Reporting<CheckstyleReports>
- Parameters:
- closure- The configuration
- Returns:
- The reports container
 
- 
reportsConfigures the reports to be generated by this task. The contained reports can be configured by name and closures. Example:checkstyleTask { reports { html { destination "build/checkstyle.html" } } }- Specified by:
- reportsin interface- Reporting<CheckstyleReports>
- Parameters:
- configureAction- The configuration
- Returns:
- The reports container
- Since:
- 3.0
 
- 
runpublic void run()
- 
getSourceReturns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.The PathSensitivityfor the sources is configured to bePathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.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. - Overrides:
- getSourcein class- SourceTask
- Returns:
- The source.
 
- 
getCheckstyleClasspathThe class path containing the Checkstyle library to be used.
- 
setCheckstyleClasspathThe class path containing the Checkstyle library to be used.
- 
getClasspathThe class path containing the compiled classes for the source files to be analyzed.
- 
setClasspathThe class path containing the compiled classes for the source files to be analyzed.
- 
getConfigThe Checkstyle configuration to use. Replaces theconfigFileproperty.- Since:
- 2.2
 
- 
setConfigThe Checkstyle configuration to use. Replaces theconfigFileproperty.- Since:
- 2.2
 
- 
getConfigPropertiesThe properties available for use in the configuration file. These are substituted into the configuration file.
- 
setConfigPropertiesThe properties available for use in the configuration file. These are substituted into the configuration file.
- 
getConfigDirectoryPath to other Checkstyle configuration files.This path will be exposed as the variable config_locin Checkstyle's configuration files.- Returns:
- path to other Checkstyle configuration files
- Since:
- 6.0
 
- 
getReportsThe reports to be generated by this task.- Specified by:
- getReportsin interface- Reporting<CheckstyleReports>
- Returns:
- The report container
 
- 
getMaxErrorsThe maximum number of errors that are tolerated before breaking the build or setting the failure property.- Returns:
- the maximum number of errors allowed
- Since:
- 3.4
 
- 
setMaxErrorspublic void setMaxErrors(int maxErrors) Set the maximum number of errors that are tolerated before breaking the build.- Parameters:
- maxErrors- number of errors allowed
- Since:
- 3.4
 
- 
getMaxWarningsThe maximum number of warnings that are tolerated before breaking the build or setting the failure property.- Returns:
- the maximum number of warnings allowed
- Since:
- 3.4
 
- 
setMaxWarningspublic void setMaxWarnings(int maxWarnings) Set the maximum number of warnings that are tolerated before breaking the build.- Parameters:
- maxWarnings- number of warnings allowed
- Since:
- 3.4
 
- 
isShowViolationsWhether rule violations are to be displayed on the console.- Returns:
- true if violations should be displayed on console
 
- 
setShowViolationspublic void setShowViolations(boolean showViolations) Whether rule violations are to be displayed on the console.
- 
getEnableExternalDtdLoadEnable the use of external DTD files in configuration files. Disabled by default because this may be unsafe. See Checkstyle documentation for more details.- Returns:
- property to enable the use of external DTD files
- Since:
- 7.6
 
- 
isIgnoreFailuresWhether the build should break when the verifications performed by this task fail.- Returns:
- true if failures should be ignored
 
 
-