Class Checkstyle

Method Details

• getConfigFile

  @Internal public File getConfigFile()

  The Checkstyle configuration file to use.

• setConfigFile

  public void setConfigFile(File configFile)

  The Checkstyle configuration file to use.

• getObjectFactory

  @Incubating @Inject public ObjectFactory getObjectFactory()

  Injects and returns an instance of ObjectFactory.

  Since:

  4.2

• getAntBuilder

  @Inject public org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()

• reports

  public 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/codenarc.html"
       }
     }
   }
   

  Specified by:

  reports in interface Reporting<CheckstyleReports>

  Parameters:

  closure - The configuration

  Returns:

  The reports container

• reports

  public CheckstyleReports reports(Action<? super CheckstyleReports> configureAction)

  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/codenarc.html"
       }
     }
   }
   

  Specified by:

  reports in interface Reporting<CheckstyleReports>

  Parameters:

  configureAction - The configuration

  Returns:

  The reports container

  Since:

  3.0

• run

  public void run()

• getSource

  @PathSensitive(RELATIVE) public FileTree getSource()

  Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

  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:

  getSource in class SourceTask

  Returns:

  The source.

• getCheckstyleClasspath

  @Classpath public FileCollection getCheckstyleClasspath()

  The class path containing the Checkstyle library to be used.

• setCheckstyleClasspath

  public void setCheckstyleClasspath(FileCollection checkstyleClasspath)

  The class path containing the Checkstyle library to be used.

• getClasspath

  @Classpath public FileCollection getClasspath()

  The class path containing the compiled classes for the source files to be analyzed.

• setClasspath

  public void setClasspath(FileCollection classpath)

  The class path containing the compiled classes for the source files to be analyzed.

• getConfig

  @Incubating public TextResource getConfig()

  The Checkstyle configuration to use. Replaces the configFile property.

  Since:

  2.2

• setConfig

  @Incubating public void setConfig(TextResource config)

  The Checkstyle configuration to use. Replaces the configFile property.

  Since:

  2.2

• getConfigProperties

  @Input @Optional public Map<String,Object> getConfigProperties()

  The properties available for use in the configuration file. These are substituted into the configuration file.

• setConfigProperties

  public void setConfigProperties(Map<String,Object> configProperties)

  The properties available for use in the configuration file. These are substituted into the configuration file.

• getConfigDir

  @Incubating @InputDirectory @PathSensitive(RELATIVE) @Optional public File getConfigDir()

  Path to other Checkstyle configuration files.

  This path will be exposed as the variable config_loc in Checkstyle's configuration files.

  Returns:

  path to other Checkstyle configuration files

  Since:

  4.0

• setConfigDir

  @Incubating public void setConfigDir(Provider<File> configDir)

  Path to other Checkstyle configuration files.

  This path will be exposed as the variable config_loc in Checkstyle's configuration files.

  Since:

  4.0

• getReports

  public final CheckstyleReports getReports()

  The reports to be generated by this task.

  Specified by:

  getReports in interface Reporting<CheckstyleReports>

  Returns:

  The report container

• getIgnoreFailures

  public boolean getIgnoreFailures()

  Whether or not this task will ignore failures and continue running the build.

  Specified by:

  getIgnoreFailures in interface VerificationTask

  Returns:

  true if failures should be ignored

• isIgnoreFailures

  public boolean isIgnoreFailures()

  Whether this task will ignore failures and continue running the build.

  Returns:

  true if failures should be ignored

• setIgnoreFailures

  public void setIgnoreFailures(boolean ignoreFailures)

  Whether this task will ignore failures and continue running the build.

  Specified by:

  setIgnoreFailures in interface VerificationTask

  Parameters:

  ignoreFailures - false to break the build on failure, true to ignore the failures. The default is false.

• getMaxErrors

  @Input public int getMaxErrors()

  The 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

• setMaxErrors

  public 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

• getMaxWarnings

  @Input public int getMaxWarnings()

  The 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

• setMaxWarnings

  public 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

• isShowViolations

  @Console public boolean isShowViolations()

  Whether rule violations are to be displayed on the console.

  Returns:

  true if violations should be displayed on console

• setShowViolations

  public void setShowViolations(boolean showViolations)

  Whether rule violations are to be displayed on the console.